Class Heightfield

A shape that is a heightfield.

Hierarchy

Shape
- Heightfield

Index

Constructors

constructor

new Heightfield(nrows: number, ncols: number, heights: Float32Array, scale: Vector, flags?: FIX_INTERNAL_EDGES): Heightfield
Creates a new heightfield shape.
Parameters
- nrows: number
  
  − The number of rows in the heights matrix.
- ncols: number
  
  The number of columns in the heights matrix.
- heights: Float32Array
  
  The heights of the heightfield along its local y axis, provided as a matrix stored in column-major order.
- scale: Vector
  
  The dimensions of the heightfield's local x,z plane.
- Optional flags: FIX_INTERNAL_EDGES
Returns Heightfield
Overrides Shape.constructor
- Defined in geometry/shape.d.ts:468

Properties

flags

flags: FIX_INTERNAL_EDGES

Flags applied to the heightfield.

heights

heights: Float32Array

The heights of the heightfield along its local y axis, provided as a matrix stored in column-major order.

ncols

ncols: number

The number of columns in the heights matrix.

nrows

nrows: number

The number of rows in the heights matrix.

scale

scale: Vector

The dimensions of the heightfield's local x,z plane.

`Readonly` type

type: HeightField = ShapeType.HeightField

Methods

castRay

castRay(ray: Ray, shapePos: Vector, shapeRot: Rotation, maxToi: number, solid: boolean): number
Parameters
- ray: Ray
- shapePos: Vector
- shapeRot: Rotation
- maxToi: number
- solid: boolean
Returns number
Inherited from Shape.castRay
- Defined in geometry/shape.d.ts:64

castRayAndGetNormal

castRayAndGetNormal(ray: Ray, shapePos: Vector, shapeRot: Rotation, maxToi: number, solid: boolean): RayIntersection
Parameters
- ray: Ray
- shapePos: Vector
- shapeRot: Rotation
- maxToi: number
- solid: boolean
Returns RayIntersection
Inherited from Shape.castRayAndGetNormal
- Defined in geometry/shape.d.ts:65

castShape

castShape(shapePos1: Vector, shapeRot1: Rotation, shapeVel1: Vector, shape2: Shape, shapePos2: Vector, shapeRot2: Rotation, shapeVel2: Vector, targetDistance: number, maxToi: number, stopAtPenetration: boolean): ShapeCastHit
Computes the time of impact between two moving shapes.

Returns
If the two moving shapes collider at some point along their trajectories, this returns the time at which the two shape collider as well as the contact information during the impact. Returns nullif the two shapes never collide along their paths.
Parameters
- shapePos1: Vector
  
  The initial position of this sahpe.
- shapeRot1: Rotation
  
  The rotation of this shape.
- shapeVel1: Vector
  
  The velocity of this shape.
- shape2: Shape
  
  The second moving shape.
- shapePos2: Vector
  
  The initial position of the second shape.
- shapeRot2: Rotation
  
  The rotation of the second shape.
- shapeVel2: Vector
  
  The velocity of the second shape.
- targetDistance: number
  
  − If the shape moves closer to this distance from a collider, a hit will be returned.
- maxToi: number
  
  The maximum time when the impact can happen.
- stopAtPenetration: boolean
  
  If set to false, the linear shape-cast won’t immediately stop if the shape is penetrating another shape at its starting point and its trajectory is such that it’s on a path to exist that penetration state.
Returns ShapeCastHit
Inherited from Shape.castShape
- Defined in geometry/shape.d.ts:37

contactShape

contactShape(shapePos1: Vector, shapeRot1: Rotation, shape2: Shape, shapePos2: Vector, shapeRot2: Rotation, prediction: number): ShapeContact
Computes one pair of contact points between two shapes.

Returns
null if the shapes are separated by a distance greater than prediction, otherwise contact details. The result is given in world-space.
Parameters
- shapePos1: Vector
  
  The initial position of this sahpe.
- shapeRot1: Rotation
  
  The rotation of this shape.
- shape2: Shape
  
  The second shape.
- shapePos2: Vector
  
  The initial position of the second shape.
- shapeRot2: Rotation
  
  The rotation of the second shape.
- prediction: number
  
  The prediction value, if the shapes are separated by a distance greater than this value, test will fail.
Returns ShapeContact
Inherited from Shape.contactShape
- Defined in geometry/shape.d.ts:60

containsPoint

containsPoint(shapePos: Vector, shapeRot: Rotation, point: Vector): boolean
Parameters
- shapePos: Vector
- shapeRot: Rotation
- point: Vector
Returns boolean
Inherited from Shape.containsPoint
- Defined in geometry/shape.d.ts:61

intersectsRay

intersectsRay(ray: Ray, shapePos: Vector, shapeRot: Rotation, maxToi: number): boolean
Parameters
- ray: Ray
- shapePos: Vector
- shapeRot: Rotation
- maxToi: number
Returns boolean
Inherited from Shape.intersectsRay
- Defined in geometry/shape.d.ts:63

intersectsShape

intersectsShape(shapePos1: Vector, shapeRot1: Rotation, shape2: Shape, shapePos2: Vector, shapeRot2: Rotation): boolean
Tests if this shape intersects another shape.

Returns
true if the two shapes intersect, false if they don’t.
Parameters
- shapePos1: Vector
  
  The position of this shape.
- shapeRot1: Rotation
  
  The rotation of this shape.
- shape2: Shape
  
  The second shape to test.
- shapePos2: Vector
  
  The position of the second shape.
- shapeRot2: Rotation
  
  The rotation of the second shape.
Returns boolean
Inherited from Shape.intersectsShape
- Defined in geometry/shape.d.ts:48

intoRaw

intoRaw(): RawShape
Returns RawShape
Overrides Shape.intoRaw
- Defined in geometry/shape.d.ts:469

projectPoint

projectPoint(shapePos: Vector, shapeRot: Rotation, point: Vector, solid: boolean): PointProjection
Parameters
- shapePos: Vector
- shapeRot: Rotation
- point: Vector
- solid: boolean
Returns PointProjection
Inherited from Shape.projectPoint
- Defined in geometry/shape.d.ts:62

`Static` fromRaw

fromRaw(rawSet: RawColliderSet, handle: number): Shape
instant mode without cache
Parameters
- rawSet: RawColliderSet
- handle: number
Returns Shape
Inherited from Shape.fromRaw
- Defined in geometry/shape.d.ts:17

Class Heightfield

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

nrows: number

ncols: number

heights: Float32Array

scale: Vector

Optional flags: FIX_INTERNAL_EDGES

Returns Heightfield

Properties

flags

heights

ncols

nrows

scale

Readonly type

Methods

castRay

Parameters

ray: Ray

shapePos: Vector

shapeRot: Rotation

maxToi: number

solid: boolean

Returns number

castRayAndGetNormal

Parameters

ray: Ray

shapePos: Vector

shapeRot: Rotation

maxToi: number

solid: boolean

Returns RayIntersection

castShape

Returns

Parameters

shapePos1: Vector

shapeRot1: Rotation

shapeVel1: Vector

shape2: Shape

shapePos2: Vector

shapeRot2: Rotation

shapeVel2: Vector

targetDistance: number

maxToi: number

stopAtPenetration: boolean

Returns ShapeCastHit

contactShape

Returns

Parameters

shapePos1: Vector

shapeRot1: Rotation

shape2: Shape

shapePos2: Vector

shapeRot2: Rotation

prediction: number

Returns ShapeContact

containsPoint

Parameters

shapePos: Vector

shapeRot: Rotation

point: Vector

Returns boolean

intersectsRay

Parameters

ray: Ray

shapePos: Vector

shapeRot: Rotation

maxToi: number

Returns boolean

intersectsShape

Returns

Parameters

shapePos1: Vector

`Optional` flags: FIX_INTERNAL_EDGES

`Readonly` type

`Static` fromRaw