Babylon.js API documentation|

PhysicsRaycastResult

Class PhysicsRaycastResult

Holds the data for the raycast result

see: https://doc.babylonjs.com/features/featuresDeepDive/physics/usingPhysicsEngine

Hierarchy

PhysicsRaycastResult

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new PhysicsRaycastResult(): PhysicsRaycastResult

Returns PhysicsRaycastResult

Properties

Optional body Search playground for body

body?: PhysicsBody

The Physics body that the ray hit

Optional bodyIndex Search playground for bodyIndex

bodyIndex?: number

The body Index in case the Physics body is using instances

Accessors

hasHit

get hasHit(): boolean

- Defined in .temp/docdirectory/doc.d.ts:90401
Gets if there was a hit

Returns boolean

hitDistance

get hitDistance(): number

- Defined in .temp/docdirectory/doc.d.ts:90405
Gets the distance from the hit

Returns number

hitNormalWorld

get hitNormalWorld(): Vector3

- Defined in .temp/docdirectory/doc.d.ts:90409
Gets the hit normal/direction in the world

Returns Vector3

hitPointWorld

get hitPointWorld(): Vector3

- Defined in .temp/docdirectory/doc.d.ts:90413
Gets the hit point in the world

Returns Vector3

rayFromWorld

get rayFromWorld(): Vector3

- Defined in .temp/docdirectory/doc.d.ts:90417
Gets the ray "start point" of the ray in the world

Returns Vector3

rayToWorld

get rayToWorld(): Vector3

- Defined in .temp/docdirectory/doc.d.ts:90421
Gets the ray "end point" of the ray in the world

Returns Vector3

triangleIndex

get triangleIndex(): number

- Defined in .temp/docdirectory/doc.d.ts:90422
Returns number

Methods

calculateHitDistance Search playground for calculateHitDistance

calculateHitDistance(): void

- Defined in .temp/docdirectory/doc.d.ts:90437
Calculates the distance manually

Returns void

reset Search playground for reset

reset(from?: Vector3, to?: Vector3): void

- Defined in .temp/docdirectory/doc.d.ts:90443
Resets all the values to default

Parameters
- Optional from: Vector3
  
  The from point on world space
- Optional to: Vector3
  
  The to point on world space
Returns void

setHitData Search playground for setHitData

setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ, triangleIndex?: number): void

- Defined in .temp/docdirectory/doc.d.ts:90428
Sets the hit data (normal & point in world space)

Parameters
- hitNormalWorld: IXYZ
  
  defines the normal in world space
- hitPointWorld: IXYZ
  
  defines the point in world space
- Optional triangleIndex: number
Returns void

setHitDistance Search playground for setHitDistance

setHitDistance(distance: number): void

- Defined in .temp/docdirectory/doc.d.ts:90433
Sets the distance from the start point to the hit point

Parameters
- distance: number
Returns void