InstancedMesh | Babylon.js API documentation

Class InstancedMesh

Creates an instance based on a source mesh.

Hierarchy (View Summary)

AbstractMesh
- InstancedMesh
  - InstancedLinesMesh

Index

Constructors

Constructors

constructor

new InstancedMesh(name: string, source: Mesh): InstancedMesh
Creates a new InstancedMesh object from the mesh source.
Parameters
- name: string
  defines the name of the instance
- source: Mesh
  the mesh to create the instance from
Returns InstancedMesh
Overrides AbstractMesh.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50468

Properties

actionManager

actionManager: Nullable<AbstractActionManager>

Gets or sets the current action manager

See

https://doc.babylonjs.com/features/featuresDeepDive/events/actions

alphaIndex

alphaIndex: number

Gets or sets the alpha index used to sort transparent meshes

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/advanced/transparent_rendering#alpha-index

alwaysSelectAsActiveMesh

alwaysSelectAsActiveMesh: boolean

True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)

animations

animations: Animation[]

Gets a list of Animations associated with the node

cullingStrategy

cullingStrategy: number

The culling strategy to use to check whether the mesh must be rendered or not. This value can be changed at any time and will be used on the next render mesh selection. The possible values are :

AbstractMesh.CULLINGSTRATEGY_STANDARD
AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY Please read each static variable documentation to get details about the culling process.

customMarkAsDirty

customMarkAsDirty: () => void

Allow user to specify custom mechanism for mark as dirty

decalMap

decalMap: Nullable<MeshUVSpaceRenderer>

Gets or sets the decal map for this mesh

definedFacingForward

definedFacingForward: boolean

Gets or sets the orientation for POV movement & rotation

doNotSyncBoundingInfo

doNotSyncBoundingInfo: boolean

Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)

edgesColor

edgesColor: Color4

Defines edge color used when edgesRenderer is enabled

See

https://www.babylonjs-playground.com/#10OJSG#13

edgesRenderer

edgesRenderer: Nullable<EdgesRenderer>

Gets the edgesRenderer associated with the mesh

edgesWidth

edgesWidth: number

Defines edge width used when edgesRenderer is enabled

See

https://www.babylonjs-playground.com/#10OJSG#13

ellipsoid

ellipsoid: Vector3

Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))

See

https://doc.babylonjs.com/features/featuresDeepDive/cameras/camera_collisions

ellipsoidOffset

ellipsoidOffset: Vector3

Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))

See

https://doc.babylonjs.com/features/featuresDeepDive/cameras/camera_collisions

enablePointerMoveEvents

enablePointerMoveEvents: boolean

Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)

forceRenderingWhenOccluded

forceRenderingWhenOccluded: boolean

Flag to force rendering the mesh even if occluded

See

https://doc.babylonjs.com/features/featuresDeepDive/occlusionQueries

id

id: string

Gets or sets the id of the node

ignoreNonUniformScaling

ignoreNonUniformScaling: boolean

Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored. By default the system will update normals to compensate

inspectableCustomProperties

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

See

https://doc.babylonjs.com/toolsAndResources/inspector#extensibility

instancedBuffers

instancedBuffers: { [key: string]: any }

Object used to store instanced buffers defined by user

See

https://doc.babylonjs.com/features/featuresDeepDive/mesh/copies/instances#custom-buffers

isBlocker

isBlocker: boolean

Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)

See

https://doc.babylonjs.com/features/featuresDeepDive/environment/lenseFlare

isNearGrabbable

isNearGrabbable: boolean

Gets or sets a boolean indicating if the mesh can be grabbed. Default is false. Setting this to true, while using the XR near interaction feature, will trigger a pointer event when the mesh is grabbed. Grabbing means that the controller is using the squeeze or main trigger button to grab the mesh. This is different from nearPickable which only triggers the event when the mesh is touched by the controller

isNearPickable

isNearPickable: boolean

Gets or sets a boolean indicating if the mesh can be near picked (touched by the XR controller or hands). Default is false

isOccluded

isOccluded: boolean

Gets or sets whether the mesh is occluded or not, it is used also to set the initial state of the mesh to be occluded or not

See

https://doc.babylonjs.com/features/featuresDeepDive/occlusionQueries

isOcclusionQueryInProgress

isOcclusionQueryInProgress: boolean

Flag to check the progress status of the query

See

https://doc.babylonjs.com/features/featuresDeepDive/occlusionQueries

isPickable

isPickable: boolean

Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true

metadata

metadata: any

Gets or sets an object used to store user defined information for the node

name

name: string

Gets or sets the name of the node

occlusionQueryAlgorithmType

occlusionQueryAlgorithmType: number

This property determines the type of occlusion query algorithm to run in WebGl, you can use:

AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
AbstractMesh.OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE (Default Value) which is mapped to GL_ANY_SAMPLES_PASSED_CONSERVATIVE which is a false positive algorithm that is faster than GL_ANY_SAMPLES_PASSED but less accurate.

See

https://doc.babylonjs.com/features/featuresDeepDive/occlusionQueries

occlusionRetryCount

occlusionRetryCount: number

This number indicates the number of allowed retries before stop the occlusion query, this is useful if the occlusion query is taking long time before to the query result is retrieved, the query result indicates if the object is visible within the scene or not and based on that Babylon.Js engine decides to show or hide the object. The default value is -1 which means don't break the query and wait till the result

See

https://doc.babylonjs.com/features/featuresDeepDive/occlusionQueries

occlusionType

occlusionType: number

This property is responsible for starting the occlusion query within the Mesh or not, this property is also used to determine what should happen when the occlusionRetryCount is reached. It has supports 3 values:

OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query within the Mesh.
OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
OCCLUSION_TYPE_STRICT: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken restore the last state of the mesh occlusion if the mesh was visible then show the mesh if was hidden then hide don't show.

See

https://doc.babylonjs.com/features/featuresDeepDive/occlusionQueries

onAccessibilityTagChangedObservable

onAccessibilityTagChangedObservable: Observable<Nullable<IAccessibilityTag>>

Observable fired when an accessibility tag is changed

onAfterWorldMatrixUpdateObservable

onAfterWorldMatrixUpdateObservable: Observable<TransformNode>

An event triggered after the world matrix is updated

onCollideObservable

onCollideObservable: Observable<AbstractMesh>

An event triggered when this mesh collides with another one

onCollisionPositionChangeObservable

onCollisionPositionChangeObservable: Observable<Vector3>

An event triggered when the collision's position changes

onDisposeObservable

onDisposeObservable: Observable<Node>

An event triggered when the mesh is disposed

onMaterialChangedObservable

onMaterialChangedObservable: Observable<AbstractMesh>

An event triggered when material is changed

onReady

onReady: Nullable<(node: Node) => void>

Callback raised when the node is ready to be used

onRebuildObservable

onRebuildObservable: Observable<AbstractMesh>

An event triggered when the mesh is rebuilt.

outlineColor

outlineColor: Color3

Defines color to use when rendering outline

outlineWidth

outlineWidth: number

Define width to use when rendering outline

overlayAlpha

overlayAlpha: number

Defines alpha to use when rendering overlay

overlayColor

overlayColor: Color3

Defines color to use when rendering overlay

physicsBody

physicsBody: Nullable<PhysicsBody>

See

physicsImpostor

physicsImpostor: Nullable<PhysicsImpostor>

Gets or sets impostor used for physic simulation

See

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

reIntegrateRotationIntoRotationQuaternion

reIntegrateRotationIntoRotationQuaternion: boolean

Gets or sets a boolean indicating that even if rotationQuaternion is defined, you can keep updating rotation property and Babylon.js will just mix both

renderOutline

renderOutline: boolean

Gets or sets a boolean indicating if the outline must be rendered as well

See

https://www.babylonjs-playground.com/#10WJ5S#3

renderOverlay

renderOverlay: boolean

Gets or sets a boolean indicating if the overlay must be rendered as well

See

https://www.babylonjs-playground.com/#10WJ5S#2

reservedDataStore

reservedDataStore: any

For internal use only. Please do not use.

scalingDeterminant

scalingDeterminant: number

Multiplication factor on scale x/y/z when computing the world matrix. Eg. for a 1x1x1 cube setting this to 2 will make it a 2x2x2 cube

showBoundingBox

showBoundingBox: boolean

Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)

showSubMeshesBoundingBox

showSubMeshesBoundingBox: boolean

Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default)

state

state: string

Gets or sets a string used to store user defined state for the node

subMeshes

subMeshes: SubMesh[]

Gets or sets the list of subMeshes

See

https://doc.babylonjs.com/features/featuresDeepDive/materials/using/multiMaterials

uniqueId

uniqueId: number

Gets or sets the unique id of the node

useOctreeForCollisions

useOctreeForCollisions: boolean

Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default)

useOctreeForPicking

useOctreeForPicking: boolean

Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default)

useOctreeForRenderingSelection

useOctreeForRenderingSelection: boolean

Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default)

`Static`BillboardUseParentOrientation

BillboardUseParentOrientation: boolean

Child transform with Billboard flags should or should not apply parent rotation (default if off)

`Static` `Readonly`CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY

CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: 1

Culling strategy : Bounding Sphere Only. This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested. It's also less accurate than the standard because some not visible objects can still be selected. Test : is the bounding sphere outside the frustum ? If not, then the cullable object is in the frustum.

`Static` `Readonly`CULLINGSTRATEGY_OPTIMISTIC_INCLUSION

CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: 2

Culling strategy : Optimistic Inclusion. This in an inclusion test first, then the standard exclusion test. This can be faster when a cullable object is expected to be almost always in the camera frustum. This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside. Anyway, it's as accurate as the standard strategy. Test : Is the cullable object bounding sphere center in the frustum ? If not, apply the default culling strategy.

`Static` `Readonly`CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY

CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: 3

Culling strategy : Optimistic Inclusion then Bounding Sphere Only. This in an inclusion test first, then the bounding sphere only exclusion test. This can be the fastest test when a cullable object is expected to be almost always in the camera frustum. This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it. It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy. Test : Is the cullable object bounding sphere center in the frustum ? If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.

`Static` `Readonly`CULLINGSTRATEGY_STANDARD

CULLINGSTRATEGY_STANDARD: 0

Default culling strategy : this is an exclusion test and it's the more accurate. Test order : Is the bounding sphere outside the frustum ? If not, are the bounding box vertices outside the frustum ? It not, then the cullable object is in the frustum.

`Static`OCCLUSION_ALGORITHM_TYPE_ACCURATE

OCCLUSION_ALGORITHM_TYPE_ACCURATE: number

Use an accurate occlusion algorithm

`Static`OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE

OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number

Use a conservative occlusion algorithm

`Static`OCCLUSION_TYPE_NONE

OCCLUSION_TYPE_NONE: number

No occlusion

`Static`OCCLUSION_TYPE_OPTIMISTIC

OCCLUSION_TYPE_OPTIMISTIC: number

Occlusion set to optimistic

`Static`OCCLUSION_TYPE_STRICT

OCCLUSION_TYPE_STRICT: number

Occlusion set to strict

Accessors

absolutePosition

get absolutePosition(): Vector3
Returns the current mesh absolute position. Returns a Vector3.

Returns Vector3
Inherited from AbstractMesh.absolutePosition
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46399

absoluteRotationQuaternion

get absoluteRotationQuaternion(): Quaternion
Returns the current mesh absolute rotation. Returns a Quaternion.

Returns Quaternion
Inherited from AbstractMesh.absoluteRotationQuaternion
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46409

absoluteScaling

get absoluteScaling(): Vector3
Returns the current mesh absolute scaling. Returns a Vector3.

Returns Vector3
Inherited from AbstractMesh.absoluteScaling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46404

accessibilityTag

get accessibilityTag(): Nullable<IAccessibilityTag>
Returns Nullable<IAccessibilityTag>
Inherited from AbstractMesh.accessibilityTag
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4464
set accessibilityTag(value: Nullable<IAccessibilityTag>): void
Gets or sets the accessibility tag to describe the node for accessibility purpose.
Parameters
- value: Nullable<IAccessibilityTag>
Returns void
Inherited from AbstractMesh.accessibilityTag
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4463

animationPropertiesOverride

get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>
Gets or sets the animation properties override

Returns Nullable<AnimationPropertiesOverride>
Inherited from AbstractMesh.animationPropertiesOverride
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4535
set animationPropertiesOverride(
value: Nullable<AnimationPropertiesOverride>,
): void
Parameters
- value: Nullable<AnimationPropertiesOverride>
Returns void
Inherited from AbstractMesh.animationPropertiesOverride
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4536

applyFog

get applyFog(): boolean
Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default)

Returns boolean
Inherited from AbstractMesh.applyFog
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52312
set applyFog(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AbstractMesh.applyFog
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52313

bakedVertexAnimationManager

get bakedVertexAnimationManager(): Nullable<IBakedVertexAnimationManager>
Gets or sets the baked vertex animation manager

Returns Nullable<IBakedVertexAnimationManager>
See
https://doc.babylonjs.com/features/featuresDeepDive/animation/baked_texture_animations
Inherited from AbstractMesh.bakedVertexAnimationManager
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52166
set bakedVertexAnimationManager(
value: Nullable<IBakedVertexAnimationManager>,
): void
Parameters
- value: Nullable<IBakedVertexAnimationManager>
Returns void
Inherited from AbstractMesh.bakedVertexAnimationManager
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52167

behaviors

get behaviors(): Behavior<Node>[]
Gets the list of attached behaviors

Returns Behavior<Node>[]
See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors
Inherited from AbstractMesh.behaviors
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4598

billboardMode

get billboardMode(): number
Gets or sets the billboard mode. Default is 0.

Value Type Description

0 BILLBOARDMODE_NONE

1 BILLBOARDMODE_X

2 BILLBOARDMODE_Y

4 BILLBOARDMODE_Z

7 BILLBOARDMODE_ALL

Returns number
Inherited from AbstractMesh.billboardMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46278
set billboardMode(value: number): void
Parameters
- value: number
Returns void
Inherited from AbstractMesh.billboardMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46279

Value	Type	Description
0	BILLBOARDMODE_NONE
1	BILLBOARDMODE_X
2	BILLBOARDMODE_Y
4	BILLBOARDMODE_Z
7	BILLBOARDMODE_ALL

checkCollisions

get checkCollisions(): boolean
Gets or sets a boolean indicating that this mesh can be used in the collision engine

Returns boolean
See
https://doc.babylonjs.com/features/featuresDeepDive/cameras/camera_collisions
Inherited from AbstractMesh.checkCollisions
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52815
set checkCollisions(collisionEnabled: boolean): void
Parameters
- collisionEnabled: boolean
Returns void
Inherited from AbstractMesh.checkCollisions
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52816

collider

get collider(): Nullable<Collider>
Gets Collider object used to compute collisions (not physics)

Returns Nullable<Collider>
See
https://doc.babylonjs.com/features/featuresDeepDive/cameras/camera_collisions
Inherited from AbstractMesh.collider
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52821

collisionGroup

get collisionGroup(): number
Gets or sets the current collision group mask (-1 by default). A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0

Returns number
Inherited from AbstractMesh.collisionGroup
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52370
set collisionGroup(mask: number): void
Parameters
- mask: number
Returns void
Inherited from AbstractMesh.collisionGroup
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52371

collisionMask

get collisionMask(): number
Gets or sets a collision mask used to mask collisions (default is -1). A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0

Returns number
Inherited from AbstractMesh.collisionMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52356
set collisionMask(mask: number): void
Parameters
- mask: number
Returns void
Inherited from AbstractMesh.collisionMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52357

collisionResponse

get collisionResponse(): boolean
Gets or sets a collision response flag (default is true). when collisionResponse is false, events are still triggered but colliding entity has no response This helps creating trigger volume when user wants collision feedback events but not position/velocity to respond to the collision.

Returns boolean
Inherited from AbstractMesh.collisionResponse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52364
set collisionResponse(response: boolean): void
Parameters
- response: boolean
Returns void
Inherited from AbstractMesh.collisionResponse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52365

collisionRetryCount

get collisionRetryCount(): number
number of collision detection tries. Change this value if not all collisions are detected and handled properly

Returns number
Inherited from AbstractMesh.collisionRetryCount
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52149
set collisionRetryCount(retryCount: number): void
Parameters
- retryCount: number
Returns void
Inherited from AbstractMesh.collisionRetryCount
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52150

computeBonesUsingShaders

get computeBonesUsingShaders(): boolean
Gets or sets a boolean indicating that bone animations must be computed by the GPU (true by default)

Returns boolean
Inherited from AbstractMesh.computeBonesUsingShaders
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52306
set computeBonesUsingShaders(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AbstractMesh.computeBonesUsingShaders
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52307

doNotSerialize

get doNotSerialize(): boolean
Gets or sets a boolean used to define if the node must be serialized

Returns boolean
Inherited from AbstractMesh.doNotSerialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4473
set doNotSerialize(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AbstractMesh.doNotSerialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4474

enableDistantPicking

get enableDistantPicking(): boolean
When enabled, decompose picking matrices for better precision with large values for mesh position and scling

Returns boolean
Inherited from AbstractMesh.enableDistantPicking
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52315
set enableDistantPicking(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AbstractMesh.enableDistantPicking
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52316

facetDepthSortFrom

get facetDepthSortFrom(): Vector3
The location (Vector3) where the facet depth sort must be computed from. By default, the active camera position. Used only when facet depth sort is enabled

Returns Vector3
See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData#facet-depth-sort
Inherited from AbstractMesh.facetDepthSortFrom
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52146
set facetDepthSortFrom(location: Vector3): void
Parameters
- location: Vector3
Returns void
Inherited from AbstractMesh.facetDepthSortFrom
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52147

facetNb

get facetNb(): number
Gets the number of facets in the mesh

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData#what-is-a-mesh-facet
Inherited from AbstractMesh.facetNb
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52118

forward

get forward(): Vector3
The forward direction of that transform in world space.

Returns Vector3
Inherited from AbstractMesh.forward
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46371

geometry

get geometry(): Nullable<Geometry>
Gets the mesh internal Geometry object

Returns Nullable<Geometry>
Overrides AbstractMesh.geometry
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50519

hasBoundingInfo

get hasBoundingInfo(): boolean
Returns true if there is already a bounding info

Returns boolean
Inherited from AbstractMesh.hasBoundingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52639

hasInstances

get hasInstances(): boolean
Gets a boolean indicating if this mesh has instances

Returns boolean
Inherited from AbstractMesh.hasInstances
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52688

hasThinInstances

get hasThinInstances(): boolean
Gets a boolean indicating if this mesh has thin instances

Returns boolean
Inherited from AbstractMesh.hasThinInstances
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52692

hasVertexAlpha

get hasVertexAlpha(): boolean
Gets or sets a boolean indicating that this mesh needs to use vertex alpha data to render. This property is misnamed and should be useVertexAlpha. Note that the mesh will be rendered with alpha blending when this flag is set even if vertex alpha data is missing from the geometry.

Returns boolean
Inherited from AbstractMesh.hasVertexAlpha
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52298
set hasVertexAlpha(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AbstractMesh.hasVertexAlpha
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52299

infiniteDistance

get infiniteDistance(): boolean
Gets or sets the distance of the object to max, often used by skybox

Returns boolean
Inherited from AbstractMesh.infiniteDistance
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46296
set infiniteDistance(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AbstractMesh.infiniteDistance
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46297

inheritVisibility

get inheritVisibility(): boolean
If set to true, a mesh will only be visible only if its parent(s) are also visible (default is false)

Returns boolean
Inherited from AbstractMesh.inheritVisibility
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52216
set inheritVisibility(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AbstractMesh.inheritVisibility
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52217

isAnInstance

get isAnInstance(): boolean
Gets a boolean indicating if this mesh is an instance or a regular mesh

Returns boolean
Overrides AbstractMesh.isAnInstance
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50649

isBlocked

get isBlocked(): boolean
Returns true if the mesh is blocked. Implemented by child classes

Returns boolean
Inherited from AbstractMesh.isBlocked
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52517

isFacetDataEnabled

get isFacetDataEnabled(): boolean
gets a boolean indicating if facetData is enabled

Returns boolean
See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData#what-is-a-mesh-facet
Inherited from AbstractMesh.isFacetDataEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52155

isVisible

get isVisible(): boolean
Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true

Returns boolean
Inherited from AbstractMesh.isVisible
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52222
set isVisible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AbstractMesh.isVisible
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52223

isWorldMatrixFrozen

get isWorldMatrixFrozen(): boolean
True if the World matrix has been frozen.

Returns boolean
Inherited from AbstractMesh.isWorldMatrixFrozen
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46457

layerMask

get layerMask(): number
Gets or sets the current layer mask (default is 0x0FFFFFFF)

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/cameras/layerMasksAndMultiCam
Inherited from AbstractMesh.layerMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52327
set layerMask(value: number): void
Parameters
- value: number
Returns void
Inherited from AbstractMesh.layerMask
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52328

lightSources

get lightSources(): Light[]
Gets the list of lights affecting that mesh

Returns Light[]
Overrides AbstractMesh.lightSources
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50474

material

get material(): Nullable<Material>
The material of the source mesh

Returns Nullable<Material>
Overrides AbstractMesh.material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50486
set material(_value: Nullable<Material>): void
Gets or sets current material
Parameters
- _value: Nullable<Material>
Returns void
Overrides AbstractMesh.material
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50487

morphTargetManager

get morphTargetManager(): Nullable<MorphTargetManager>
Gets or sets the morph target manager

Returns Nullable<MorphTargetManager>
See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/morphTargets
Inherited from AbstractMesh.morphTargetManager
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52160
set morphTargetManager(value: Nullable<MorphTargetManager>): void
Parameters
- value: Nullable<MorphTargetManager>
Returns void
Inherited from AbstractMesh.morphTargetManager
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52161

mustDepthSortFacets

get mustDepthSortFacets(): boolean
Gets or sets a boolean indicating that the facets must be depth sorted on next call to updateFacetData(). Works only for updatable meshes. Doesn't work with multi-materials

Returns boolean
See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData#facet-depth-sort
Inherited from AbstractMesh.mustDepthSortFacets
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52138
set mustDepthSortFacets(sort: boolean): void
Parameters
- sort: boolean
Returns void
Inherited from AbstractMesh.mustDepthSortFacets
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52139

nonUniformScaling

get nonUniformScaling(): boolean
True if the scaling property of this object is non uniform eg. (1,2,1)

Returns boolean
Inherited from AbstractMesh.nonUniformScaling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46591

numBoneInfluencers

get numBoneInfluencers(): number
Gets or sets the number of allowed bone influences per vertex (4 by default)

Returns number
Inherited from AbstractMesh.numBoneInfluencers
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52309
set numBoneInfluencers(value: number): void
Parameters
- value: number
Returns void
Inherited from AbstractMesh.numBoneInfluencers
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52310

onClonedObservable

get onClonedObservable(): Observable<Node>
An event triggered when the node is cloned

Returns Observable<Node>
Inherited from AbstractMesh.onClonedObservable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4560

onCollide

set onCollide(callback: (collidedMesh?: AbstractMesh) => void): void
Set a function to call when this mesh collides with another one
Parameters
- callback: (collidedMesh?: AbstractMesh) => void
Returns void
Inherited from AbstractMesh.onCollide
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52182

onCollisionPositionChange

set onCollisionPositionChange(callback: () => void): void
Set a function to call when the collision's position changes
Parameters
- callback: () => void
Returns void
Inherited from AbstractMesh.onCollisionPositionChange
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52188

onDispose

set onDispose(callback: () => void): void
Sets a callback that will be raised when the node will be disposed
Parameters
- callback: () => void
Returns void
Inherited from AbstractMesh.onDispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4552

onEnabledStateChangedObservable

get onEnabledStateChangedObservable(): Observable<boolean>
An event triggered when the enabled state of the node changes

Returns Observable<boolean>
Inherited from AbstractMesh.onEnabledStateChangedObservable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4556

parent

get parent(): Nullable<Node>
Returns Nullable<Node>
Inherited from AbstractMesh.parent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4522
set parent(parent: Nullable<Node>): void
Gets or sets the parent of the node (without keeping the current position in the scene)
Parameters
- parent: Nullable<Node>
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/transforms/parent_pivot/parent
Inherited from AbstractMesh.parent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4521

partitioningBBoxRatio

get partitioningBBoxRatio(): number
The ratio (float) to apply to the bounding box size to set to the partitioning space. Ex : 1.01 (default) the partitioning space is 1% bigger than the bounding box

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData#tweaking-the-partitioning
Inherited from AbstractMesh.partitioningBBoxRatio
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52130
set partitioningBBoxRatio(ratio: number): void
Parameters
- ratio: number
Returns void
Inherited from AbstractMesh.partitioningBBoxRatio
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52131

partitioningSubdivisions

get partitioningSubdivisions(): number
Gets or set the number (integer) of subdivisions per axis in the partitioning space

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData#tweaking-the-partitioning
Inherited from AbstractMesh.partitioningSubdivisions
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52123
set partitioningSubdivisions(nb: number): void
Parameters
- nb: number
Returns void
Inherited from AbstractMesh.partitioningSubdivisions
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52124

pointerOverDisableMeshTesting

get pointerOverDisableMeshTesting(): boolean
Gets or sets the property which disables the test that is checking that the mesh under the pointer is the same than the previous time we tested for it (default: false). Set this property to true if you want thin instances picking to be reported accurately when moving over the mesh. Note that setting this property to true will incur some performance penalties when dealing with pointer events for this mesh so use it sparingly.

Returns boolean
Inherited from AbstractMesh.pointerOverDisableMeshTesting
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52254
set pointerOverDisableMeshTesting(disable: boolean): void
Parameters
- disable: boolean
Returns void
Inherited from AbstractMesh.pointerOverDisableMeshTesting
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52255

position

get position(): Vector3
Gets or set the node position (default is (0.0, 0.0, 0.0))

Returns Vector3
Inherited from AbstractMesh.position
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46335
set position(newPosition: Vector3): void
Parameters
- newPosition: Vector3
Returns void
Inherited from AbstractMesh.position
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46336

preserveParentRotationForBillboard

get preserveParentRotationForBillboard(): boolean
Gets or sets a boolean indicating that parent rotation should be preserved when using billboards. This could be useful for glTF objects where parent rotation helps converting from right handed to left handed

Returns boolean
Inherited from AbstractMesh.preserveParentRotationForBillboard
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46285
set preserveParentRotationForBillboard(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AbstractMesh.preserveParentRotationForBillboard
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46286

rawBoundingInfo

set rawBoundingInfo(boundingInfo: Nullable<BoundingInfo>): void
Parameters
- boundingInfo: Nullable<BoundingInfo>
Returns void
Inherited from AbstractMesh.rawBoundingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52176

receiveShadows

get receiveShadows(): boolean
If the source mesh receives shadows

Returns boolean
Overrides AbstractMesh.receiveShadows
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50481
set receiveShadows(_value: boolean): void
Gets or sets a boolean indicating that this mesh can receive realtime shadows
Parameters
- _value: boolean
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/lights/shadows
Overrides AbstractMesh.receiveShadows
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50482

renderingGroupId

get renderingGroupId(): number
Rendering ground id of the source mesh

Returns number
Overrides AbstractMesh.renderingGroupId
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50501
set renderingGroupId(value: number): void
Specifies the rendering group id for this mesh (0 by default)
Parameters
- value: number
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/materials/advanced/transparent_rendering#rendering-groups
Overrides AbstractMesh.renderingGroupId
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50502

right

get right(): Vector3
The right direction of that transform in world space.

Returns Vector3
Inherited from AbstractMesh.right
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46379

rotation

get rotation(): Vector3
Gets or sets the rotation property : a Vector3 defining the rotation value in radians around each local axis X, Y, Z (default is (0.0, 0.0, 0.0)). If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion

Returns Vector3
Inherited from AbstractMesh.rotation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46350
set rotation(newRotation: Vector3): void
Parameters
- newRotation: Vector3
Returns void
Inherited from AbstractMesh.rotation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46351

rotationQuaternion

get rotationQuaternion(): Nullable<Quaternion>
Gets or sets the rotation Quaternion property : this a Quaternion object defining the node rotation by using a unit quaternion (undefined by default, but can be null). If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)

Returns Nullable<Quaternion>
Inherited from AbstractMesh.rotationQuaternion
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46361
set rotationQuaternion(quaternion: Nullable<Quaternion>): void
Parameters
- quaternion: Nullable<Quaternion>
Returns void
Inherited from AbstractMesh.rotationQuaternion
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46362

scaling

get scaling(): Vector3
Gets or sets the scaling property : a Vector3 defining the node scaling along each local axis X, Y, Z (default is (1.0, 1.0, 1.0)).

Returns Vector3
Inherited from AbstractMesh.scaling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46355
set scaling(newScaling: Vector3): void
Parameters
- newScaling: Vector3
Returns void
Inherited from AbstractMesh.scaling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46356

skeleton

get skeleton(): Nullable<Skeleton>
Skeleton of the source mesh

Returns Nullable<Skeleton>
Overrides AbstractMesh.skeleton
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50496
set skeleton(_value: Nullable<Skeleton>): void
Gets or sets a skeleton to apply skinning transformations
Parameters
- _value: Nullable<Skeleton>
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/bonesSkeletons
Overrides AbstractMesh.skeleton
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50497

sourceMesh

get sourceMesh(): Mesh
The source mesh of the instance

Returns Mesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50515

surroundingMeshes

get surroundingMeshes(): Nullable<AbstractMesh[]>
Gets or sets current surrounding meshes (null by default).

By default collision detection is tested against every mesh in the scene. It is possible to set surroundingMeshes to a defined list of meshes and then only these specified meshes will be tested for the collision.

Note: if set to an empty array no collision will happen when this mesh is moved.

Returns Nullable<AbstractMesh[]>
Inherited from AbstractMesh.surroundingMeshes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52381
set surroundingMeshes(meshes: Nullable<AbstractMesh[]>): void
Parameters
- meshes: Nullable<AbstractMesh[]>
Returns void
Inherited from AbstractMesh.surroundingMeshes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52382

up

get up(): Vector3
The up direction of that transform in world space.

Returns Vector3
Inherited from AbstractMesh.up
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46375

useBones

get useBones(): boolean
Gets a boolean indicating if this mesh has skinning data and an attached skeleton

Returns boolean
Inherited from AbstractMesh.useBones
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52657

useVertexColors

get useVertexColors(): boolean
Gets or sets a boolean indicating that this mesh needs to use vertex color data to render (if this kind of vertex data is available in the geometry)

Returns boolean
Inherited from AbstractMesh.useVertexColors
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52301
set useVertexColors(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AbstractMesh.useVertexColors
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52302

visibility

get visibility(): number
Visibility of the source mesh

Returns number
Overrides AbstractMesh.visibility
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50491
set visibility(_value: number): void
Gets or sets mesh visibility between 0 and 1 (default is 1)
Parameters
- _value: number
Returns void
Overrides AbstractMesh.visibility
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50492

worldMatrixFromCache

get worldMatrixFromCache(): Matrix
Returns directly the latest state of the mesh World matrix. A Matrix is returned.

Returns Matrix
Inherited from AbstractMesh.worldMatrixFromCache
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4617

`Static`BILLBOARDMODE_ALL

get BILLBOARDMODE_ALL(): number
Billboard on all axes

Returns number
Inherited from AbstractMesh.BILLBOARDMODE_ALL
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52094

`Static`BILLBOARDMODE_NONE

get BILLBOARDMODE_NONE(): number
No billboard

Returns number
Inherited from AbstractMesh.BILLBOARDMODE_NONE
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52086

`Static`BILLBOARDMODE_USE_POSITION

get BILLBOARDMODE_USE_POSITION(): number
Billboard on using position instead of orientation

Returns number
Inherited from AbstractMesh.BILLBOARDMODE_USE_POSITION
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52096

`Static`BILLBOARDMODE_X

get BILLBOARDMODE_X(): number
Billboard on X axis

Returns number
Inherited from AbstractMesh.BILLBOARDMODE_X
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52088

`Static`BILLBOARDMODE_Y

get BILLBOARDMODE_Y(): number
Billboard on Y axis

Returns number
Inherited from AbstractMesh.BILLBOARDMODE_Y
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52090

`Static`BILLBOARDMODE_Z

get BILLBOARDMODE_Z(): number
Billboard on Z axis

Returns number
Inherited from AbstractMesh.BILLBOARDMODE_Z
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52092

Methods

addBehavior

addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node
Attach a behavior to the node
Parameters
- behavior: Behavior<Node>
  defines the behavior to attach
- OptionalattachImmediately: boolean
  defines that the behavior must be attached even if the scene is still loading
Returns Node
the current Node

See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors
Inherited from AbstractMesh.addBehavior
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4586

addChild

addChild(mesh: TransformNode, preserveScalingSign?: boolean): this
Adds the passed mesh as a child to the current mesh. The node will remain exactly where it is and its position / rotation will be updated accordingly. This method is equivalent to calling setParent().
Parameters
- mesh: TransformNode
  defines the child mesh
- OptionalpreserveScalingSign: boolean
  if true, keep scaling sign of child. Otherwise, scaling sign might change.
Returns this
the current mesh
Inherited from AbstractMesh.addChild
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46579

addRotation

addRotation(x: number, y: number, z: number): TransformNode
Adds a rotation step to the mesh current rotation. x, y, z are Euler angles expressed in radians. This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set. This means this rotation is made in the mesh local space only. It's useful to set a custom rotation order different from the BJS standard one YXZ. Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
```
mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
```
Note that addRotation() accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values. Under the hood, only quaternions are used. So it's a little faster is you use .rotationQuaternion because it doesn't need to translate them back to Euler angles.
Parameters
- x: number
  Rotation to add
- y: number
  Rotation to add
- z: number
  Rotation to add
Returns TransformNode
the TransformNode.
Inherited from AbstractMesh.addRotation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46658

alignWithNormal

alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh
Align the mesh with a normal
Parameters
- normal: Vector3
  defines the normal to use
- OptionalupDirection: Vector3
  can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
Returns AbstractMesh
the current mesh
Inherited from AbstractMesh.alignWithNormal
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53012

applyAngularImpulse

applyAngularImpulse(angularImpulse: Vector3): TransformNode
Apply a physic angular impulse to the mesh
Parameters
- angularImpulse: Vector3
  defines the torque to apply
Returns TransformNode
the current mesh
Inherited from AbstractMesh.applyAngularImpulse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27268

applyImpulse

applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh
Apply a physic impulse to the mesh
Parameters
- force: Vector3
  defines the force to apply
- contactPoint: Vector3
  defines where to apply the force
Returns AbstractMesh
the current mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/physics/usingPhysicsEngine
Inherited from AbstractMesh.applyImpulse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:30772

attachToBone

attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode
Attach the current TransformNode to another TransformNode associated with a bone
Parameters
- bone: Bone
  Bone affecting the TransformNode
- affectedTransformNode: TransformNode
  TransformNode associated with the bone
Returns TransformNode
this object
Inherited from AbstractMesh.attachToBone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46602

beginAnimation

beginAnimation(
    name: string,
    loop?: boolean,
    speedRatio?: number,
    onAnimationEnd?: () => void,
): Nullable<Animatable>
Will start the animation sequence
Parameters
- name: string
  defines the range frames for animation sequence
- Optionalloop: boolean
  defines if the animation should loop (false by default)
- OptionalspeedRatio: number
  defines the speed factor in which to run the animation (1 by default)
- OptionalonAnimationEnd: () => void
  defines a function to be executed when the animation ended (undefined by default)
Returns Nullable<Animatable>
the object created for this animation. If range does not exist, it will return null
Inherited from AbstractMesh.beginAnimation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4769

buildBoundingInfo

buildBoundingInfo(
    minimum: DeepImmutableObject<Vector3>,
    maximum: DeepImmutableObject<Vector3>,
    worldMatrix?: DeepImmutableObject<Matrix>,
): BoundingInfo
Creates a new bounding info for the mesh
Parameters
- minimum: DeepImmutableObject<Vector3>
  min vector of the bounding box/sphere
- maximum: DeepImmutableObject<Vector3>
  max vector of the bounding box/sphere
- OptionalworldMatrix: DeepImmutableObject<Matrix>
  defines the new world matrix
Returns BoundingInfo
the new bounding info
Inherited from AbstractMesh.buildBoundingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52647

calcMovePOV

calcMovePOV(
    amountRight: number,
    amountUp: number,
    amountForward: number,
): Vector3
Calculate relative position change from the point of view of behind the front of the mesh. This is performed taking into account the meshes current rotation, so you do not have to care. Supports definition of mesh facing forward or backward definedFacingForwardSearch | See definedFacingForwardSearch.
Parameters
- amountRight: number
  defines the distance on the right axis
- amountUp: number
  defines the distance on the up axis
- amountForward: number
  defines the distance on the forward axis
Returns Vector3
the new displacement vector
Inherited from AbstractMesh.calcMovePOV
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52712

calcRotatePOV

calcRotatePOV(
    flipBack: number,
    twirlClockwise: number,
    tiltRight: number,
): Vector3
Calculate relative rotation change from the point of view of behind the front of the mesh. Supports definition of mesh facing forward or backward definedFacingForwardSearch | See definedFacingForwardSearch.
Parameters
- flipBack: number
  defines the flip
- twirlClockwise: number
  defines the twirl
- tiltRight: number
  defines the tilt
Returns Vector3
the new rotation vector
Inherited from AbstractMesh.calcRotatePOV
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52730

clone

clone(
    name: string,
    newParent?: Nullable<Node>,
    doNotCloneChildren?: boolean,
    newSourceMesh?: Mesh,
): InstancedMesh
Creates a new InstancedMesh from the current mesh.

Returns the clone.
Parameters
- name: string
  the cloned mesh name
- OptionalnewParent: Nullable<Node>
  the optional Node to parent the clone to.
- OptionaldoNotCloneChildren: boolean
  if true the model children aren't cloned.
- OptionalnewSourceMesh: Mesh
  if set this mesh will be used as the source mesh instead of ths instance's one
Returns InstancedMesh
the clone
Overrides AbstractMesh.clone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50676

computeWorldMatrix

computeWorldMatrix(force?: boolean, camera?: Nullable<Camera>): Matrix
Computes the world matrix of the node
Parameters
- Optionalforce: boolean
  defines if the cache version should be invalidated forcing the world matrix to be created from scratch
- Optionalcamera: Nullable<Camera>
  defines the camera used if different from the scene active camera (This is used with modes like Billboard or infinite distance)
Returns Matrix
the world matrix
Inherited from AbstractMesh.computeWorldMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46675

copyVerticesData

copyVerticesData(
kind: string,
vertexData: { [kind: string]: Float32Array },
): void
Copies the requested vertex data kind into the given vertex data map. Float data is constructed if the map doesn't have the data.
Parameters
- kind: string
  defines the vertex data kind to use
- vertexData: { [kind: string]: Float32Array }
  defines the map that stores the resulting data
Returns void
Overrides AbstractMesh.copyVerticesData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50541

createAnimationRange

createAnimationRange(name: string, from: number, to: number): void
Creates an animation range for this node
Parameters
- name: string
  defines the name of the range
- from: number
  defines the starting key
- to: number
  defines the end key
Returns void
Inherited from AbstractMesh.createAnimationRange
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4735

createInstance

createInstance(name: string): InstancedMesh
Creates a new InstancedMesh object from the mesh model.
Parameters
- name: string
  defines the name of the new instance
Returns InstancedMesh
a new InstancedMesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/copies/instances
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50526

createNormals

createNormals(updatable: boolean): AbstractMesh
Creates new normals data for the mesh
Parameters
- updatable: boolean
  defines if the normal vertex buffer must be flagged as updatable
Returns AbstractMesh
the current mesh
Inherited from AbstractMesh.createNormals
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53000

createOrUpdateSubmeshesOctree

createOrUpdateSubmeshesOctree(
maxCapacity?: number,
maxDepth?: number,
): Octree<SubMesh>
This function will create an octree to help to select the right submeshes for rendering, picking and collision computations. Please note that you must have a decent number of submeshes to get performance improvements when using an octree
Parameters
- OptionalmaxCapacity: number
  defines the maximum size of each block (64 by default)
- OptionalmaxDepth: number
  defines the maximum depth to use (no more than 2 levels by default)
Returns Octree<SubMesh>
the new octree
See
- https://www.babylonjs-playground.com/#NA4OQ#12
- https://doc.babylonjs.com/features/featuresDeepDive/scene/optimizeOctrees
Inherited from AbstractMesh.createOrUpdateSubmeshesOctree
- Defined in .temp/typedoc/docdirectory/doc.d.ts:125718

deleteAnimationRange

deleteAnimationRange(name: string, deleteFrames?: boolean): void
Delete a specific animation range
Parameters
- name: string
  defines the name of the range to delete
- OptionaldeleteFrames: boolean
  defines if animation frames from the range must be deleted as well
Returns void
Inherited from AbstractMesh.deleteAnimationRange
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4741

detachFromBone

detachFromBone(resetToPreviousParent?: boolean): TransformNode
Detach the transform node if its associated with a bone
Parameters
- OptionalresetToPreviousParent: boolean
  Indicates if the parent that was in effect when attachToBone was called should be set back or if we should set parent to null instead (defaults to the latter)
Returns TransformNode
this object
Inherited from AbstractMesh.detachFromBone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46608

disableEdgesRendering

disableEdgesRendering(): AbstractMesh
Disables the mesh edge rendering mode

Returns AbstractMesh
the currentAbstractMesh
Inherited from AbstractMesh.disableEdgesRendering
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53019

disableFacetData

disableFacetData(): AbstractMesh
Disables the feature FacetData and frees the related memory

Returns AbstractMesh
the current mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData
Inherited from AbstractMesh.disableFacetData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52986

dispose

dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void
Disposes the InstancedMesh. Returns nothing.
Parameters
- OptionaldoNotRecurse: boolean
  Set to true to not recurse into each children (recurse into each children by default)
- OptionaldisposeMaterialAndTextures: boolean
  Set to true to also dispose referenced materials and textures (false by default)
Returns void
Overrides AbstractMesh.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50683

enableEdgesRendering

enableEdgesRendering(
    epsilon?: number,
    checkVerticesInsteadOfIndices?: boolean,
    options?: IEdgesRendererOptions,
): AbstractMesh
Enables the edge rendering mode on the mesh. This mode makes the mesh edges visible
Parameters
- Optionalepsilon: number
  defines the maximal distance between two angles to detect a face
- OptionalcheckVerticesInsteadOfIndices: boolean
  indicates that we should check vertex list directly instead of faces
- Optionaloptions: IEdgesRendererOptions
  options to the edge renderer
Returns AbstractMesh
the currentAbstractMesh

See
https://www.babylonjs-playground.com/#19O9TU#0
Inherited from AbstractMesh.enableEdgesRendering
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53029

freezeWorldMatrix

freezeWorldMatrix(
newWorldMatrix?: Nullable<Matrix>,
decompose?: boolean,
): TransformNode
Prevents the World matrix to be computed any longer. Please note that the "moral" contract is that the world matrix is not going to be updated anymore. It is up to the developer to force updates. You trade flexibility for performance. If you want to update it, you have to unfreeze it first.
Parameters
- OptionalnewWorldMatrix: Nullable<Matrix>
  defines an optional matrix to use as world matrix
- Optionaldecompose: boolean
  defines whether to decompose the given newWorldMatrix or directly assign
Returns TransformNode
the TransformNode.
Inherited from AbstractMesh.freezeWorldMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46448

getAbsolutePivotPoint

getAbsolutePivotPoint(): Vector3
Returns a new Vector3 set with the mesh pivot point World coordinates.

Returns Vector3
a new Vector3 set with the mesh pivot point World coordinates.
Inherited from AbstractMesh.getAbsolutePivotPoint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46544

getAbsolutePivotPointToRef

getAbsolutePivotPointToRef(result: Vector3): TransformNode
Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
Parameters
- result: Vector3
  vector3 to store the result
Returns TransformNode
this TransformNode.
Inherited from AbstractMesh.getAbsolutePivotPointToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46550

getAbsolutePosition

getAbsolutePosition(): Vector3
Returns the mesh absolute position in the World.

Returns Vector3
a Vector3.
Inherited from AbstractMesh.getAbsolutePosition
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46462

getAnimationByName

getAnimationByName(name: string): Nullable<Animation>
Get an animation by name
Parameters
- name: string
  defines the name of the animation to look for
Returns Nullable<Animation>
null if not found else the requested animation
Inherited from AbstractMesh.getAnimationByName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4728

getAnimationRange

getAnimationRange(name: string): Nullable<AnimationRange>
Get an animation range by name
Parameters
- name: string
  defines the name of the animation range to look for
Returns Nullable<AnimationRange>
null if not found else the requested animation range
Inherited from AbstractMesh.getAnimationRange
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4747

getAnimationRanges

getAnimationRanges(): Nullable<AnimationRange>[]
Gets the list of all animation ranges defined on this node

Returns Nullable<AnimationRange>[]
an array
Inherited from AbstractMesh.getAnimationRanges
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4760

getBehaviorByName

getBehaviorByName(name: string): Nullable<Behavior<Node>>
Gets an attached behavior by name
Parameters
- name: string
  defines the name of the behavior to look for
Returns Nullable<Behavior<Node>>
null if behavior was not found else the requested behavior

See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors
Inherited from AbstractMesh.getBehaviorByName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4605

getBoundingInfo

getBoundingInfo(): BoundingInfo
Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined. Note that it returns a shallow bounding of the mesh (i.e. it does not include children). However, if the mesh contains thin instances, it will be expanded to include them. If you want the "raw" bounding data instead, then use getRawBoundingInfo(). To get the full bounding of all children, call getHierarchyBoundingVectors instead.

Returns BoundingInfo
a BoundingInfo
Inherited from AbstractMesh.getBoundingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52624

getChildMeshes

getChildMeshes<T extends AbstractMesh>(
directDescendantsOnly?: boolean,
predicate?: (node: Node) => node is T,
): T[]
Get all child-meshes of this node
Type Parameters
- T extends AbstractMesh
Parameters
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: false)
- Optionalpredicate: (node: Node) => node is T
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
Returns T[]
an array of AbstractMesh
Inherited from AbstractMesh.getChildMeshes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4697
getChildMeshes(
directDescendantsOnly?: boolean,
predicate?: (node: Node) => boolean,
): AbstractMesh[]
Get all child-meshes of this node
Parameters
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: false)
- Optionalpredicate: (node: Node) => boolean
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
Returns AbstractMesh[]
an array of AbstractMesh
Inherited from AbstractMesh.getChildMeshes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4704

getChildren

getChildren<T extends Node>(
predicate?: (node: Node) => node is T,
directDescendantsOnly?: boolean,
): T[]
Get all direct children of this node
Type Parameters
- T extends Node
Parameters
- Optionalpredicate: (node: Node) => node is T
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: true)
Returns T[]
an array of Node
Inherited from AbstractMesh.getChildren
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4711
getChildren(
predicate?: (node: Node) => boolean,
directDescendantsOnly?: boolean,
): Node[]
Get all direct children of this node
Parameters
- Optionalpredicate: (node: Node) => boolean
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: true)
Returns Node[]
an array of Node
Inherited from AbstractMesh.getChildren
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4718

getChildTransformNodes

getChildTransformNodes(
directDescendantsOnly?: boolean,
predicate?: (node: Node) => boolean,
): TransformNode[]
Get all child-transformNodes of this node
Parameters
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
- Optionalpredicate: (node: Node) => boolean
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
Returns TransformNode[]
an array of TransformNode
Inherited from AbstractMesh.getChildTransformNodes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46735

getClassName

getClassName(): string
Returns string
the string "InstancedMesh".
Overrides AbstractMesh.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50472

getClosestFacetAtCoordinates

getClosestFacetAtCoordinates(
    x: number,
    y: number,
    z: number,
    projected?: Vector3,
    checkFace?: boolean,
    facing?: boolean,
): Nullable<number>
Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
Parameters
- x: number
  defines x coordinate
- y: number
  defines y coordinate
- z: number
  defines z coordinate
- Optionalprojected: Vector3
  sets as the (x,y,z) world projection on the facet
- OptionalcheckFace: boolean
  if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
- Optionalfacing: boolean
  if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
Returns Nullable<number>
the face index if found (or null instead)

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData
Inherited from AbstractMesh.getClosestFacetAtCoordinates
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52962

getClosestFacetAtLocalCoordinates

getClosestFacetAtLocalCoordinates(
    x: number,
    y: number,
    z: number,
    projected?: Vector3,
    checkFace?: boolean,
    facing?: boolean,
): Nullable<number>
Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
Parameters
- x: number
  defines x coordinate
- y: number
  defines y coordinate
- z: number
  defines z coordinate
- Optionalprojected: Vector3
  sets as the (x,y,z) local projection on the facet
- OptionalcheckFace: boolean
  if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
- Optionalfacing: boolean
  if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
Returns Nullable<number>
the face index if found (or null instead)

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData
Inherited from AbstractMesh.getClosestFacetAtLocalCoordinates
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52974

getConnectedParticleSystems

getConnectedParticleSystems(): IParticleSystem[]
This function returns all of the particle systems in the scene that use the mesh as an emitter.

Returns IParticleSystem[]
an array of particle systems in the scene that use the mesh as an emitter
Inherited from AbstractMesh.getConnectedParticleSystems
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53034

getDescendants

getDescendants<T extends Node>(
directDescendantsOnly?: boolean,
predicate?: (node: Node) => node is T,
): T[]
Will return all nodes that have this node as ascendant
Type Parameters
- T extends Node
Parameters
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
- Optionalpredicate: (node: Node) => node is T
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
Returns T[]
all children nodes of all types
Inherited from AbstractMesh.getDescendants
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4683
getDescendants(
directDescendantsOnly?: boolean,
predicate?: (node: Node) => boolean,
): Node[]
Will return all nodes that have this node as ascendant
Parameters
- OptionaldirectDescendantsOnly: boolean
  defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
- Optionalpredicate: (node: Node) => boolean
  defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
Returns Node[]
all children nodes of all types
Inherited from AbstractMesh.getDescendants
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4690

getDirection

getDirection(localAxis: Vector3): Vector3
Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh. This Vector3 is expressed in the World space.
Parameters
- localAxis: Vector3
  axis to rotate
Returns Vector3
a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
Inherited from AbstractMesh.getDirection
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46503

getDirectionToRef

getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode
Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh. localAxis is expressed in the mesh local space. result is computed in the World space from the mesh World matrix.
Parameters
- localAxis: Vector3
  axis to rotate
- result: Vector3
  the resulting transformnode
Returns TransformNode
this TransformNode.
Inherited from AbstractMesh.getDirectionToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46512

getDistanceToCamera

getDistanceToCamera(camera?: Nullable<Camera>): number
Returns the distance from the mesh to the active camera
Parameters
- Optionalcamera: Nullable<Camera>
  defines the camera to use
Returns number
the distance
Inherited from AbstractMesh.getDistanceToCamera
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46706

getEngine

getEngine(): AbstractEngine
Gets the engine of the node

Returns AbstractEngine
a Engine
Inherited from AbstractMesh.getEngine
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4577

getFacetDataParameters

getFacetDataParameters(): any
Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()

Returns any
the parameters

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData
Inherited from AbstractMesh.getFacetDataParameters
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52980

getFacetLocalNormals

getFacetLocalNormals(): Vector3[]
Returns the facetLocalNormals array. The normals are expressed in the mesh local spac

Returns Vector3[]
an array of Vector3

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData
Inherited from AbstractMesh.getFacetLocalNormals
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52896

getFacetLocalPartitioning

getFacetLocalPartitioning(): number[][]
Returns the facetLocalPartitioning array

Returns number[][]
an array of array of numbers

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData
Inherited from AbstractMesh.getFacetLocalPartitioning
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52909

getFacetLocalPositions

getFacetLocalPositions(): Vector3[]
Returns the facetLocalPositions array. The facet positions are expressed in the mesh local space

Returns Vector3[]
an array of Vector3

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData
Inherited from AbstractMesh.getFacetLocalPositions
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52903

getFacetNormal

getFacetNormal(i: number): Vector3
Returns the i-th facet normal in the world system. This method allocates a new Vector3 per call
Parameters
- i: number
  defines the facet index
Returns Vector3
a new Vector3

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData
Inherited from AbstractMesh.getFacetNormal
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52933

getFacetNormalToRef

getFacetNormalToRef(i: number, ref: Vector3): this
Sets the reference Vector3 with the i-th facet normal in the world system
Parameters
- i: number
  defines the facet index
- ref: Vector3
  defines the target vector
Returns this
the current mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData
Inherited from AbstractMesh.getFacetNormalToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52941

getFacetPosition

getFacetPosition(i: number): Vector3
Returns the i-th facet position in the world system. This method allocates a new Vector3 per call
Parameters
- i: number
  defines the facet index
Returns Vector3
a new Vector3

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData
Inherited from AbstractMesh.getFacetPosition
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52917

getFacetPositionToRef

getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh
Sets the reference Vector3 with the i-th facet position in the world system
Parameters
- i: number
  defines the facet index
- ref: Vector3
  defines the target vector
Returns AbstractMesh
the current mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData
Inherited from AbstractMesh.getFacetPositionToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52925

getFacetsAtLocalCoordinates

getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>
Returns the facets (in an array) in the same partitioning block than the one the passed coordinates are located (expressed in the mesh local system)
Parameters
- x: number
  defines x coordinate
- y: number
  defines y coordinate
- z: number
  defines z coordinate
Returns Nullable<number[]>
the array of facet indexes

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData
Inherited from AbstractMesh.getFacetsAtLocalCoordinates
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52950

getHierarchyBoundingVectors

getHierarchyBoundingVectors(
includeDescendants?: boolean,
predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>,
): { max: Vector3; min: Vector3 }
Return the minimum and maximum world vectors of the entire hierarchy under current node
Parameters
- OptionalincludeDescendants: boolean
  Include bounding info from descendants as well (true by default)
- Optionalpredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>
  defines a callback function that can be customize to filter what meshes should be included in the list used to compute the bounding vectors
Returns { max: Vector3; min: Vector3 }
the new bounding vectors
Inherited from AbstractMesh.getHierarchyBoundingVectors
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4800

getIndices

getIndices(): Nullable<IndicesArray>
Returns Nullable<IndicesArray>
an array of indices (IndicesArray).
Overrides AbstractMesh.getIndices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50637

getLOD

getLOD(camera: Camera): AbstractMesh
Returns the current associated LOD AbstractMesh.
Parameters
- camera: Camera
  defines the camera to use to pick the LOD level
Returns AbstractMesh
a Mesh or null if no LOD is associated with the AbstractMesh
Overrides AbstractMesh.getLOD
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50655

getMaterialForRenderPass

getMaterialForRenderPass(renderPassId: number): undefined | Material
Gets the material used to render the mesh in a specific render pass
Parameters
- renderPassId: number
  render pass id
Returns undefined | Material
material used for the render pass. If no specific material is used for this render pass, undefined is returned (meaning mesh.material is used for this pass)
Inherited from AbstractMesh.getMaterialForRenderPass
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52272

getMeshUniformBuffer

getMeshUniformBuffer(): UniformBuffer
Gets the mesh uniform buffer.

Returns UniformBuffer
the uniform buffer of the mesh.
Inherited from AbstractMesh.getMeshUniformBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52457

getNormalsData

getNormalsData(
applySkeleton?: boolean,
applyMorph?: boolean,
): Nullable<FloatArray>
Get the normals vertex data and optionally apply skeleton and morphing.
Parameters
- OptionalapplySkeleton: boolean
  defines whether to apply the skeleton
- OptionalapplyMorph: boolean
  defines whether to apply the morph target
Returns Nullable<FloatArray>
the normals data
Inherited from AbstractMesh.getNormalsData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52766

getPhysicsBody

getPhysicsBody(): Nullable<PhysicsBody>
Returns Nullable<PhysicsBody>
Inherited from AbstractMesh.getPhysicsBody
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27257

getPhysicsImpostor

getPhysicsImpostor(): Nullable<PhysicsImpostor>
Gets the current physics impostor

Returns Nullable<PhysicsImpostor>
a physics impostor or null

See
https://doc.babylonjs.com/features/featuresDeepDive/physics
Inherited from AbstractMesh.getPhysicsImpostor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:30765

getPivotMatrix

getPivotMatrix(): Matrix
Returns the mesh pivot matrix. Default : Identity.

Returns Matrix
the matrix
Inherited from AbstractMesh.getPivotMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46428

getPivotPoint

getPivotPoint(): Vector3
Returns a new Vector3 set with the mesh pivot point coordinates in the local space.

Returns Vector3
the pivot point
Inherited from AbstractMesh.getPivotPoint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46533

getPivotPointToRef

getPivotPointToRef(result: Vector3): TransformNode
Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
Parameters
- result: Vector3
  the vector3 to store the result
Returns TransformNode
this TransformNode.
Inherited from AbstractMesh.getPivotPointToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46539

getPoseMatrix

getPoseMatrix(): Matrix
Returns the mesh Pose matrix.

Returns Matrix
the pose matrix
Inherited from AbstractMesh.getPoseMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46390

getPositionData

getPositionData(
    applySkeleton?: boolean,
    applyMorph?: boolean,
    data?: Nullable<FloatArray>,
): Nullable<FloatArray>
Get the position vertex data and optionally apply skeleton and morphing.
Parameters
- OptionalapplySkeleton: boolean
  defines whether to apply the skeleton
- OptionalapplyMorph: boolean
  defines whether to apply the morph target
- Optionaldata: Nullable<FloatArray>
  defines the position data to apply the skeleton and morph to
Returns Nullable<FloatArray>
the position data
Inherited from AbstractMesh.getPositionData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52774

getPositionExpressedInLocalSpace

getPositionExpressedInLocalSpace(): Vector3
Returns the mesh position in the local space from the current World matrix values.

Returns Vector3
a new Vector3.
Inherited from AbstractMesh.getPositionExpressedInLocalSpace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46479

getPositionInCameraSpace

getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3
Gets the position of the current mesh in camera space
Parameters
- Optionalcamera: Nullable<Camera>
  defines the camera to use
Returns Vector3
a position
Inherited from AbstractMesh.getPositionInCameraSpace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46700

getRawBoundingInfo

getRawBoundingInfo(): BoundingInfo
Returns the bounding info unnafected by instance data.

Returns BoundingInfo
the bounding info of the mesh unaffected by instance data.
Inherited from AbstractMesh.getRawBoundingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52629

getScene

getScene(): Scene
Gets the scene of the node

Returns Scene
a scene
Inherited from AbstractMesh.getScene
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4572

getTotalIndices

getTotalIndices(): number
Returns a positive integer : the total number of indices in this mesh geometry.

Returns number
the number of indices or zero if the mesh has no geometry.
Overrides AbstractMesh.getTotalIndices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50511

getTotalVertices

getTotalVertices(): number
Returns number
the total number of vertices (integer).
Overrides AbstractMesh.getTotalVertices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50506

getVerticesData

getVerticesData(
    kind: string,
    copyWhenShared?: boolean,
    forceCopy?: boolean,
): Nullable<FloatArray>
Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
Parameters
- kind: string
  kind of verticies to retrieve (eg. positions, normals, uvs, etc.)
- OptionalcopyWhenShared: boolean
  If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
- OptionalforceCopy: boolean
  defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
Returns Nullable<FloatArray>
a float array or a Float32Array of the requested kind of data : positions, normals, uvs, etc.
Overrides AbstractMesh.getVerticesData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50540

getWorldMatrix

getWorldMatrix(): Matrix
Gets the current world matrix

Returns Matrix
a Matrix
Overrides AbstractMesh.getWorldMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50648

instantiateHierarchy

instantiateHierarchy(
    newParent?: Nullable<TransformNode>,
    options?: {
        doNotInstantiate: boolean | (node: TransformNode) => boolean;
        newSourcedMesh?: Mesh;
    },
    onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void,
): Nullable<TransformNode>
Instantiate (when possible) or clone that node with its hierarchy
Parameters
- OptionalnewParent: Nullable<TransformNode>
  defines the new parent to use for the instance (or clone)
- Optionaloptions: {
  doNotInstantiate: boolean | (node: TransformNode) => boolean;
  newSourcedMesh?: Mesh;
  }
  defines options to configure how copy is done
  - doNotInstantiate: boolean | (node: TransformNode) => boolean
    defines if the model must be instantiated or just cloned
  - OptionalnewSourcedMesh?: Mesh
    newSourcedMesh the new source mesh for the instance (or clone)
- OptionalonNewNodeCreated: (source: TransformNode, clone: TransformNode) => void
  defines an option callback to call when a clone or an instance is created
Returns Nullable<TransformNode>
an instance (or a clone) of the current node with its hierarchy
Overrides AbstractMesh.instantiateHierarchy
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50697

intersects

intersects(
    ray: Ray,
    fastCheck?: boolean,
    trianglePredicate?: TrianglePickingPredicate,
    onlyBoundingInfo?: boolean,
    worldToUse?: Matrix,
    skipBoundingInfo?: boolean,
): PickingInfo
Checks if the passed Ray intersects with the mesh. A mesh triangle can be picked both from its front and back sides, irrespective of orientation.
Parameters
- ray: Ray
  defines the ray to use. It should be in the mesh's LOCAL coordinate space.
- OptionalfastCheck: boolean
  defines if fast mode (but less precise) must be used (false by default)
- OptionaltrianglePredicate: TrianglePickingPredicate
  defines an optional predicate used to select faces when a mesh intersection is detected
- OptionalonlyBoundingInfo: boolean
  defines a boolean indicating if picking should only happen using bounding info (false by default)
- OptionalworldToUse: Matrix
  defines the world matrix to use to get the world coordinate of the intersection point
- OptionalskipBoundingInfo: boolean
  a boolean indicating if we should skip the bounding info check
Returns PickingInfo
the picking info

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/interactions/mesh_intersect
Inherited from AbstractMesh.intersects
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52859

intersectsMesh

intersectsMesh(
    mesh: AbstractMesh | SolidParticle,
    precise?: boolean,
    includeDescendants?: boolean,
): boolean
True if the mesh intersects another mesh or a SolidParticle object
Parameters
- mesh: AbstractMesh | SolidParticle
  defines a target mesh or SolidParticle to test
- Optionalprecise: boolean
  Unless the parameter precise is set to true the intersection is computed according to Axis Aligned Bounding Boxes (AABB), else according to OBB (Oriented BBoxes)
- OptionalincludeDescendants: boolean
  Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
Returns boolean
true if there is an intersection
Inherited from AbstractMesh.intersectsMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52804

intersectsPoint

intersectsPoint(point: Vector3): boolean
Returns true if the passed point (Vector3) is inside the mesh bounding box
Parameters
- point: Vector3
  defines the point to test
Returns boolean
true if there is an intersection
Inherited from AbstractMesh.intersectsPoint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52810

isCompletelyInFrustum

isCompletelyInFrustum(frustumPlanes: Plane[]): boolean
Returns true if the mesh is completely in the frustum defined be the passed array of planes. A mesh is completely in the frustum if its bounding box it completely inside the frustum.
Parameters
- frustumPlanes: Plane[]
  defines the frustum to test
Returns boolean
true if the mesh is completely in the frustum planes
Inherited from AbstractMesh.isCompletelyInFrustum
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52796

isDescendantOf

isDescendantOf(ancestor: Node): boolean
Is this node a descendant of the given node? The function will iterate up the hierarchy until the ancestor was found or no more parents defined
Parameters
- ancestor: Node
  defines the parent node to inspect
Returns boolean
a boolean indicating if this node is a descendant of the given node
Inherited from AbstractMesh.isDescendantOf
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4672

isDisposed

isDisposed(): boolean
Gets a boolean indicating if the node has been disposed

Returns boolean
true if the node was disposed
Inherited from AbstractMesh.isDisposed
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4516

isEnabled

isEnabled(checkAncestors?: boolean): boolean
Is this node enabled? If the node has a parent, all ancestors will be checked and false will be returned if any are false (not enabled), otherwise will return true
Parameters
- OptionalcheckAncestors: boolean
  indicates if this method should check the ancestors. The default is to check the ancestors. If set to false, the method will return the value of this node without checking ancestors
Returns boolean
whether this node (and its parent) is enabled
Inherited from AbstractMesh.isEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4658

isInFrustum

isInFrustum(frustumPlanes: Plane[]): boolean
Returns true if the mesh is within the frustum defined by the passed array of planes. A mesh is in the frustum if its bounding box intersects the frustum
Parameters
- frustumPlanes: Plane[]
  defines the frustum to test
Returns boolean
true if the mesh is in the frustum planes
Inherited from AbstractMesh.isInFrustum
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52789

isReady

isReady(completeCheck?: boolean): boolean
Is this node ready to be used/rendered
Parameters
- OptionalcompleteCheck: boolean
  defines if a complete check (including materials and lights) has to be done (false by default)
Returns boolean
is it ready
Overrides AbstractMesh.isReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50532

isUsingPivotMatrix

isUsingPivotMatrix(): boolean
return true if a pivot has been set

Returns boolean
true if a pivot matrix is used
Inherited from AbstractMesh.isUsingPivotMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46341

isUsingPostMultiplyPivotMatrix

isUsingPostMultiplyPivotMatrix(): boolean
Returns boolean
true if pivot matrix must be cancelled in the world matrix. When this parameter is set to true (default), the inverse of the pivot matrix is also applied at the end to cancel the transformation effect.
Inherited from AbstractMesh.isUsingPostMultiplyPivotMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46345

isVerticesDataPresent

isVerticesDataPresent(kind: string): boolean
Boolean : True if the mesh owns the requested kind of data.
Parameters
- kind: string
  defines which buffer to check (positions, indices, normals, etc). Possible kind values :
  
  VertexBuffer.PositionKind
  
  VertexBuffer.UVKind
  
  VertexBuffer.UV2Kind
  
  VertexBuffer.UV3Kind
  
  VertexBuffer.UV4Kind
  
  VertexBuffer.UV5Kind
  
  VertexBuffer.UV6Kind
  
  VertexBuffer.ColorKind
  
  VertexBuffer.MatricesIndicesKind
  
  VertexBuffer.MatricesIndicesExtraKind
  
  VertexBuffer.MatricesWeightsKind
  
  VertexBuffer.MatricesWeightsExtraKind
Returns boolean
true if data kind is present
Overrides AbstractMesh.isVerticesDataPresent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50633

isWorldMatrixCameraDependent

isWorldMatrixCameraDependent(): boolean
Returns whether the transform node world matrix computation needs the camera information to be computed. This is the case when the node is a billboard or has an infinite distance for instance.

Returns boolean
true if the world matrix computation needs the camera information to be computed
Inherited from AbstractMesh.isWorldMatrixCameraDependent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46668

locallyTranslate

locallyTranslate(vector3: Vector3): TransformNode
Translates the mesh along the passed Vector3 in its local space.
Parameters
- vector3: Vector3
  the distance to translate in localspace
Returns TransformNode
the TransformNode.
Inherited from AbstractMesh.locallyTranslate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46485

lookAt

lookAt(
    targetPoint: Vector3,
    yawCor?: number,
    pitchCor?: number,
    rollCor?: number,
    space?: Space,
): TransformNode
Orients a mesh towards a target point. Mesh must be drawn facing user.
Parameters
- targetPoint: Vector3
  the position (must be in same space as current mesh) to look at
- OptionalyawCor: number
  optional yaw (y-axis) correction in radians
- OptionalpitchCor: number
  optional pitch (x-axis) correction in radians
- OptionalrollCor: number
  optional roll (z-axis) correction in radians
- Optionalspace: Space
  the chosen space of the target
Returns TransformNode
the TransformNode.
Inherited from AbstractMesh.lookAt
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46496

markAsDirty

markAsDirty(property?: string): AbstractMesh
Flag the AbstractMesh as dirty (Forcing it to update everything)
Parameters
- Optionalproperty: string
  if set to "rotation" the objects rotationQuaternion will be set to null
Returns AbstractMesh
this AbstractMesh
Inherited from AbstractMesh.markAsDirty
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52507

movePOV

movePOV(
    amountRight: number,
    amountUp: number,
    amountForward: number,
): AbstractMesh
Perform relative position change from the point of view of behind the front of the mesh. This is performed taking into account the meshes current rotation, so you do not have to care. Supports definition of mesh facing forward or backward definedFacingForwardSearch | See definedFacingForwardSearch.
Parameters
- amountRight: number
  defines the distance on the right axis
- amountUp: number
  defines the distance on the up axis
- amountForward: number
  defines the distance on the forward axis
Returns AbstractMesh
the current mesh
Inherited from AbstractMesh.movePOV
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52702

moveWithCollisions

moveWithCollisions(
displacement: Vector3,
slideOnCollide?: boolean,
): AbstractMesh
Move the mesh using collision engine
Parameters
- displacement: Vector3
  defines the requested displacement vector
- OptionalslideOnCollide: boolean
  If true, the mesh will slide along a collider's surface. If false, it will stop moving at the first collision. (true by default)
Returns AbstractMesh
the current mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/cameras/camera_collisions
Inherited from AbstractMesh.moveWithCollisions
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52829

normalizeToUnitCube

normalizeToUnitCube(
    includeDescendants?: boolean,
    ignoreRotation?: boolean,
    predicate?: Nullable<(node: AbstractMesh) => boolean>,
): AbstractMesh
Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
Parameters
- OptionalincludeDescendants: boolean
  Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
- OptionalignoreRotation: boolean
  ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
- Optionalpredicate: Nullable<(node: AbstractMesh) => boolean>
  predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
Returns AbstractMesh
the current mesh
Inherited from AbstractMesh.normalizeToUnitCube
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52655

optimizeIndicesAsync

optimizeIndicesAsync(): Promise<AbstractMesh>
Optimize the indices order so that we keep the faces with similar indices together

Returns Promise<AbstractMesh>
the current mesh
Inherited from AbstractMesh.optimizeIndicesAsync
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53005

refreshBoundingInfo

refreshBoundingInfo(
applySkeletonOrOptions?: boolean | IMeshDataOptions,
applyMorph?: boolean,
): InstancedMesh
This method recomputes and sets a new BoundingInfo to the mesh unless it is locked. This means the mesh underlying bounding box and sphere are recomputed.
Parameters
- OptionalapplySkeletonOrOptions: boolean | IMeshDataOptions
- OptionalapplyMorph: boolean
Returns InstancedMesh
the current mesh
Overrides AbstractMesh.refreshBoundingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50639

registerAfterWorldMatrixUpdate

registerAfterWorldMatrixUpdate(
func: (mesh: TransformNode) => void,
): TransformNode
If you'd like to be called back after the mesh position, rotation or scaling has been updated.
Parameters
- func: (mesh: TransformNode) => void
  callback function to add
Returns TransformNode
the TransformNode.
Inherited from AbstractMesh.registerAfterWorldMatrixUpdate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46688

releaseSubMeshes

releaseSubMeshes(immediate?: boolean): AbstractMesh
Disposes all the submeshes of the current mesh
Parameters
- Optionalimmediate: boolean
  should dispose the effects immediately or not
Returns AbstractMesh
the current mesh
Inherited from AbstractMesh.releaseSubMeshes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52873

removeBehavior

removeBehavior(behavior: Behavior<Node>): Node
Remove an attached behavior
Parameters
- behavior: Behavior<Node>
  defines the behavior to attach
Returns Node
the current Node

See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors
Inherited from AbstractMesh.removeBehavior
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4593

removeChild

removeChild(mesh: TransformNode, preserveScalingSign?: boolean): this
Removes the passed mesh from the current mesh children list
Parameters
- mesh: TransformNode
  defines the child mesh
- OptionalpreserveScalingSign: boolean
  if true, keep scaling sign of child. Otherwise, scaling sign might change.
Returns this
the current mesh
Inherited from AbstractMesh.removeChild
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46586

resetDrawCache

resetDrawCache(passId?: number, immediate?: boolean): void
Resets the draw wrappers cache for all submeshes of this abstract mesh
Parameters
- OptionalpassId: number
  If provided, releases only the draw wrapper corresponding to this render pass id
- Optionalimmediate: boolean
  If true, the effect will be released immediately, otherwise it will be released at the next frame
Returns void
Inherited from AbstractMesh.resetDrawCache
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52513

resetLocalMatrix

resetLocalMatrix(independentOfChildren?: boolean): void
Resets this nodeTransform's local matrix to Matrix.Identity().
Parameters
- OptionalindependentOfChildren: boolean
  indicates if all child nodeTransform's world-space transform should be preserved.
Returns void
Inherited from AbstractMesh.resetLocalMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46680

rotate

rotate(axis: Vector3, amount: number, space?: Space): TransformNode
Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space. space (default LOCAL) can be either Space.LOCAL, either Space.WORLD. Note that the property rotationQuaternion is then automatically updated and the property rotation is set to (0,0,0) and no longer used. The passed axis is also normalized.
Parameters
- axis: Vector3
  the axis to rotate around
- amount: number
  the amount to rotate in radians
- Optionalspace: Space
  Space to rotate in (Default: local)
Returns TransformNode
the TransformNode.
Inherited from AbstractMesh.rotate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46620

rotateAround

rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode
Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space. Note that the property rotationQuaternion is then automatically updated and the property rotation is set to (0,0,0) and no longer used. The passed axis is also normalized. . Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
Parameters
- point: Vector3
  the point to rotate around
- axis: Vector3
  the axis to rotate around
- amount: number
  the amount to rotate in radians
Returns TransformNode
the TransformNode
Inherited from AbstractMesh.rotateAround
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46631

rotatePOV

rotatePOV(
    flipBack: number,
    twirlClockwise: number,
    tiltRight: number,
): AbstractMesh
Perform relative rotation change from the point of view of behind the front of the mesh. Supports definition of mesh facing forward or backward definedFacingForwardSearch | See definedFacingForwardSearch.
Parameters
- flipBack: number
  defines the flip
- twirlClockwise: number
  defines the twirl
- tiltRight: number
  defines the tilt
Returns AbstractMesh
the current mesh
Inherited from AbstractMesh.rotatePOV
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52721

serialize

serialize(currentSerializationObject?: any): any
Serializes the objects information.
Parameters
- OptionalcurrentSerializationObject: any
  defines the object to serialize in
Returns any
the serialized object
Inherited from AbstractMesh.serialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46720

serializeAnimationRanges

serializeAnimationRanges(): any
Serialize animation ranges into a JSON compatible object

Returns any
serialization object
Inherited from AbstractMesh.serializeAnimationRanges
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4774

setAbsolutePosition

setAbsolutePosition(absolutePosition: Vector3): TransformNode
Sets the mesh absolute position in the World from a Vector3 or an Array(3).
Parameters
- absolutePosition: Vector3
  the absolute position to set
Returns TransformNode
the TransformNode.
Inherited from AbstractMesh.setAbsolutePosition
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46468

setBoundingInfo

setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh
Overwrite the current bounding info
Parameters
- boundingInfo: BoundingInfo
  defines the new bounding info
Returns AbstractMesh
the current mesh
Inherited from AbstractMesh.setBoundingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52635

setDirection

setDirection(
    localAxis: Vector3,
    yawCor?: number,
    pitchCor?: number,
    rollCor?: number,
): TransformNode
Sets this transform node rotation to the given local axis.
Parameters
- localAxis: Vector3
  the axis in local space
- OptionalyawCor: number
  optional yaw (y-axis) correction in radians
- OptionalpitchCor: number
  optional pitch (x-axis) correction in radians
- OptionalrollCor: number
  optional roll (z-axis) correction in radians
Returns TransformNode
this TransformNode
Inherited from AbstractMesh.setDirection
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46521

setEnabled

setEnabled(value: boolean): void
Set the enabled state of this node
Parameters
- value: boolean
  defines the new enabled state
Returns void
Inherited from AbstractMesh.setEnabled
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4665

setIndices

setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh
Sets the mesh indices. Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array). If the mesh has no geometry, a new Geometry object is created and set to the mesh. This method creates a new index buffer each call. Returns the Mesh.
Parameters
- indices: IndicesArray
  the source data
- OptionaltotalVertices: Nullable<number>
  defines the total number of vertices referenced by indices (could be null)
Returns Mesh
source mesh
Overrides AbstractMesh.setIndices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50615

setMaterialForRenderPass

setMaterialForRenderPass(renderPassId: number, material?: Material): void
Sets the material to be used to render the mesh in a specific render pass
Parameters
- renderPassId: number
  render pass id
- Optionalmaterial: Material
  material to use for this render pass. If undefined is passed, no specific material will be used for this render pass but the regular material will be used instead (mesh.material)
Returns void
Inherited from AbstractMesh.setMaterialForRenderPass
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52278

setParent

setParent(
    node: Nullable<Node>,
    preserveScalingSign?: boolean,
    updatePivot?: boolean,
): TransformNode
Defines the passed node as the parent of the current node. The node will remain exactly where it is and its position / rotation will be updated accordingly. If you don't want to preserve the current rotation / position, assign the parent through parent accessor. Note that if the mesh has a pivot matrix / point defined it will be applied after the parent was updated. In that case the node will not remain in the same space as it is, as the pivot will be applied. To avoid this, you can set updatePivot to true and the pivot will be updated to identity
Parameters
- node: Nullable<Node>
  the node ot set as the parent
- OptionalpreserveScalingSign: boolean
  if true, keep scaling sign of child. Otherwise, scaling sign might change.
- OptionalupdatePivot: boolean
  if true, update the pivot matrix to keep the node in the same space as before
Returns TransformNode
this TransformNode.

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/transforms/parent_pivot/parent
Inherited from AbstractMesh.setParent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46570

setPhysicsLinkWith

setPhysicsLinkWith(
    otherMesh: Mesh,
    pivot1: Vector3,
    pivot2: Vector3,
    options?: any,
): AbstractMesh
Creates a physic joint between two meshes
Parameters
- otherMesh: Mesh
  defines the other mesh to use
- pivot1: Vector3
  defines the pivot to use on this mesh
- pivot2: Vector3
  defines the pivot to use on the other mesh
- Optionaloptions: any
  defines additional options (can be plugin dependent)
Returns AbstractMesh
the current mesh

See
https://www.babylonjs-playground.com/#0BS5U0#0
Inherited from AbstractMesh.setPhysicsLinkWith
- Defined in .temp/typedoc/docdirectory/doc.d.ts:30782

setPivotMatrix

setPivotMatrix(
matrix: DeepImmutableObject<Matrix>,
postMultiplyPivotMatrix?: boolean,
): TransformNode
Sets a new pivot matrix to the current node
Parameters
- matrix: DeepImmutableObject<Matrix>
  defines the new pivot matrix to use
- OptionalpostMultiplyPivotMatrix: boolean
  defines if the pivot matrix must be cancelled in the world matrix. When this parameter is set to true (default), the inverse of the pivot matrix is also applied at the end to cancel the transformation effect
Returns TransformNode
the current TransformNode
Inherited from AbstractMesh.setPivotMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46422

setPivotPoint

setPivotPoint(point: Vector3, space?: Space): TransformNode
Sets a new pivot point to the current node
Parameters
- point: Vector3
  defines the new pivot point to use
- Optionalspace: Space
  defines if the point is in world or local space (local by default)
Returns TransformNode
the current TransformNode
Inherited from AbstractMesh.setPivotPoint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46528

setPositionWithLocalVector

setPositionWithLocalVector(vector3: Vector3): TransformNode
Sets the mesh position in its local space.
Parameters
- vector3: Vector3
  the position to set in localspace
Returns TransformNode
the TransformNode.
Inherited from AbstractMesh.setPositionWithLocalVector
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46474

setPreTransformMatrix

setPreTransformMatrix(matrix: Matrix): TransformNode
Sets a new matrix to apply before all other transformation
Parameters
- matrix: Matrix
  defines the transform matrix
Returns TransformNode
the current TransformNode
Inherited from AbstractMesh.setPreTransformMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46415

setVerticesData

setVerticesData(
    kind: string,
    data: FloatArray,
    updatable?: boolean,
    stride?: number,
): AbstractMesh
Sets the vertex data of the mesh geometry for the requested kind. If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data. The data are either a numeric array either a Float32Array. The parameter updatable is passed as is to the underlying Geometry object constructor (if initially none) or updater. The parameter stride is an optional positive integer, it is usually automatically deducted from the kind (3 for positions or normals, 2 for UV, etc). Note that a new underlying VertexBuffer object is created each call. If the kind is the PositionKind, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.

Possible kind values :
- VertexBuffer.PositionKind
- VertexBuffer.UVKind
- VertexBuffer.UV2Kind
- VertexBuffer.UV3Kind
- VertexBuffer.UV4Kind
- VertexBuffer.UV5Kind
- VertexBuffer.UV6Kind
- VertexBuffer.ColorKind
- VertexBuffer.MatricesIndicesKind
- VertexBuffer.MatricesIndicesExtraKind
- VertexBuffer.MatricesWeightsKind
- VertexBuffer.MatricesWeightsExtraKind
Returns the Mesh.
Parameters
- kind: string
  defines vertex data kind
- data: FloatArray
  defines the data source
- Optionalupdatable: boolean
  defines if the data must be flagged as updatable (false as default)
- Optionalstride: number
  defines the vertex stride (optional)
Returns AbstractMesh
the current mesh
Overrides AbstractMesh.setVerticesData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50574

toString

toString(fullDetails?: boolean): string
Gets a string representation of the current mesh
Parameters
- OptionalfullDetails: boolean
  defines a boolean indicating if full details must be included
Returns string
a string representation of the current mesh
Inherited from AbstractMesh.toString
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52468

transferToEffect

transferToEffect(world: Matrix): void
Transfer the mesh values to its UBO.
Parameters
- world: Matrix
  The world matrix associated with the mesh
Returns void
Inherited from AbstractMesh.transferToEffect
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52452

translate

translate(axis: Vector3, distance: number, space?: Space): TransformNode
Translates the mesh along the axis vector for the passed distance in the given space. space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
Parameters
- axis: Vector3
  the axis to translate in
- distance: number
  the distance to translate
- Optionalspace: Space
  Space to rotate in (Default: local)
Returns TransformNode
the TransformNode.
Inherited from AbstractMesh.translate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46640

unfreezeWorldMatrix

unfreezeWorldMatrix(): this
Allows back the World matrix computation.

Returns this
the TransformNode.
Inherited from AbstractMesh.unfreezeWorldMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46453

unregisterAfterWorldMatrixUpdate

unregisterAfterWorldMatrixUpdate(
func: (mesh: TransformNode) => void,
): TransformNode
Removes a registered callback function.
Parameters
- func: (mesh: TransformNode) => void
  callback function to remove
Returns TransformNode
the TransformNode.
Inherited from AbstractMesh.unregisterAfterWorldMatrixUpdate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46694

updateFacetData

updateFacetData(): AbstractMesh
Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated. This method can be called within the render loop. You don't need to call this method by yourself in the render loop when you update/morph a mesh with the methods CreateXXX() as they automatically manage this computation

Returns AbstractMesh
the current mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/facetData
Inherited from AbstractMesh.updateFacetData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52889

updateIndices

updateIndices(
    indices: IndicesArray,
    offset?: number,
    gpuMemoryOnly?: boolean,
): AbstractMesh
Updates the AbstractMesh indices array
Parameters
- indices: IndicesArray
  defines the data source
- Optionaloffset: number
  defines the offset in the index buffer where to store the new data (can be null)
- OptionalgpuMemoryOnly: boolean
  defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
Returns AbstractMesh
the current mesh
Inherited from AbstractMesh.updateIndices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52994

updatePoseMatrix

updatePoseMatrix(matrix: Matrix): TransformNode
Copies the parameter passed Matrix into the mesh Pose matrix.
Parameters
- matrix: Matrix
  the matrix to copy the pose from
Returns TransformNode
this TransformNode.
Inherited from AbstractMesh.updatePoseMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46385

updateVerticesData

updateVerticesData(
    kind: string,
    data: FloatArray,
    updateExtends?: boolean,
    makeItUnique?: boolean,
): Mesh
Updates the existing vertex data of the mesh geometry for the requested kind. If the mesh has no geometry, it is simply returned as it is. The data are either a numeric array either a Float32Array. No new underlying VertexBuffer object is created. If the kind is the PositionKind and if updateExtends is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed. If the parameter makeItUnique is true, a new global geometry is created from this positions and is set to the mesh.

Possible kind values :
- VertexBuffer.PositionKind
- VertexBuffer.UVKind
- VertexBuffer.UV2Kind
- VertexBuffer.UV3Kind
- VertexBuffer.UV4Kind
- VertexBuffer.UV5Kind
- VertexBuffer.UV6Kind
- VertexBuffer.ColorKind
- VertexBuffer.MatricesIndicesKind
- VertexBuffer.MatricesIndicesExtraKind
- VertexBuffer.MatricesWeightsKind
- VertexBuffer.MatricesWeightsExtraKind
Returns the Mesh.
Parameters
- kind: string
  defines vertex data kind
- data: FloatArray
  defines the data source
- OptionalupdateExtends: boolean
  defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
- OptionalmakeItUnique: boolean
  defines it the updated vertex buffer must be flagged as unique (false by default)
Returns Mesh
the source mesh
Overrides AbstractMesh.updateVerticesData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50604

`Static`AddNodeConstructor

AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void
Add a new node constructor
Parameters
- type: string
  defines the type name of the node to construct
- constructorFunc: NodeConstructor
  defines the constructor function
Returns void
Inherited from AbstractMesh.AddNodeConstructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4418

`Static`Construct

Construct(
    type: string,
    name: string,
    scene: Scene,
    options?: any,
): Nullable<() => Node>
Returns a node constructor based on type name
Parameters
- type: string
  defines the type name
- name: string
  defines the new node name
- scene: Scene
  defines the hosting scene
- Optionaloptions: any
  defines optional options to transmit to constructors
Returns Nullable<() => Node>
the new constructor or null
Inherited from AbstractMesh.Construct
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4427

`Static`Parse

Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode
Returns a new TransformNode object parsed from the source provided.
Parameters
- parsedTransformNode: any
  is the source.
- scene: Scene
  the scene the object belongs to
- rootUrl: string
  is a string, it's the root URL to prefix the delayLoadingFile property with
Returns TransformNode
a new TransformNode object parsed from the source provided.
Inherited from AbstractMesh.Parse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46728

`Static`ParseAnimationRanges

ParseAnimationRanges(node: Node, parsedNode: any, _scene: Scene): void
Parse animation range data from a serialization object and store them into a given node
Parameters
- node: Node
  defines where to store the animation ranges
- parsedNode: any
  defines the serialization object to read data from
- _scene: Scene
  defines the hosting scene
Returns void
Inherited from AbstractMesh.ParseAnimationRanges
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4793

Class InstancedMesh

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns InstancedMesh

Properties

actionManager

See

alphaIndex

See

alwaysSelectAsActiveMesh

animations

cullingStrategy

customMarkAsDirty

decalMap

definedFacingForward

doNotSyncBoundingInfo

edgesColor

See

edgesRenderer

edgesWidth

See

ellipsoid

See

ellipsoidOffset

See

enablePointerMoveEvents

forceRenderingWhenOccluded

See

id

ignoreNonUniformScaling

inspectableCustomProperties

See

instancedBuffers

See

isBlocker

See

isNearGrabbable

isNearPickable

isOccluded

See

isOcclusionQueryInProgress

See

isPickable

metadata

name

occlusionQueryAlgorithmType

See

occlusionRetryCount

See

occlusionType

See

onAccessibilityTagChangedObservable

onAfterWorldMatrixUpdateObservable

onCollideObservable

onCollisionPositionChangeObservable

onDisposeObservable

onMaterialChangedObservable

onReady

onRebuildObservable

outlineColor

outlineWidth

overlayAlpha

overlayColor

physicsBody

See

physicsImpostor

See

reIntegrateRotationIntoRotationQuaternion

renderOutline

See

renderOverlay

See

reservedDataStore

`Static`BillboardUseParentOrientation

`Static` `Readonly`CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY

`Static` `Readonly`CULLINGSTRATEGY_OPTIMISTIC_INCLUSION

`Static` `Readonly`CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY

`Static` `Readonly`CULLINGSTRATEGY_STANDARD

`Static`OCCLUSION_ALGORITHM_TYPE_ACCURATE

`Static`OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE

`Static`OCCLUSION_TYPE_NONE

`Static`OCCLUSION_TYPE_OPTIMISTIC

`Static`OCCLUSION_TYPE_STRICT