Class HeightmapColliderShapeInformation

Describes a heightmap collider.

Index

Constructors

Properties

_dimensions _heightmap

Accessors

dimensions heightmap

Methods

assign clone isEqual isEqual

Constructors

constructor

new HeightmapColliderShapeInformation(
heightmap?: ResourceHandle<Texture>,
dimensions?: Immutable<Vector3>,
): HeightmapColliderShapeInformation
Parameters
- Optionalheightmap: ResourceHandle<Texture>
- Optionaldimensions: Immutable<Vector3>
Returns HeightmapColliderShapeInformation

Properties

`Protected`_dimensions

_dimensions: Vector3

`Protected`_heightmap

_heightmap: ResourceHandle<Texture>

Accessors

dimensions

get dimensions(): Vector3

Full local-space dimensions of the heightmap collider. X and Z define its horizontal span, while Y scales normalized height samples from 0 to 1.

Returns Vector3
set dimensions(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

heightmap

get heightmap(): ResourceHandle<Texture>

Texture whose red channel provides normalized height samples. May be null or unloaded.

Returns ResourceHandle<Texture>
set heightmap(value: ResourceHandle<Texture>): void
Parameters
- value: ResourceHandle<Texture>
Returns void

Methods

assign

assign(
other: Immutable<HeightmapColliderShapeInformation>,
): HeightmapColliderShapeInformation
Copies all properties defined by the prototype of HeightmapColliderShapeInformation from other to this instance.
Parameters
- other: Immutable<HeightmapColliderShapeInformation>
Returns HeightmapColliderShapeInformation

clone

clone(): HeightmapColliderShapeInformation

Clones this instance and returns a new HeightmapColliderShapeInformation with identical values.

Returns HeightmapColliderShapeInformation

isEqual

isEqual(
this: Immutable<HeightmapColliderShapeInformation>,
other: Immutable<HeightmapColliderShapeInformation>,
): boolean
Determines if this HeightmapColliderShapeInformation instance is equal to the other instance.
Parameters
- this: Immutable<HeightmapColliderShapeInformation>
- other: Immutable<HeightmapColliderShapeInformation>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<HeightmapColliderShapeInformation>,
rhs: Immutable<HeightmapColliderShapeInformation>,
): boolean
Determines if both HeightmapColliderShapeInformation instances are equal.
Parameters
- lhs: Immutable<HeightmapColliderShapeInformation>
- rhs: Immutable<HeightmapColliderShapeInformation>
Returns boolean