LinesMesh | Babylon.js API documentation

Class LinesMesh

Line mesh

See

https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/param

Hierarchy (View Summary)

Mesh
- LinesMesh

Index

Constructors

constructor

new LinesMesh(
    name: string,
    scene?: Nullable<Scene>,
    parent?: Nullable<Node>,
    source?: Nullable<LinesMesh>,
    doNotCloneChildren?: boolean,
    useVertexColor?: boolean,
    useVertexAlpha?: boolean,
    material?: Material,
): LinesMesh
Creates a new LinesMesh
Parameters
- name: string
  defines the name
- Optionalscene: Nullable<Scene>
  defines the hosting scene
- Optionalparent: Nullable<Node>
  defines the parent mesh if any
- Optionalsource: Nullable<LinesMesh>
  defines the optional source LinesMesh used to clone data from
- OptionaldoNotCloneChildren: boolean
  When cloning, skip cloning child meshes of source, default False. When false, achieved by calling a clone(), also passing False. This will make creation of children, recursive.
- OptionaluseVertexColor: boolean
  defines if this LinesMesh supports vertex color
- OptionaluseVertexAlpha: boolean
  defines if this LinesMesh supports vertex alpha
- Optionalmaterial: Material
  material to use to draw the line. If not provided, will create a new one
Returns LinesMesh
Inherited from Mesh.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50106

Properties

actionManager

actionManager: Nullable<AbstractActionManager>

Gets or sets the current action manager

See

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

alpha

alpha: number

Alpha of the line (Default: 1)

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

color

color: Color3

Color of the line (Default: White)

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

delayLoadingFile

delayLoadingFile: string

Gets the file containing delay loading data for this mesh

delayLoadState

delayLoadState: number

Gets the delay loading state of the mesh (when delay loading is turned on)

See

https://doc.babylonjs.com/features/featuresDeepDive/importers/incrementalLoading

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

edgesShareWithInstances

edgesShareWithInstances: boolean

true to use the edge renderer for all instances of this 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

ignoreCameraMaxZ

ignoreCameraMaxZ: boolean

Gets or sets a boolean indicating whether to render ignoring the active camera's max z setting. (false by default) You should not mix meshes that have this property set to true with meshes that have it set to false if they all write to the depth buffer, because the z-values are not comparable in the two cases and you will get rendering artifacts if you do. You can set the property to true for meshes that do not write to the depth buffer, or set the same value (either false or true) otherwise. Note this will reduce performance when set to true.

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

instances

instances: InstancedMesh[]

Gets the list of instances created from this mesh it is not supposed to be modified manually. Note also that the order of the InstancedMesh wihin the array is not significant and might change.

See

https://doc.babylonjs.com/features/featuresDeepDive/mesh/copies/instances

intersectionThreshold

intersectionThreshold: number

The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray. This margin is expressed in world space coordinates, so its value may vary. Default value is 0.1

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

onLODLevelSelection

onLODLevelSelection: (
    distance: number,
    mesh: Mesh,
    selectedLevel: Nullable<Mesh>,
) => void

User defined function used to change how LOD level selection is done

See

https://doc.babylonjs.com/features/featuresDeepDive/mesh/LOD

onMaterialChangedObservable

onMaterialChangedObservable: Observable<AbstractMesh>

An event triggered when material is changed

onMeshReadyObservable

onMeshReadyObservable: Observable<Mesh>

Will notify when the mesh is completely ready, including materials. Observers added to this observable will be removed once triggered

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

thinInstanceAllowAutomaticStaticBufferRecreation

thinInstanceAllowAutomaticStaticBufferRecreation: boolean

Indicates that a buffer created as static should be recreated if the buffer is updated (by calling thinInstanceSetMatrixAt or thinInstanceSetAttributeAt, for eg.) If this flag is false (the default behavior), a buffer created as "static" won't show any update done to it, and will stay the same as it was created. Note however that recreating a buffer each time there's a change will have some performance cost, that's why it is set to false by default. You should set this flag to true only if your static buffers should change infrequently. If they change frequently, you should create your buffers as "dynamic" instead.

thinInstanceCount

thinInstanceCount: number

Gets / sets the number of thin instances to display. Note that you can't set a number higher than what the underlying buffer can handle.

thinInstanceEnablePicking

thinInstanceEnablePicking: boolean

Gets or sets a boolean defining if we want picking to pick thin instances as well

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)

`Optional` `Readonly`useVertexAlpha

useVertexAlpha?: boolean

If vertex alpha should be applied to the mesh

`Optional` `Readonly`useVertexColor

useVertexColor?: boolean

If vertex color should be applied to the mesh

`Static` `Readonly`BACKSIDE

BACKSIDE: 1

Mesh side orientation : usually the internal or back surface

`Static`BillboardUseParentOrientation

BillboardUseParentOrientation: boolean

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

`Static` `Readonly`BOTTOM

BOTTOM: 4

Mesh tile positioning : part tiles on bottom

`Static` `Readonly`CAP_ALL

CAP_ALL: 3

Mesh cap setting : two caps, one at the beginning and one at the end of the mesh

`Static` `Readonly`CAP_END

CAP_END: 2

Mesh cap setting : one cap at the end of the mesh

`Static` `Readonly`CAP_START

CAP_START: 1

Mesh cap setting : one cap at the beginning of the mesh

`Static` `Readonly`CENTER

CENTER: 0

Mesh tile positioning : part tiles same on left/right or top/bottom

`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` `Readonly`DEFAULTSIDE

DEFAULTSIDE: 0

Mesh side orientation : by default, FRONTSIDE

`Static` `Readonly`DOUBLESIDE

DOUBLESIDE: 2

Mesh side orientation : both internal and external or front and back surfaces

`Static` `Readonly`FLIP_N_ROTATE_ROW

FLIP_N_ROTATE_ROW: 6

Mesh pattern setting : rotate pattern and rotate

`Static` `Readonly`FLIP_N_ROTATE_TILE

FLIP_N_ROTATE_TILE: 5

Mesh pattern setting : flip and rotate alternate tiles on each row or column

`Static` `Readonly`FLIP_ROW

FLIP_ROW: 3

Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows

`Static` `Readonly`FLIP_TILE

FLIP_TILE: 1

Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column

`Static`ForceGLSL

ForceGLSL: boolean

Force all the LineMeshes to compile their default color material to glsl even on WebGPU engines. False by default. This is mostly meant for backward compatibility.

`Static` `Readonly`FRONTSIDE

FRONTSIDE: 0

Mesh side orientation : usually the external or front surface

`Static`INSTANCEDMESH_SORT_TRANSPARENT

INSTANCEDMESH_SORT_TRANSPARENT: boolean

Indicates that the instanced meshes should be sorted from back to front before rendering if their material is transparent

`Static` `Readonly`LEFT

LEFT: 1

Mesh tile positioning : part tiles on left

`Static` `Readonly`NO_CAP

NO_CAP: 0

Mesh cap setting : no cap

`Static` `Readonly`NO_FLIP

NO_FLIP: 0

Mesh pattern setting : no flip or rotate

`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

`Static` `Readonly`RIGHT

RIGHT: 2

Mesh tile positioning : part tiles on right

`Static` `Readonly`ROTATE_ROW

ROTATE_ROW: 4

Mesh pattern setting : rotate (180degs) all tiles on alternate rows

`Static` `Readonly`ROTATE_TILE

ROTATE_TILE: 2

Mesh pattern setting : rotate (180degs) alternate tiles on each row or column

`Static` `Readonly`TOP

TOP: 3

Mesh tile positioning : part tiles on top

Accessors

absolutePosition

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

Returns Vector3
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46326

absoluteRotationQuaternion

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

Returns Quaternion
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46336

absoluteScaling

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

Returns Vector3
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46331

accessibilityTag

get accessibilityTag(): Nullable<IAccessibilityTag>
Returns Nullable<IAccessibilityTag>
- 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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4463

animationPropertiesOverride

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

Returns Nullable<AnimationPropertiesOverride>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4535
set animationPropertiesOverride(
value: Nullable<AnimationPropertiesOverride>,
): void
Parameters
- value: Nullable<AnimationPropertiesOverride>
Returns void
- 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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52239
set applyFog(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52240

areNormalsFrozen

get areNormalsFrozen(): boolean
Gets a boolean indicating if the normals aren't to be recomputed on next mesh positions array update. This property is pertinent only for updatable parametric shapes.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49094

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52093
set bakedVertexAnimationManager(
value: Nullable<IBakedVertexAnimationManager>,
): void
Parameters
- value: Nullable<IBakedVertexAnimationManager>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52094

behaviors

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

Returns Behavior<Node>[]
See
https://doc.babylonjs.com/features/featuresDeepDive/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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46205
set billboardMode(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46206

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

checkCollisions

set checkCollisions(value: boolean): void
Gets or sets a boolean indicating that this mesh can be used in the collision engine
Parameters
- value: boolean
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/cameras/camera_collisions
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50132

cloneMeshMap

get cloneMeshMap(): Nullable<{ [id: string]: undefined | Mesh }>
Gets the list of clones of this mesh The scene must have been constructed with useClonedMeshMap=true for this to work! Note that useClonedMeshMap=true is the default setting

Returns Nullable<{ [id: string]: undefined | Mesh }>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48871

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52748

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52297
set collisionGroup(mask: number): void
Parameters
- mask: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52298

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52283
set collisionMask(mask: number): void
Parameters
- mask: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52284

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52291
set collisionResponse(response: boolean): void
Parameters
- response: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52292

collisionRetryCount

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

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52076
set collisionRetryCount(retryCount: number): void
Parameters
- retryCount: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52077

computeBonesUsingShaders

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48759
set computeBonesUsingShaders(value: boolean): void
Gets or sets a boolean indicating that bone animations must be computed by the GPU (true by default)
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48760

doNotSerialize

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4473
set doNotSerialize(value: boolean): void
Parameters
- value: boolean
Returns void
- 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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52242
set enableDistantPicking(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52243

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52073
set facetDepthSortFrom(location: Vector3): void
Parameters
- location: Vector3
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52074

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52045

forcedInstanceCount

get forcedInstanceCount(): number
Gets or sets the forced number of instances to display. If 0 (default value), the number of instances is not forced and depends on the draw type (regular / instance / thin instances mesh)

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48824
set forcedInstanceCount(count: number): void
Parameters
- count: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48825

forceWorldMatrixInstancedBufferUpdate

get forceWorldMatrixInstancedBufferUpdate(): boolean
Gets or sets a boolean indicating that the update of the instance buffer of the world matrices must be performed in all cases (and notably even in frozen mode)

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48890
set forceWorldMatrixInstancedBufferUpdate(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48891

forward

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

Returns Vector3
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46298

geometry

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

Returns Nullable<Geometry>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48976

hasBoundingInfo

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52566

hasInstances

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48786

hasLODLevels

get hasLODLevels(): boolean
Gets a boolean indicating if this mesh has LOD

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48933

hasThinInstances

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48787

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52225
set hasVertexAlpha(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52226

infiniteDistance

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46223
set infiniteDistance(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46224

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52143
set inheritVisibility(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52144

isAnInstance

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52611

isBlocked

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49083

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52082

isUnIndexed

get isUnIndexed(): boolean
Gets or sets a boolean indicating that this mesh does not use index buffer

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48877
set isUnIndexed(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48878

isVisible

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52149
set isVisible(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52150

isWorldMatrixFrozen

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46384

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52254
set layerMask(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52255

lightSources

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

Returns Light[]
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52340

manualUpdateOfPreviousWorldMatrixInstancedBuffer

get manualUpdateOfPreviousWorldMatrixInstancedBuffer(): boolean
Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48887
set manualUpdateOfPreviousWorldMatrixInstancedBuffer(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48888

manualUpdateOfWorldMatrixInstancedBuffer

get manualUpdateOfWorldMatrixInstancedBuffer(): boolean
Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48884
set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48885

morphTargetManager

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

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

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52065
set mustDepthSortFacets(sort: boolean): void
Parameters
- sort: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52066

nonUniformScaling

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46518

numBoneInfluencers

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

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52236
set numBoneInfluencers(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52237

onAfterRenderObservable

get onAfterRenderObservable(): Observable<Mesh>
An event triggered after rendering the mesh

Returns Observable<Mesh>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48772

onBeforeBindObservable

get onBeforeBindObservable(): Observable<Mesh>
An event triggered before binding the mesh

Returns Observable<Mesh>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48768

onBeforeDraw

set onBeforeDraw(callback: () => void): void
Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
Parameters
- callback: () => void
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48785

onBeforeDrawObservable

get onBeforeDrawObservable(): Observable<Mesh>
An event triggered before drawing the mesh

Returns Observable<Mesh>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48780

onBeforeRenderObservable

get onBeforeRenderObservable(): Observable<Mesh>
An event triggered before rendering the mesh

Returns Observable<Mesh>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48764

onBetweenPassObservable

get onBetweenPassObservable(): Observable<SubMesh>
An event triggeredbetween rendering pass when using separateCullingPass = true

Returns Observable<SubMesh>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48776

onClonedObservable

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

Returns Observable<Node>
- 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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52109

onCollisionPositionChange

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

onDispose

set onDispose(callback: () => void): void
Sets a callback that will be raised when the node will be disposed
Parameters
- callback: () => void
Returns void
- 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>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4556

overrideMaterialSideOrientation

get overrideMaterialSideOrientation(): number
Returns number
Deprecated
Please use sideOrientation instead.

See
https://doc.babylonjs.com/breaking-changes#7110
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48845
set overrideMaterialSideOrientation(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48846

overridenInstanceCount

set overridenInstanceCount(count: number): void
Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
Parameters
- count: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49108

overrideRenderingFillMode

get overrideRenderingFillMode(): Nullable<number>
Use this property to override the Material's fillMode value

Returns Nullable<number>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48850
set overrideRenderingFillMode(fillMode: Nullable<number>): void
Parameters
- fillMode: Nullable<number>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48851

parent

get parent(): Nullable<Node>
Returns Nullable<Node>
- 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
- 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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52057
set partitioningBBoxRatio(ratio: number): void
Parameters
- ratio: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52058

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52050
set partitioningSubdivisions(nb: number): void
Parameters
- nb: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52051

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52181
set pointerOverDisableMeshTesting(disable: boolean): void
Parameters
- disable: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52182

position

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

Returns Vector3
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46262
set position(newPosition: Vector3): void
Parameters
- newPosition: Vector3
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46263

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46212
set preserveParentRotationForBillboard(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46213

previousWorldMatrixInstancedBuffer

get previousWorldMatrixInstancedBuffer(): Float32Array
Gets the array buffer used to store the instanced buffer used for instances' previous world matrices

Returns Float32Array
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48882

rawBoundingInfo

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

receiveShadows

get receiveShadows(): boolean
Gets or sets a boolean indicating that this mesh can receive realtime shadows

Returns boolean
See
https://doc.babylonjs.com/features/featuresDeepDive/lights/shadows
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52210
set receiveShadows(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52211

renderingGroupId

get renderingGroupId(): number
Specifies the rendering group id for this mesh (0 by default)

Returns number
See
https://doc.babylonjs.com/features/featuresDeepDive/materials/advanced/transparent_rendering#rendering-groups
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52187
set renderingGroupId(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52188

right

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

Returns Vector3
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46306

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46277
set rotation(newRotation: Vector3): void
Parameters
- newRotation: Vector3
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46278

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>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46288
set rotationQuaternion(quaternion: Nullable<Quaternion>): void
Parameters
- quaternion: Nullable<Quaternion>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46289

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46282
set scaling(newScaling: Vector3): void
Parameters
- newScaling: Vector3
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46283

sideOrientation

get sideOrientation(): number
Use this property to change the original side orientation defined at construction time Material.sideOrientation will override this value if set User will still be able to change the material sideOrientation afterwards if they really need it

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48839
set sideOrientation(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48840

skeleton

get skeleton(): Nullable<Skeleton>
Returns Nullable<Skeleton>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52358
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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52357

source

get source(): Nullable<Mesh>
Gets the source mesh (the one used to clone this one from)

Returns Nullable<Mesh>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48865

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[]>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52308
set surroundingMeshes(meshes: Nullable<AbstractMesh[]>): void
Parameters
- meshes: Nullable<AbstractMesh[]>
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52309

up

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

Returns Vector3
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46302

useBones

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

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52584

useLODScreenCoverage

get useLODScreenCoverage(): boolean
Determines if the LOD levels are intended to be calculated using screen coverage (surface area ratio) instead of distance.

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48752
set useLODScreenCoverage(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48753

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
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52228
set useVertexColors(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52229

visibility

get visibility(): number
Gets or sets mesh visibility between 0 and 1 (default is 1)

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52131
set visibility(value: number): void
Gets or sets mesh visibility between 0 and 1 (default is 1)
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52135

worldMatrixFromCache

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

Returns Matrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4617

worldMatrixInstancedBuffer

get worldMatrixInstancedBuffer(): Float32Array
Gets the array buffer used to store the instanced buffer used for instances' world matrices

Returns Float32Array
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48880

`Static`BILLBOARDMODE_ALL

get BILLBOARDMODE_ALL(): number
Billboard on all axes

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

`Static`BILLBOARDMODE_NONE

get BILLBOARDMODE_NONE(): number
No billboard

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

`Static`BILLBOARDMODE_USE_POSITION

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

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

`Static`BILLBOARDMODE_X

get BILLBOARDMODE_X(): number
Billboard on X axis

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

`Static`BILLBOARDMODE_Y

get BILLBOARDMODE_Y(): number
Billboard on Y axis

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

`Static`BILLBOARDMODE_Z

get BILLBOARDMODE_Z(): number
Billboard on Z axis

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

Methods

_invalidateInstanceVertexArrayObject

_invalidateInstanceVertexArrayObject(): void
Invalidate VertexArrayObjects belonging to the mesh (but not to the Geometry of the mesh).

Returns void
Inherited from Mesh._invalidateInstanceVertexArrayObject
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50640

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 Mesh.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 Mesh.addChild
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46506

addLODLevel

addLODLevel(distanceOrScreenCoverage: number, mesh: Nullable<Mesh>): Mesh
Add a mesh as LOD level triggered at the given distance.
Parameters
- distanceOrScreenCoverage: number
  Either distance from the center of the object to show this level or the screen coverage if useScreenCoverage is set to true. If screen coverage, value is a fraction of the screen's total surface, between 0 and 1. Example Playground for distance https://playground.babylonjs.com/#QE7KM#197 Example Playground for screen coverage https://playground.babylonjs.com/#QE7KM#196
- mesh: Nullable<Mesh>
  The mesh to be added as LOD level (can be null)
Returns Mesh
This mesh (for chaining)

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/LOD
Inherited from Mesh.addLODLevel
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48950

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 Mesh.addRotation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46585

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 Mesh.alignWithNormal
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52938

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 Mesh.applyAngularImpulse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27209

applyDisplacementMap

applyDisplacementMap(
    url: string,
    minHeight: number,
    maxHeight: number,
    onSuccess?: (mesh: Mesh) => void,
    uvOffset?: Vector2,
    uvScale?: Vector2,
    forceUpdate?: boolean,
    onError?: (message?: string, exception?: any) => void,
): Mesh
Modifies the mesh geometry according to a displacement map. A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex. The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
Parameters
- url: string
  is a string, the URL from the image file is to be downloaded.
- minHeight: number
  is the lower limit of the displacement.
- maxHeight: number
  is the upper limit of the displacement.
- OptionalonSuccess: (mesh: Mesh) => void
  is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
- OptionaluvOffset: Vector2
  is an optional vector2 used to offset UV.
- OptionaluvScale: Vector2
  is an optional vector2 used to scale UV.
- OptionalforceUpdate: boolean
  defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
- OptionalonError: (message?: string, exception?: any) => void
  defines a callback called when an error occurs during the processing of the request.
Returns Mesh
the Mesh.
Inherited from Mesh.applyDisplacementMap
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49463

applyDisplacementMapFromBuffer

applyDisplacementMapFromBuffer(
    buffer: Uint8Array,
    heightMapWidth: number,
    heightMapHeight: number,
    minHeight: number,
    maxHeight: number,
    uvOffset?: Vector2,
    uvScale?: Vector2,
    forceUpdate?: boolean,
): Mesh
Modifies the mesh geometry according to a displacementMap buffer. A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex. The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
Parameters
- buffer: Uint8Array
  is a Uint8Array buffer containing series of Uint8 lower than 255, the red, green, blue and alpha values of each successive pixel.
- heightMapWidth: number
  is the width of the buffer image.
- heightMapHeight: number
  is the height of the buffer image.
- minHeight: number
  is the lower limit of the displacement.
- maxHeight: number
  is the upper limit of the displacement.
- OptionaluvOffset: Vector2
  is an optional vector2 used to offset UV.
- OptionaluvScale: Vector2
  is an optional vector2 used to scale UV.
- OptionalforceUpdate: boolean
  defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
Returns Mesh
the Mesh.
Inherited from Mesh.applyDisplacementMapFromBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49478

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 Mesh.applyImpulse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:30713

applySkeleton

applySkeleton(skeleton: Skeleton): Mesh
Updates the vertex buffer by applying transformation from the bones
Parameters
- skeleton: Skeleton
  defines the skeleton to apply to current mesh
Returns Mesh
the current mesh
Inherited from Mesh.applySkeleton
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49599

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 Mesh.attachToBone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46529

bakeCurrentTransformIntoVertices

bakeCurrentTransformIntoVertices(
bakeIndependentlyOfChildren?: boolean,
forceUnique?: boolean,
): Mesh
Modifies the mesh geometry according to its own current World Matrix. The mesh World Matrix is then reset. This method returns nothing but really modifies the mesh even if it's originally not set as updatable. Note that, under the hood, this method sets a new VertexBuffer each call.
Parameters
- OptionalbakeIndependentlyOfChildren: boolean
  indicates whether to preserve all child nodes' World Matrix during baking
- OptionalforceUnique: boolean
  indicates whether to force the mesh geometry to be unique
Returns Mesh
the current mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/transforms/center_origin/bakingTransforms
Inherited from Mesh.bakeCurrentTransformIntoVertices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49422

bakeTransformIntoVertices

bakeTransformIntoVertices(transform: Matrix): Mesh
Modifies the mesh geometry according to the passed transformation matrix. This method returns nothing, but it really modifies the mesh even if it's originally not set as updatable. The mesh normals are modified using the same transformation. Note that, under the hood, this method sets a new VertexBuffer each call.
Parameters
- transform: Matrix
  defines the transform matrix to use
Returns Mesh
the current mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/transforms/center_origin/bakingTransforms
Inherited from Mesh.bakeTransformIntoVertices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49411

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 Mesh.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 Mesh.buildBoundingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52574

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 Mesh.calcMovePOV
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52639

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 Mesh.calcRotatePOV
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52657

cleanMatrixWeights

cleanMatrixWeights(): void
Renormalize the mesh and patch it up if there are no weights Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1. However in the case of zero weights then we set just a single influence to 1. We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.

Returns void
Inherited from Mesh.cleanMatrixWeights
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49367

clone

clone(
    name: string,
    newParent?: Nullable<Node>,
    doNotCloneChildren?: boolean,
): LinesMesh
Returns a new LineMesh object cloned from the current one.
Parameters
- name: string
  defines the cloned mesh name
- OptionalnewParent: Nullable<Node>
  defines the new mesh parent
- OptionaldoNotCloneChildren: boolean
  if set to true, none of the mesh children are cloned (false by default)
Returns LinesMesh
the new mesh
Inherited from Mesh.clone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50155

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 Mesh.computeWorldMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46602

convertToFlatShadedMesh

convertToFlatShadedMesh(): Mesh
Modify the mesh to get a flat shading rendering. This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result. Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.

Returns Mesh
current mesh
Inherited from Mesh.convertToFlatShadedMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49487

convertToUnIndexedMesh

convertToUnIndexedMesh(): Mesh
This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers. In other words, more vertices, no more indices and a single bigger VBO. The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.

Returns Mesh
current mesh
Inherited from Mesh.convertToUnIndexedMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49494

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
Inherited from Mesh.copyVerticesData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49003

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 Mesh.createAnimationRange
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4735

createInstance

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

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/copies/instances
Inherited from Mesh.createInstance
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50162

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 Mesh.createNormals
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52926

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 Mesh.createOrUpdateSubmeshesOctree
- Defined in .temp/typedoc/docdirectory/doc.d.ts:125486

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 Mesh.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 Mesh.detachFromBone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46535

directRender

directRender(): Mesh
Render a complete mesh by going through all submeshes

Returns Mesh
the current mesh
See
- simple test
- perf test
Inherited from Mesh.directRender
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49351

disableEdgesRendering

disableEdgesRendering(): AbstractMesh
Disables the mesh edge rendering mode

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

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 Mesh.disableFacetData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52912

dispose

dispose(
    doNotRecurse?: boolean,
    disposeMaterialAndTextures?: boolean,
    doNotDisposeMaterial?: boolean,
): void
Disposes of the line mesh
Parameters
- OptionaldoNotRecurse: boolean
  If children should be disposed
- OptionaldisposeMaterialAndTextures: boolean
  This parameter is not used by the LineMesh class
- OptionaldoNotDisposeMaterial: boolean
  If the material should not be disposed (default: false, meaning the material is disposed)
Returns void
Inherited from Mesh.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50147

enableEdgesRendering

enableEdgesRendering(
epsilon?: number,
checkVerticesInsteadOfIndices?: boolean,
): 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
Returns AbstractMesh
the currentAbstractMesh

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

flipFaces

flipFaces(flipNormals?: boolean): Mesh
Inverses facet orientations. Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
Parameters
- OptionalflipNormals: boolean
  will also inverts the normals
Returns Mesh
current mesh
Inherited from Mesh.flipFaces
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49501

forceSharedVertices

forceSharedVertices(): void
Force adjacent facets to share vertices and remove any facets that have all vertices in a line This will undo any application of covertToFlatShadedMesh Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.

Returns void
Inherited from Mesh.forceSharedVertices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49514

freezeNormals

freezeNormals(): Mesh
This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It prevents the mesh normals from being recomputed on next positions array update.

Returns Mesh
the current mesh
Inherited from Mesh.freezeNormals
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49099

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 Mesh.freezeWorldMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46375

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 Mesh.getAbsolutePivotPoint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46471

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 Mesh.getAbsolutePivotPointToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46477

getAbsolutePosition

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

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

getAnimatables

getAnimatables(): IAnimatable[]
Returns as a new array populated with the mesh material and/or skeleton, if any.

Returns IAnimatable[]
an array of IAnimatable
Inherited from Mesh.getAnimatables
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49401

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 Mesh.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 Mesh.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 Mesh.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 Mesh.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 Mesh.getBoundingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52551

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 Mesh.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 Mesh.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 Mesh.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 Mesh.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 Mesh.getChildTransformNodes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46662

getClassName

getClassName(): string
Returns string
the string "LineMesh"
Inherited from Mesh.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50119

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 Mesh.getClosestFacetAtCoordinates
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52888

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 Mesh.getClosestFacetAtLocalCoordinates
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52900

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 Mesh.getConnectedParticleSystems
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52960

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 Mesh.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 Mesh.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 Mesh.getDirection
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46430

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 Mesh.getDirectionToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46439

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 Mesh.getDistanceToCamera
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46633

getEmittedParticleSystems

getEmittedParticleSystems(): IParticleSystem[]
Returns an array populated with IParticleSystem objects whose the mesh is the emitter

Returns IParticleSystem[]
an array of IParticleSystem
Inherited from Mesh.getEmittedParticleSystems
- Defined in .temp/typedoc/docdirectory/doc.d.ts:33493

getEngine

getEngine(): AbstractEngine
Gets the engine of the node

Returns AbstractEngine
a Engine
Inherited from Mesh.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 Mesh.getFacetDataParameters
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52906

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 Mesh.getFacetLocalNormals
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52822

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 Mesh.getFacetLocalPartitioning
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52835

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 Mesh.getFacetLocalPositions
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52829

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 Mesh.getFacetNormal
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52859

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 Mesh.getFacetNormalToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52867

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 Mesh.getFacetPosition
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52843

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 Mesh.getFacetPositionToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52851

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 Mesh.getFacetsAtLocalCoordinates
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52876

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 Mesh.getHierarchyBoundingVectors
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4800

getHierarchyEmittedParticleSystems

getHierarchyEmittedParticleSystems(): IParticleSystem[]
Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter

Returns IParticleSystem[]
an array of IParticleSystem
Inherited from Mesh.getHierarchyEmittedParticleSystems
- Defined in .temp/typedoc/docdirectory/doc.d.ts:33498

getIndices

getIndices(
copyWhenShared?: boolean,
forceCopy?: boolean,
): Nullable<IndicesArray>
Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
Parameters
- 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 indicating that the returned array must be cloned upon returning it
Returns Nullable<IndicesArray>
the indices array or an empty array if the mesh has no geometry
Inherited from Mesh.getIndices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49082

getLOD

getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>
Returns the registered LOD mesh distant from the parameter camera position if any, else returns the current mesh.
Parameters
- camera: Camera
  defines the camera to use to compute distance
- OptionalboundingSphere: BoundingSphere
  defines a custom bounding sphere to use instead of the one from this mesh
Returns Nullable<AbstractMesh>
This mesh (for chaining)

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/LOD
Inherited from Mesh.getLOD
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48972

getLODLevelAtDistance

getLODLevelAtDistance(distance: number): Nullable<Mesh>
Returns the LOD level mesh at the passed distance or null if not found.
Parameters
- distance: number
  The distance from the center of the object to show this level
Returns Nullable<Mesh>
a Mesh or null

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/LOD
Inherited from Mesh.getLODLevelAtDistance
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48957

getLODLevels

getLODLevels(): MeshLODLevel[]
Gets the list of MeshLODLevel associated with the current mesh

Returns MeshLODLevel[]
an array of MeshLODLevel
Inherited from Mesh.getLODLevels
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48938

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 Mesh.getMaterialForRenderPass
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52199

getMeshUniformBuffer

getMeshUniformBuffer(): UniformBuffer
Gets the mesh uniform buffer.

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

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 Mesh.getNormalsData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52693

getPhysicsBody

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

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 Mesh.getPhysicsImpostor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:30706

getPivotMatrix

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

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

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 Mesh.getPivotPoint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46460

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 Mesh.getPivotPointToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46466

getPoseMatrix

getPoseMatrix(): Matrix
Returns the mesh Pose matrix.

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

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 Mesh.getPositionData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52701

getPositionExpressedInLocalSpace

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

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

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 Mesh.getPositionInCameraSpace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46627

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 Mesh.getRawBoundingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52556

getScene

getScene(): Scene
Gets the scene of the node

Returns Scene
a scene
Inherited from Mesh.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.
Inherited from Mesh.getTotalIndices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49075

getTotalVertices

getTotalVertices(): number
Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.

Returns number
the total number of vertices
Inherited from Mesh.getTotalVertices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48981

getVertexBuffer

getVertexBuffer(
kind: string,
bypassInstanceData?: boolean,
): Nullable<VertexBuffer>
Returns the mesh VertexBuffer object from the requested kind
Parameters
- kind: string
  defines which buffer to read from (positions, indices, normals, etc). Possible kind values :
  
  VertexBuffer.PositionKind
  
  VertexBuffer.NormalKind
  
  VertexBuffer.UVKind
  
  VertexBuffer.UV2Kind
  
  VertexBuffer.UV3Kind
  
  VertexBuffer.UV4Kind
  
  VertexBuffer.UV5Kind
  
  VertexBuffer.UV6Kind
  
  VertexBuffer.ColorKind
  
  VertexBuffer.MatricesIndicesKind
  
  VertexBuffer.MatricesIndicesExtraKind
  
  VertexBuffer.MatricesWeightsKind
  
  VertexBuffer.MatricesWeightsExtraKind
- OptionalbypassInstanceData: boolean
  defines a boolean indicating that the function should not take into account the instance data (applies only if the mesh has instances). Default: false
Returns Nullable<VertexBuffer>
a FloatArray or null if the mesh has no vertex buffer for this kind.
Inherited from Mesh.getVertexBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49025

getVerticesData

getVerticesData(
    kind: string,
    copyWhenShared?: boolean,
    forceCopy?: boolean,
    bypassInstanceData?: boolean,
): Nullable<FloatArray>
Returns the content of an associated vertex buffer
Parameters
- kind: string
  defines which buffer to read from (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
- OptionalcopyWhenShared: boolean
  defines a boolean indicating that 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
- OptionalbypassInstanceData: boolean
  defines a boolean indicating that the function should not take into account the instance data (applies only if the mesh has instances). Default: false
Returns Nullable<FloatArray>
a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
Inherited from Mesh.getVerticesData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49002

getVerticesDataKinds

getVerticesDataKinds(bypassInstanceData?: boolean): string[]
Returns a string which contains the list of existing kinds of Vertex Data associated with this mesh.
Parameters
- OptionalbypassInstanceData: boolean
  defines a boolean indicating that the function should not take into account the instance data (applies only if the mesh has instances). Default: false
Returns string[]
an array of strings
Inherited from Mesh.getVerticesDataKinds
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49070

getWorldMatrix

getWorldMatrix(): Matrix
Gets the current world matrix

Returns Matrix
a Matrix
Inherited from Mesh.getWorldMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52605

increaseVertices

increaseVertices(numberPerEdge?: number): void
Increase the number of facets and hence vertices in a mesh Vertex normals are interpolated from existing vertex normals Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
Parameters
- OptionalnumberPerEdge: number
  the number of new vertices to add to each edge of a facet, optional default 1
Returns void
Inherited from Mesh.increaseVertices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49508

instantiateHierarchy

instantiateHierarchy(
    newParent?: Nullable<TransformNode>,
    options?: { doNotInstantiate: boolean | (node: TransformNode) => boolean },
    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 }
  defines options to configure how copy is done
  - doNotInstantiate: boolean | (node: TransformNode) => boolean
    defines if the model must be instantiated or just cloned
- 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
Inherited from Mesh.instantiateHierarchy
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48912

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 Mesh.intersects
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52785

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 Mesh.intersectsMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52731

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 Mesh.intersectsPoint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52737

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 Mesh.isCompletelyInFrustum
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52723

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 Mesh.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 Mesh.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 Mesh.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 Mesh.isInFrustum
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49390

isReady

isReady(): boolean
Determine if the current mesh is ready to be rendered

Returns boolean
true if all associated assets are ready (material, textures, shaders)
Inherited from Mesh.isReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50115

isUsingPivotMatrix

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

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

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 Mesh.isUsingPostMultiplyPivotMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46272

isVertexBufferUpdatable

isVertexBufferUpdatable(kind: string, bypassInstanceData?: boolean): boolean
Returns a boolean defining if the vertex data for the requested kind is updatable.
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
- OptionalbypassInstanceData: boolean
  defines a boolean indicating that the function should not take into account the instance data (applies only if the mesh has instances). Default: false
Returns boolean
a boolean
Inherited from Mesh.isVertexBufferUpdatable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49064

isVerticesDataPresent

isVerticesDataPresent(kind: string, bypassInstanceData?: boolean): boolean
Tests if a specific vertex buffer is associated with this mesh
Parameters
- kind: string
  defines which buffer to check (positions, indices, normals, etc). Possible kind values :
  
  VertexBuffer.PositionKind
  
  VertexBuffer.NormalKind
  
  VertexBuffer.UVKind
  
  VertexBuffer.UV2Kind
  
  VertexBuffer.UV3Kind
  
  VertexBuffer.UV4Kind
  
  VertexBuffer.UV5Kind
  
  VertexBuffer.UV6Kind
  
  VertexBuffer.ColorKind
  
  VertexBuffer.MatricesIndicesKind
  
  VertexBuffer.MatricesIndicesExtraKind
  
  VertexBuffer.MatricesWeightsKind
  
  VertexBuffer.MatricesWeightsExtraKind
- OptionalbypassInstanceData: boolean
  defines a boolean indicating that the function should not take into account the instance data (applies only if the mesh has instances). Default: false
Returns boolean
a boolean
Inherited from Mesh.isVerticesDataPresent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49045

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 Mesh.isWorldMatrixCameraDependent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46595

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 Mesh.locallyTranslate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46412

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 Mesh.lookAt
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46423

makeGeometryUnique

makeGeometryUnique(): Mesh
Creates a un-shared specific occurence of the geometry for the mesh.

Returns Mesh
the current mesh
Inherited from Mesh.makeGeometryUnique
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49235

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 Mesh.markAsDirty
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52434

markVerticesDataAsUpdatable

markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void
Flags an associated vertex buffer as updatable
Parameters
- kind: string
  defines which buffer to use (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
- Optionalupdatable: boolean
  defines if the updated vertex buffer must be flagged as updatable
Returns void
Inherited from Mesh.markVerticesDataAsUpdatable
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49194

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 Mesh.movePOV
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52629

moveWithCollisions

moveWithCollisions(displacement: Vector3): AbstractMesh
Move the mesh using collision engine
Parameters
- displacement: Vector3
  defines the requested displacement vector
Returns AbstractMesh
the current mesh

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

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 Mesh.normalizeToUnitCube
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52582

optimizeIndices

optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh
Optimization of the mesh's indices, in case a mesh has duplicated vertices. The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes. This should be used together with the simplification to avoid disappearing triangles.
Parameters
- OptionalsuccessCallback: (mesh?: Mesh) => void
  an optional success callback to be called after the optimization finished.
Returns Mesh
the current mesh
Inherited from Mesh.optimizeIndices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49543

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 Mesh.optimizeIndicesAsync
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52931

refreshBoundingInfo

refreshBoundingInfo(
applySkeletonOrOptions?: boolean | IMeshDataOptions,
applyMorph?: boolean,
): Mesh
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
  defines whether to apply the skeleton before computing the bounding info or a set of options
- OptionalapplyMorph: boolean
  defines whether to apply the morph target before computing the bounding info
Returns Mesh
the current mesh
Inherited from Mesh.refreshBoundingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49129

registerAfterRender

registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh
Registers for this mesh a javascript function called just after the rendering is complete
Parameters
- func: (mesh: AbstractMesh) => void
  defines the function to call after rendering this mesh
Returns Mesh
the current mesh
Inherited from Mesh.registerAfterRender
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49295

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 Mesh.registerAfterWorldMatrixUpdate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46615

registerBeforeRender

registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh
Registers for this mesh a javascript function called just before the rendering process
Parameters
- func: (mesh: AbstractMesh) => void
  defines the function to call before rendering this mesh
Returns Mesh
the current mesh
Inherited from Mesh.registerBeforeRender
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49283

registerInstancedBuffer

registerInstancedBuffer(kind: string, stride: number): void
Register a custom buffer that will be instanced
Parameters
- kind: string
  defines the buffer kind
- stride: number
  defines the stride in floats
Returns void
See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/copies/instances#custom-buffers
Inherited from Mesh.registerInstancedBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50636

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 Mesh.releaseSubMeshes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52799

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 Mesh.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 Mesh.removeChild
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46513

removeLODLevel

removeLODLevel(mesh: Nullable<Mesh>): Mesh
Remove a mesh from the LOD array
Parameters
- mesh: Nullable<Mesh>
  defines the mesh to be removed
Returns Mesh
This mesh (for chaining)

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/LOD
Inherited from Mesh.removeLODLevel
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48964

removeVerticesData

removeVerticesData(kind: string): void
Delete a vertex buffer associated with this mesh
Parameters
- kind: string
  defines which buffer to delete (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 void
Inherited from Mesh.removeVerticesData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49176

render

render(
    subMesh: SubMesh,
    enableAlphaMode: boolean,
    effectiveMeshReplacement?: AbstractMesh,
): Mesh
Triggers the draw call for the mesh. Usually, you don't need to call this method by your own because the mesh rendering is handled by the scene rendering manager
Parameters
- subMesh: SubMesh
  defines the subMesh to render
- enableAlphaMode: boolean
  defines if alpha mode can be changed
- OptionaleffectiveMeshReplacement: AbstractMesh
  defines an optional mesh used to provide info for the rendering
Returns Mesh
the current mesh
Inherited from Mesh.render
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49359

renderWithRenderPassId

renderWithRenderPassId(
    renderPassId?: number,
    enableAlphaMode?: boolean,
    effectiveMeshReplacement?: AbstractMesh,
    subMesh?: SubMesh,
    checkFrustumCulling?: boolean,
): this
Triggers the draw call for the mesh (or a submesh), for a specific render pass id
Parameters
- OptionalrenderPassId: number
  defines the render pass id to use to draw the mesh / submesh. If not provided, use the current renderPassId of the engine.
- OptionalenableAlphaMode: boolean
  defines if alpha mode can be changed (default: false)
- OptionaleffectiveMeshReplacement: AbstractMesh
  defines an optional mesh used to provide info for the rendering (default: undefined)
- OptionalsubMesh: SubMesh
  defines the subMesh to render. If not provided, draw all mesh submeshes (default: undefined)
- OptionalcheckFrustumCulling: boolean
  defines if frustum culling must be checked (default: true). If you know the mesh is in the frustum (or if you don't care!), you can pass false to optimize.
Returns this
the current mesh
Inherited from Mesh.renderWithRenderPassId
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49344

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 Mesh.resetDrawCache
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52440

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 Mesh.resetLocalMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46607

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 Mesh.rotate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46547

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 Mesh.rotateAround
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46558

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 Mesh.rotatePOV
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52648

serialize

serialize(serializationObject: any): void
Serializes this ground mesh
Parameters
- serializationObject: any
  object to write serialization to
Returns void
Inherited from Mesh.serialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50167

serializeAnimationRanges

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

Returns any
serialization object
Inherited from Mesh.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 Mesh.setAbsolutePosition
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46395

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 Mesh.setBoundingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52562

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 Mesh.setDirection
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46448

setEnabled

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

setIndexBuffer

setIndexBuffer(
    indexBuffer: DataBuffer,
    totalVertices: number,
    totalIndices: number,
    is32Bits?: Nullable<boolean>,
): void
Sets the index buffer of this mesh.
Parameters
- indexBuffer: DataBuffer
  Defines the index buffer to use for this mesh
- totalVertices: number
  Defines the total number of vertices used by the buffer
- totalIndices: number
  Defines the total number of indices in the index buffer
- Optionalis32Bits: Nullable<boolean>
  Defines if the indices are 32 bits. If null (default), the value is guessed from the number of vertices
Returns void
Inherited from Mesh.setIndexBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49243

setIndices

setIndices(
    indices: IndicesArray,
    totalVertices?: Nullable<number>,
    updatable?: boolean,
    dontForceSubMeshRecreation?: boolean,
): AbstractMesh
Set the index buffer of this mesh
Parameters
- indices: IndicesArray
  defines the source data
- OptionaltotalVertices: Nullable<number>
  defines the total number of vertices referenced by this index data (can be null)
- Optionalupdatable: boolean
  defines if the updated index buffer must be flagged as updatable (default is false)
- OptionaldontForceSubMeshRecreation: boolean
  defines a boolean indicating that we don't want to force the recreation of sub-meshes if we don't have to (false by default)
Returns AbstractMesh
the current mesh
Inherited from Mesh.setIndices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49252

setMaterialById

setMaterialById(id: string): Mesh
Sets the mesh material by the material or multiMaterial id property
Parameters
- id: string
  is a string identifying the material or the multiMaterial
Returns Mesh
the current mesh
Inherited from Mesh.setMaterialById
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49396

setMaterialByID

setMaterialByID(id: string): Mesh
Sets the mesh material by the material or multiMaterial id property
Parameters
- id: string
  is a string identifying the material or the multiMaterial
Returns Mesh
the current mesh

Deprecated
Please use MeshBuilder instead Please use setMaterialById instead
Inherited from Mesh.setMaterialByID
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49659

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 Mesh.setMaterialForRenderPass
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52205

setNormalsForCPUSkinning

setNormalsForCPUSkinning(): Nullable<Float32Array>
Prepare internal normal array for software CPU skinning

Returns Nullable<Float32Array>
original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
Inherited from Mesh.setNormalsForCPUSkinning
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49593

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 Mesh.setParent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46497

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 Mesh.setPhysicsLinkWith
- Defined in .temp/typedoc/docdirectory/doc.d.ts:30723

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 Mesh.setPivotMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46349

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 Mesh.setPivotPoint
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46455

setPositionsForCPUSkinning

setPositionsForCPUSkinning(): Nullable<Float32Array>
Prepare internal position array for software CPU skinning

Returns Nullable<Float32Array>
original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
Inherited from Mesh.setPositionsForCPUSkinning
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49588

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 Mesh.setPositionWithLocalVector
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46401

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 Mesh.setPreTransformMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46342

setVerticesBuffer

setVerticesBuffer(buffer: VertexBuffer, disposeExistingBuffer?: boolean): Mesh
Sets the mesh global Vertex Buffer
Parameters
- buffer: VertexBuffer
  defines the buffer to use
- OptionaldisposeExistingBuffer: boolean
  disposes the existing buffer, if any (default: true)
Returns Mesh
the current mesh
Inherited from Mesh.setVerticesBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49201

setVerticesData

setVerticesData(
    kind: string,
    data: FloatArray,
    updatable?: boolean,
    stride?: number,
): AbstractMesh
Copy a FloatArray into a specific associated vertex buffer
Parameters
- kind: string
  defines which buffer to write to (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
- data: FloatArray
  defines the data source
- Optionalupdatable: boolean
  defines if the updated vertex buffer must be flagged as updatable
- Optionalstride: number
  defines the data stride size (can be null)
Returns AbstractMesh
the current mesh
Inherited from Mesh.setVerticesData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49159

simplify

simplify(
    settings: ISimplificationSettings[],
    parallelProcessing?: boolean,
    simplificationType?: QUADRATIC,
    successCallback?: (mesh?: Mesh, submeshIndex?: number) => void,
): Mesh
Simplify the mesh according to the given array of settings. Function will return immediately and will simplify async
Parameters
- settings: ISimplificationSettings[]
  a collection of simplification settings
- OptionalparallelProcessing: boolean
  should all levels calculate parallel or one after the other
- OptionalsimplificationType: QUADRATIC
  the type of simplification to run
- OptionalsuccessCallback: (mesh?: Mesh, submeshIndex?: number) => void
  optional success callback to be called after the simplification finished processing all settings
Returns Mesh
the current mesh
Inherited from Mesh.simplify
- Defined in .temp/typedoc/docdirectory/doc.d.ts:47433

subdivide

subdivide(count: number): void
This function will subdivide the mesh into multiple submeshes
Parameters
- count: number
  defines the expected number of submeshes
Returns void
Inherited from Mesh.subdivide
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49138

synchronizeInstances

synchronizeInstances(): Mesh
Synchronises all the mesh instance submeshes to the current mesh submeshes, if any. After this call, all the mesh instances have the same submeshes than the current mesh.

Returns Mesh
the current mesh
Inherited from Mesh.synchronizeInstances
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49535

thinInstanceAdd

thinInstanceAdd(
matrix: DeepImmutableObject<Matrix> | DeepImmutableObject<Matrix>[],
refresh?: boolean,
): number
Creates a new thin instance
Parameters
- matrix: DeepImmutableObject<Matrix> | DeepImmutableObject<Matrix>[]
  the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
- Optionalrefresh: boolean
  true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
Returns number
the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
Inherited from Mesh.thinInstanceAdd
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46809

thinInstanceAddSelf

thinInstanceAddSelf(refresh?: boolean): number
Adds the transformation (matrix) of the current mesh as a thin instance
Parameters
- Optionalrefresh: boolean
  true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
Returns number
the thin instance index number
Inherited from Mesh.thinInstanceAddSelf
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46815

thinInstanceBufferUpdated

thinInstanceBufferUpdated(kind: string): void
Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
Parameters
- kind: string
  name of the attribute to update. Use "matrix" to update the buffer of matrices
Returns void
Inherited from Mesh.thinInstanceBufferUpdated
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46858

thinInstanceGetWorldMatrices

thinInstanceGetWorldMatrices(): Matrix[]
Gets the list of world matrices

Returns Matrix[]
an array containing all the world matrices from the thin instances
Inherited from Mesh.thinInstanceGetWorldMatrices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46853

thinInstancePartialBufferUpdate

thinInstancePartialBufferUpdate(
    kind: string,
    data: Float32Array,
    offset: number,
): void
Applies a partial update to a buffer directly on the GPU Note that the buffer located on the CPU is NOT updated! It's up to you to update it (or not) with the same data you pass to this method
Parameters
- kind: string
  name of the attribute to update. Use "matrix" to update the buffer of matrices
- data: Float32Array
  the data to set in the GPU buffer
- offset: number
  the offset in the GPU buffer where to update the data
Returns void
Inherited from Mesh.thinInstancePartialBufferUpdate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46866

thinInstanceRefreshBoundingInfo

thinInstanceRefreshBoundingInfo(
    forceRefreshParentInfo?: boolean,
    applySkeleton?: boolean,
    applyMorph?: boolean,
): void
Refreshes the bounding info, taking into account all the thin instances defined
Parameters
- OptionalforceRefreshParentInfo: boolean
  true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
- OptionalapplySkeleton: boolean
  defines whether to apply the skeleton before computing the bounding info
- OptionalapplyMorph: boolean
  defines whether to apply the morph target before computing the bounding info
Returns void
Inherited from Mesh.thinInstanceRefreshBoundingInfo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46873

thinInstanceRegisterAttribute

thinInstanceRegisterAttribute(kind: string, stride: number): void
Registers a custom attribute to be used with thin instances
Parameters
- kind: string
  name of the attribute
- stride: number
  size in floats of the attribute
Returns void
Inherited from Mesh.thinInstanceRegisterAttribute
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46821

thinInstanceSetAttributeAt

thinInstanceSetAttributeAt(
    kind: string,
    index: number,
    value: number[],
    refresh?: boolean,
): void
Sets the value of a custom attribute for a thin instance
Parameters
- kind: string
  name of the attribute
- index: number
  index of the thin instance
- value: number[]
  value to set
- Optionalrefresh: boolean
  true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
Returns void
Inherited from Mesh.thinInstanceSetAttributeAt
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46836

thinInstanceSetBuffer

thinInstanceSetBuffer(
    kind: string,
    buffer: Nullable<Float32Array>,
    stride?: number,
    staticBuffer?: boolean,
): void
Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
Parameters
- kind: string
  name of the attribute. Use "matrix" to setup the buffer of matrices
- buffer: Nullable<Float32Array>
  buffer to set
- Optionalstride: number
  size in floats of each value of the buffer
- OptionalstaticBuffer: boolean
  indicates that the buffer is static, so that you won't change it after it is set (better performances - true by default)
Returns void
Inherited from Mesh.thinInstanceSetBuffer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46848

thinInstanceSetMatrixAt

thinInstanceSetMatrixAt(
    index: number,
    matrix: DeepImmutableObject<Matrix>,
    refresh?: boolean,
): void
Sets the matrix of a thin instance
Parameters
- index: number
  index of the thin instance
- matrix: DeepImmutableObject<Matrix>
  matrix to set
- Optionalrefresh: boolean
  true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
Returns void
Inherited from Mesh.thinInstanceSetMatrixAt
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46828

toLeftHanded

toLeftHanded(): Mesh
Invert the geometry to move from a right handed system to a left handed one.

Returns Mesh
the current mesh
Inherited from Mesh.toLeftHanded
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49265

toString

toString(fullDetails?: boolean): string
Returns a description of this mesh
Parameters
- OptionalfullDetails: boolean
  define if full details about this mesh must be used
Returns string
a descriptive string representing this mesh
Inherited from Mesh.toString
- Defined in .temp/typedoc/docdirectory/doc.d.ts:48927

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 Mesh.transferToEffect
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52379

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 Mesh.translate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46567

unfreezeNormals

unfreezeNormals(): Mesh
This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It reactivates the mesh normals computation if it was previously frozen

Returns Mesh
the current mesh
Inherited from Mesh.unfreezeNormals
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49104

unfreezeWorldMatrix

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

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

unregisterAfterRender

unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh
Disposes a previously registered javascript function called after the rendering.
Parameters
- func: (mesh: AbstractMesh) => void
  defines the function to remove
Returns Mesh
the current mesh
Inherited from Mesh.unregisterAfterRender
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49301

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 Mesh.unregisterAfterWorldMatrixUpdate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46621

unregisterBeforeRender

unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh
Disposes a previously registered javascript function called before the rendering
Parameters
- func: (mesh: AbstractMesh) => void
  defines the function to remove
Returns Mesh
the current mesh
Inherited from Mesh.unregisterBeforeRender
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49289

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 Mesh.updateFacetData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:52815

updateIndices

updateIndices(
    indices: IndicesArray,
    offset?: number,
    gpuMemoryOnly?: boolean,
): AbstractMesh
Update the current index buffer
Parameters
- indices: IndicesArray
  defines the source data
- 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 Mesh.updateIndices
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49260

updateMeshPositions

updateMeshPositions(
positionFunction: (data: FloatArray) => void,
computeNormals?: boolean,
): Mesh
This method updates the vertex positions of an updatable mesh according to the positionFunction returned values.
Parameters
- positionFunction: (data: FloatArray) => void
  is a simple JS function what is passed the mesh positions array. It doesn't need to return anything
- OptionalcomputeNormals: boolean
  is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
Returns Mesh
the current mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/dynamicMeshMorph#other-shapes-updatemeshpositions
Inherited from Mesh.updateMeshPositions
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49230

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 Mesh.updatePoseMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46312

updateVerticesData

updateVerticesData(
    kind: string,
    data: FloatArray,
    updateExtends?: boolean,
    makeItUnique?: boolean,
): AbstractMesh
Update a specific associated vertex buffer
Parameters
- kind: string
  defines which buffer to write to (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
- 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 if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
Returns AbstractMesh
the current mesh
Inherited from Mesh.updateVerticesData
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49222

validateSkinning

validateSkinning(): { report: string; skinned: boolean; valid: boolean }
ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights, or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let the user know there was an issue with importing the mesh

Returns { report: string; skinned: boolean; valid: boolean }
a validation object with skinned, valid and report string
Inherited from Mesh.validateSkinning
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49376

`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 Mesh.AddNodeConstructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4418

`Static`Center

Center(
meshesOrMinMaxVector: AbstractMesh[] | { max: Vector3; min: Vector3 },
): Vector3
Returns the center of the {min: Vector3, max: Vector3} or the center of MinMax vector3 computed from a mesh array
Parameters
- meshesOrMinMaxVector: AbstractMesh[] | { max: Vector3; min: Vector3 }
  could be an array of meshes or a {min: Vector3, max: Vector3} object
Returns Vector3
a vector3
Inherited from Mesh.Center
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49614

`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 Mesh.Construct
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4427

`Static`CreateBox

CreateBox(
    name: string,
    size: number,
    scene: Nullable<Scene>,
    updatable?: boolean,
    sideOrientation?: number,
): Mesh
Creates a box mesh.
Parameters
- name: string
  defines the name of the mesh to create
- size: number
  sets the size (float) of each box side (default 1)
- scene: Nullable<Scene>
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- OptionalsideOrientation: number
  defines the mesh side orientation (https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation)
Returns Mesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateBox
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49698

`Static`CreateCapsule

CreateCapsule(name: string, options: ICreateCapsuleOptions, scene: Scene): Mesh
Creates a Capsule Mesh
Parameters
- name: string
  defines the name of the mesh.
- options: ICreateCapsuleOptions
  the constructors options used to shape the mesh.
- scene: Scene
  defines the scene the mesh is scoped to.
Returns Mesh
the capsule mesh

See
https://doc.babylonjs.com/how_to/capsule_shape

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateCapsule
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50044

`Static`CreateCylinder

CreateCylinder(
    name: string,
    height: number,
    diameterTop: number,
    diameterBottom: number,
    tessellation: number,
    subdivisions: any,
    scene?: Scene,
    updatable?: any,
    sideOrientation?: number,
): Mesh
Creates a cylinder or a cone mesh.
Parameters
- name: string
  defines the name of the mesh to create
- height: number
  sets the height size (float) of the cylinder/cone (float, default 2)
- diameterTop: number
  set the top cap diameter (floats, default 1)
- diameterBottom: number
  set the bottom cap diameter (floats, default 1). This value can't be zero
- tessellation: number
  sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
- subdivisions: any
  sets the number of rings along the cylinder height (positive integer, default 1)
- Optionalscene: Scene
  defines the hosting scene
- Optionalupdatable: any
  defines if the mesh must be flagged as updatable
- OptionalsideOrientation: number
  defines the mesh side orientation (https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation)
Returns Mesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateCylinder
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49735

`Static`CreateDashedLines

CreateDashedLines(
    name: string,
    points: Vector3[],
    dashSize: number,
    gapSize: number,
    dashNb: number,
    scene: Nullable<Scene>,
    updatable?: boolean,
    instance?: LinesMesh,
): LinesMesh
Creates a dashed line mesh.
Parameters
- name: string
  defines the name of the mesh to create
- points: Vector3[]
  is an array successive Vector3
- dashSize: number
  is the size of the dashes relatively the dash number (positive float, default 3)
- gapSize: number
  is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
- dashNb: number
  is the intended total number of dashes (positive integer, default 200)
- scene: Nullable<Scene>
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- Optionalinstance: LinesMesh
  is an instance of an existing LineMesh object to be updated with the passed points parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines)
Returns LinesMesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateDashedLines
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49789

`Static`CreateDecal

CreateDecal(
    name: string,
    sourceMesh: AbstractMesh,
    position: Vector3,
    normal: Vector3,
    size: Vector3,
    angle: number,
): Mesh
Creates a decal mesh. . A decal is a mesh usually applied as a model onto the surface of another mesh
Parameters
- name: string
  defines the name of the mesh
- sourceMesh: AbstractMesh
  defines the mesh receiving the decal
- position: Vector3
  sets the position of the decal in world coordinates
- normal: Vector3
  sets the normal of the mesh where the decal is applied onto in world coordinates
- size: Vector3
  sets the decal scaling
- angle: number
  sets the angle to rotate the decal
Returns Mesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateDecal
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50035

`Static`CreateDisc

CreateDisc(
    name: string,
    radius: number,
    tessellation: number,
    scene: Nullable<Scene>,
    updatable?: boolean,
    sideOrientation?: number,
): Mesh
Creates a plane polygonal mesh. By default, this is a disc.
Parameters
- name: string
  defines the name of the mesh to create
- radius: number
  sets the radius size (float) of the polygon (default 0.5)
- tessellation: number
  sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
- scene: Nullable<Scene>
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- OptionalsideOrientation: number
  defines the mesh side orientation (https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation)
Returns Mesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateDisc
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49687

`Static`CreateGround

CreateGround(
    name: string,
    width: number,
    height: number,
    subdivisions: number,
    scene?: Scene,
    updatable?: boolean,
): Mesh
Creates a ground mesh.
Parameters
- name: string
  defines the name of the mesh to create
- width: number
  set the width of the ground
- height: number
  set the height of the ground
- subdivisions: number
  sets the number of subdivisions per side
- Optionalscene: Scene
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
Returns Mesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateGround
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49905

`Static`CreateGroundFromHeightMap

CreateGroundFromHeightMap(
    name: string,
    url: string,
    width: number,
    height: number,
    subdivisions: number,
    minHeight: number,
    maxHeight: number,
    scene: Scene,
    updatable?: boolean,
    onReady?: (mesh: GroundMesh) => void,
    alphaFilter?: number,
): GroundMesh
Creates a ground mesh from a height map.
Parameters
- name: string
  defines the name of the mesh to create
- url: string
  sets the URL of the height map image resource
- width: number
  set the ground width size
- height: number
  set the ground height size
- subdivisions: number
  sets the number of subdivision per side
- minHeight: number
  is the minimum altitude on the ground
- maxHeight: number
  is the maximum altitude on the ground
- scene: Scene
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- OptionalonReady: (mesh: GroundMesh) => void
  is a callback function that will be called once the mesh is built (the height map download can last some time)
- OptionalalphaFilter: number
  will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
Returns GroundMesh
a new Mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set/height_map

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateGroundFromHeightMap
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49944

`Static`CreateHemisphere

CreateHemisphere(
    name: string,
    segments: number,
    diameter: number,
    scene?: Scene,
): Mesh
Creates a hemisphere mesh.
Parameters
- name: string
  defines the name of the mesh to create
- segments: number
  sets the sphere number of horizontal stripes (positive integer, default 32)
- diameter: number
  sets the diameter size (float) of the sphere (default 1)
- Optionalscene: Scene
  defines the hosting scene
Returns Mesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateHemisphere
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49720

`Static`CreateIcoSphere

CreateIcoSphere(
    name: string,
    options: {
        flat?: boolean;
        radius?: number;
        sideOrientation?: number;
        subdivisions?: number;
        updatable?: boolean;
    },
    scene: Scene,
): Mesh
Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
- The parameter radius sets the radius size (float) of the icosphere (default 1)
- You can set some different icosphere dimensions, for instance to build an ellipsoid, by using the parameters radiusX, radiusY and radiusZ (all by default have the same value than radius)
- The parameter subdivisions sets the number of subdivisions (positive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
- The parameter flat (boolean, default true) gives each side its own normals. Set it to false to get a smooth continuous light reflection on the surface
- You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
- If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters frontUVs and backUVs (Vector4). Detail here : https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation
- The mesh can be set to updatable with the boolean parameter updatable (default false) if its internal geometry is supposed to change once created
Parameters
- name: string
  defines the name of the mesh
- options: {
      flat?: boolean;
      radius?: number;
      sideOrientation?: number;
      subdivisions?: number;
      updatable?: boolean;
  }
  defines the options used to create the mesh
- scene: Scene
  defines the hosting scene
Returns Mesh
a new Mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/polyhedra#icosphere

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateIcoSphere
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50015

`Static`CreateLathe

CreateLathe(
    name: string,
    shape: Vector3[],
    radius: number,
    tessellation: number,
    scene: Scene,
    updatable?: boolean,
    sideOrientation?: number,
): Mesh
Creates lathe mesh. The lathe is a shape with a symmetry axis : a 2D model shape is rotated around this axis to design the lathe.
Parameters
- name: string
  defines the name of the mesh to create
- shape: Vector3[]
  is a required array of successive Vector3. This array depicts the shape to be rotated in its local space : the shape must be designed in the xOy plane and will be rotated around the Y axis. It's usually a 2D shape, so the Vector3 z coordinates are often set to zero
- radius: number
  is the radius value of the lathe
- tessellation: number
  is the side number of the lathe.
- scene: Scene
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- OptionalsideOrientation: number
  defines the mesh side orientation (https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation)
Returns Mesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateLathe
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49882

`Static`CreateLines

CreateLines(
    name: string,
    points: Vector3[],
    scene: Nullable<Scene>,
    updatable: boolean,
    instance?: Nullable<LinesMesh>,
): LinesMesh
Creates a line mesh..
Parameters
- name: string
  defines the name of the mesh to create
- points: Vector3[]
  is an array successive Vector3
- scene: Nullable<Scene>
  defines the hosting scene
- updatable: boolean
  defines if the mesh must be flagged as updatable
- Optionalinstance: Nullable<LinesMesh>
  is an instance of an existing LineMesh object to be updated with the passed points parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines).
Returns LinesMesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateLines
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49775

`Static`CreatePlane

CreatePlane(
    name: string,
    size: number,
    scene: Scene,
    updatable?: boolean,
    sideOrientation?: number,
): Mesh
Creates a plane mesh.
Parameters
- name: string
  defines the name of the mesh to create
- size: number
  sets the size (float) of both sides of the plane at once (default 1)
- scene: Scene
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- OptionalsideOrientation: number
  defines the mesh side orientation (https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation)
Returns Mesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreatePlane
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49893

`Static`CreatePolygon

CreatePolygon(
    name: string,
    shape: Vector3[],
    scene: Scene,
    holes?: Vector3[][],
    updatable?: boolean,
    sideOrientation?: number,
    earcutInjection?: any,
): Mesh
Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh. The parameter shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors. You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE The mesh can be set to updatable with the boolean parameter updatable (default false) if its internal geometry is supposed to change once created. Remember you can only change the shape positions, not their number when updating a polygon.
Parameters
- name: string
  defines the name of the mesh to create
- shape: Vector3[]
  is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
- scene: Scene
  defines the hosting scene
- Optionalholes: Vector3[][]
  is a required array of arrays of successive Vector3 used to defines holes in the polygon
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- OptionalsideOrientation: number
  defines the mesh side orientation (https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation)
- OptionalearcutInjection: any
  can be used to inject your own earcut reference
Returns Mesh
a new Mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/param#non-regular-polygon

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreatePolygon
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49808

`Static`CreatePolyhedron

CreatePolyhedron(
    name: string,
    options: {
        custom?: any;
        faceColors?: Color4[];
        faceUV?: Vector4[];
        sideOrientation?: number;
        size?: number;
        sizeX?: number;
        sizeY?: number;
        sizeZ?: number;
        type?: number;
        updatable?: boolean;
    },
    scene: Scene,
): Mesh
Creates a polyhedron mesh. .
- The parameter type (positive integer, max 14, default 0) sets the polyhedron type to build among the 15 embedded types. Please refer to the type sheet in the tutorial to choose the wanted type
- The parameter size (positive float, default 1) sets the polygon size
- You can overwrite the size on each dimension bu using the parameters sizeX, sizeY or sizeZ (positive floats, default to size value)
- You can build other polyhedron types than the 15 embbeded ones by setting the parameter custom (polyhedronObject, default null). If you set the parameter custom, this overwrittes the parameter type
- A polyhedronObject is a formatted javascript object. You'll find a full file with pre-set polyhedra here : https://github.com/BabylonJS/Extensions/tree/master/Polyhedron
- You can set the color and the UV of each side of the polyhedron with the parameters faceColors (Color4, default (1, 1, 1, 1)) and faceUV (Vector4, default (0, 0, 1, 1))
- To understand how to set faceUV or faceColors, please read this by considering the right number of faces of your polyhedron, instead of only 6 for the box : https://doc.babylonjs.com/features/featuresDeepDive/materials/using/texturePerBoxFace
- The parameter flat (boolean, default true). If set to false, it gives the polyhedron a single global face, so less vertices and shared normals. In this case, faceColors and faceUV are ignored
- You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
- If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters frontUVs and backUVs (Vector4). Detail here : https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation
- The mesh can be set to updatable with the boolean parameter updatable (default false) if its internal geometry is supposed to change once created
Parameters
- name: string
  defines the name of the mesh to create
- options: {
      custom?: any;
      faceColors?: Color4[];
      faceUV?: Vector4[];
      sideOrientation?: number;
      size?: number;
      sizeX?: number;
      sizeY?: number;
      sizeZ?: number;
      type?: number;
      updatable?: boolean;
  }
  defines the options used to create the mesh
- scene: Scene
  defines the hosting scene
Returns Mesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreatePolyhedron
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49987

`Static`CreateRibbon

CreateRibbon(
    name: string,
    pathArray: Vector3[][],
    closeArray: boolean,
    closePath: boolean,
    offset: number,
    scene?: Scene,
    updatable?: boolean,
    sideOrientation?: number,
    instance?: Mesh,
): Mesh
Creates a ribbon mesh.
Parameters
- name: string
  defines the name of the mesh to create
- pathArray: Vector3[][]
  is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
- closeArray: boolean
  creates a seam between the first and the last paths of the path array (default is false)
- closePath: boolean
  creates a seam between the first and the last points of each path of the path array
- offset: number
  is taken in account only if the pathArray is containing a single path
- Optionalscene: Scene
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- OptionalsideOrientation: number
  defines the mesh side orientation (https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation)
- Optionalinstance: Mesh
  defines an instance of an existing Ribbon object to be updated with the passed pathArray parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#ribbon)
Returns Mesh
a new Mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/param

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateRibbon
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49675

`Static`CreateSphere

CreateSphere(
    name: string,
    segments: number,
    diameter: number,
    scene?: Scene,
    updatable?: boolean,
    sideOrientation?: number,
): Mesh
Creates a sphere mesh.
Parameters
- name: string
  defines the name of the mesh to create
- segments: number
  sets the sphere number of horizontal stripes (positive integer, default 32)
- diameter: number
  sets the diameter size (float) of the sphere (default 1)
- Optionalscene: Scene
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- OptionalsideOrientation: number
  defines the mesh side orientation (https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation)
Returns Mesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateSphere
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49710

`Static`CreateTiledGround

CreateTiledGround(
    name: string,
    xmin: number,
    zmin: number,
    xmax: number,
    zmax: number,
    subdivisions: { h: number; w: number },
    precision: { h: number; w: number },
    scene: Scene,
    updatable?: boolean,
): Mesh
Creates a tiled ground mesh.
Parameters
- name: string
  defines the name of the mesh to create
- xmin: number
  set the ground minimum X coordinate
- zmin: number
  set the ground minimum Y coordinate
- xmax: number
  set the ground maximum X coordinate
- zmax: number
  set the ground maximum Z coordinate
- subdivisions: { h: number; w: number }
  is an object {w: positive integer, h: positive integer} (default {w: 6, h: 6}). w and h are the numbers of subdivisions on the ground width and height. Each subdivision is called a tile
- precision: { h: number; w: number }
  is an object {w: positive integer, h: positive integer} (default {w: 2, h: 2}). w and h are the numbers of subdivisions on the ground width and height of each tile
- scene: Scene
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
Returns Mesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateTiledGround
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49920

`Static`CreateTorus

CreateTorus(
    name: string,
    diameter: number,
    thickness: number,
    tessellation: number,
    scene?: Scene,
    updatable?: boolean,
    sideOrientation?: number,
): Mesh
Creates a torus mesh.
Parameters
- name: string
  defines the name of the mesh to create
- diameter: number
  sets the diameter size (float) of the torus (default 1)
- thickness: number
  sets the diameter size of the tube of the torus (float, default 0.5)
- tessellation: number
  sets the number of torus sides (positive integer, default 16)
- Optionalscene: Scene
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- OptionalsideOrientation: number
  defines the mesh side orientation (https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation)
Returns Mesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateTorus
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49748

`Static`CreateTorusKnot

CreateTorusKnot(
    name: string,
    radius: number,
    tube: number,
    radialSegments: number,
    tubularSegments: number,
    p: number,
    q: number,
    scene?: Scene,
    updatable?: boolean,
    sideOrientation?: number,
): Mesh
Creates a torus knot mesh.
Parameters
- name: string
  defines the name of the mesh to create
- radius: number
  sets the global radius size (float) of the torus knot (default 2)
- tube: number
  sets the diameter size of the tube of the torus (float, default 0.5)
- radialSegments: number
  sets the number of sides on each tube segments (positive integer, default 32)
- tubularSegments: number
  sets the number of tubes to decompose the knot into (positive integer, default 32)
- p: number
  the number of windings on X axis (positive integers, default 2)
- q: number
  the number of windings on Y axis (positive integers, default 3)
- Optionalscene: Scene
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- OptionalsideOrientation: number
  defines the mesh side orientation (https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation)
Returns Mesh
a new Mesh

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateTorusKnot
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49764

`Static`CreateTube

CreateTube(
    name: string,
    path: Vector3[],
    radius: number,
    tessellation: number,
    radiusFunction: (i: number, distance: number) => number,
    cap: number,
    scene: Scene,
    updatable?: boolean,
    sideOrientation?: number,
    instance?: Mesh,
): Mesh
Creates a tube mesh. The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
Parameters
- name: string
  defines the name of the mesh to create
- path: Vector3[]
  is a required array of successive Vector3. It is the curve used as the axis of the tube
- radius: number
  sets the tube radius size
- tessellation: number
  is the number of sides on the tubular surface
- radiusFunction: (i: number, distance: number) => number
  is a custom function. If it is not null, it overrides the parameter radius. This function is called on each point of the tube path and is passed the index i of the i-th point and the distance of this point from the first point of the path
- cap: number
  sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
- scene: Scene
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- OptionalsideOrientation: number
  defines the mesh side orientation (https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation)
- Optionalinstance: Mesh
  is an instance of an existing Tube object to be updated with the passed pathArray parameter (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#tube)
Returns Mesh
a new Mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/param

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.CreateTube
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49964

`Static`ExtendToGoldberg

ExtendToGoldberg(mesh: Mesh): Mesh
Extends a mesh to a Goldberg mesh Warning the mesh to convert MUST be an import of a perviously exported Goldberg mesh
Parameters
- mesh: Mesh
  the mesh to convert
Returns Mesh
the extended mesh

Deprecated
Please use ExtendMeshToGoldberg instead
Inherited from Mesh.ExtendToGoldberg
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50052

`Static`ExtrudePolygon

ExtrudePolygon(
    name: string,
    shape: Vector3[],
    depth: number,
    scene: Scene,
    holes?: Vector3[][],
    updatable?: boolean,
    sideOrientation?: number,
    earcutInjection?: any,
): Mesh
Creates an extruded polygon mesh, with depth in the Y direction..
Parameters
- name: string
  defines the name of the mesh to create
- shape: Vector3[]
  is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
- depth: number
  defines the height of extrusion
- scene: Scene
  defines the hosting scene
- Optionalholes: Vector3[][]
  is a required array of arrays of successive Vector3 used to defines holes in the polygon
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- OptionalsideOrientation: number
  defines the mesh side orientation (https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation)
- OptionalearcutInjection: any
  can be used to inject your own earcut reference
Returns Mesh
a new Mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/param#extruded-non-regular-polygon

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.ExtrudePolygon
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49823

`Static`ExtrudeShape

ExtrudeShape(
    name: string,
    shape: Vector3[],
    path: Vector3[],
    scale: number,
    rotation: number,
    cap: number,
    scene: Nullable<Scene>,
    updatable?: boolean,
    sideOrientation?: number,
    instance?: Mesh,
): Mesh
Creates an extruded shape mesh. The extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
Parameters
- name: string
  defines the name of the mesh to create
- shape: Vector3[]
  is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
- path: Vector3[]
  is a required array of successive Vector3. This is the axis curve the shape is extruded along
- scale: number
  is the value to scale the shape
- rotation: number
  is the angle value to rotate the shape each step (each path point), from the former step (so rotation added each step) along the curve
- cap: number
  sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
- scene: Nullable<Scene>
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- OptionalsideOrientation: number
  defines the mesh side orientation (https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation)
- Optionalinstance: Mesh
  is an instance of an existing ExtrudedShape object to be updated with the passed shape, path, scale or rotation parameters (https://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#extruded-shape)
Returns Mesh
a new Mesh
See
- https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/param
- https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/param#extruded-shapes
Deprecated
Please use MeshBuilder instead
Inherited from Mesh.ExtrudeShape
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49842

`Static`ExtrudeShapeCustom

ExtrudeShapeCustom(
    name: string,
    shape: Vector3[],
    path: Vector3[],
    scaleFunction: Nullable<(i: number, distance: number) => number>,
    rotationFunction: Nullable<(i: number, distance: number) => number>,
    ribbonCloseArray: boolean,
    ribbonClosePath: boolean,
    cap: number,
    scene: Scene,
    updatable?: boolean,
    sideOrientation?: number,
    instance?: Mesh,
): Mesh
Creates an custom extruded shape mesh. The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
Parameters
- name: string
  defines the name of the mesh to create
- shape: Vector3[]
  is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
- path: Vector3[]
  is a required array of successive Vector3. This is the axis curve the shape is extruded along
- scaleFunction: Nullable<(i: number, distance: number) => number>
  is a custom Javascript function called on each path point
- rotationFunction: Nullable<(i: number, distance: number) => number>
  is a custom Javascript function called on each path point
- ribbonCloseArray: boolean
  forces the extrusion underlying ribbon to close all the paths in its pathArray
- ribbonClosePath: boolean
  forces the extrusion underlying ribbon to close its pathArray
- cap: number
  sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
- scene: Scene
  defines the hosting scene
- Optionalupdatable: boolean
  defines if the mesh must be flagged as updatable
- OptionalsideOrientation: number
  defines the mesh side orientation (https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/set#side-orientation)
- Optionalinstance: Mesh
  is an instance of an existing ExtrudedShape object to be updated with the passed shape, path, scale or rotation parameters (https://doc.babylonjs.com/features/featuresDeepDive/mesh/dynamicMeshMorph#extruded-shape)
Returns Mesh
a new Mesh

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/creation/param#extruded-shapes

Deprecated
Please use MeshBuilder instead
Inherited from Mesh.ExtrudeShapeCustom
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49864

`Static`MergeMeshes

MergeMeshes(
    meshes: Mesh[],
    disposeSource?: boolean,
    allow32BitsIndices?: boolean,
    meshSubclass?: Mesh,
    subdivideWithSubMeshes?: boolean,
    multiMultiMaterials?: boolean,
): Nullable<Mesh>
Merge the array of meshes into a single mesh for performance reasons.
Parameters
- meshes: Mesh[]
  array of meshes with the vertices to merge. Entries cannot be empty meshes.
- OptionaldisposeSource: boolean
  when true (default), dispose of the vertices from the source meshes.
- Optionalallow32BitsIndices: boolean
  when the sum of the vertices > 64k, this must be set to true.
- OptionalmeshSubclass: Mesh
  (optional) can be set to a Mesh where the merged vertices will be inserted.
- OptionalsubdivideWithSubMeshes: boolean
  when true (false default), subdivide mesh into subMeshes.
- OptionalmultiMultiMaterials: boolean
  when true (false default), subdivide mesh into subMeshes with multiple materials, ignores subdivideWithSubMeshes.
Returns Nullable<Mesh>
a new mesh
Inherited from Mesh.MergeMeshes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49628

`Static`MergeMeshesAsync

MergeMeshesAsync(
    meshes: Mesh[],
    disposeSource?: boolean,
    allow32BitsIndices?: boolean,
    meshSubclass?: Mesh,
    subdivideWithSubMeshes?: boolean,
    multiMultiMaterials?: boolean,
): Promise<any>
Merge the array of meshes into a single mesh for performance reasons.
Parameters
- meshes: Mesh[]
  array of meshes with the vertices to merge. Entries cannot be empty meshes.
- OptionaldisposeSource: boolean
  when true (default), dispose of the vertices from the source meshes.
- Optionalallow32BitsIndices: boolean
  when the sum of the vertices > 64k, this must be set to true.
- OptionalmeshSubclass: Mesh
  (optional) can be set to a Mesh where the merged vertices will be inserted.
- OptionalsubdivideWithSubMeshes: boolean
  when true (false default), subdivide mesh into subMeshes.
- OptionalmultiMultiMaterials: boolean
  when true (false default), subdivide mesh into subMeshes with multiple materials, ignores subdivideWithSubMeshes.
Returns Promise<any>
a new mesh
Inherited from Mesh.MergeMeshesAsync
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49639

`Static`MinMax

MinMax(meshes: AbstractMesh[]): { max: Vector3; min: Vector3 }
Returns an object containing a min and max Vector3 which are the minimum and maximum vectors of each mesh bounding box from the passed array, in the world coordinates
Parameters
- meshes: AbstractMesh[]
  defines the list of meshes to scan
Returns { max: Vector3; min: Vector3 }
an object {min: Vector3, max: Vector3}
Inherited from Mesh.MinMax
- Defined in .temp/typedoc/docdirectory/doc.d.ts:49605

`Static`Parse

Parse(parsedMesh: any, scene: Scene): LinesMesh
Parses a serialized ground mesh
Parameters
- parsedMesh: any
  the serialized mesh
- scene: Scene
  the scene to create the ground mesh in
Returns LinesMesh
the created ground mesh
Inherited from Mesh.Parse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:50174

`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 Mesh.ParseAnimationRanges
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4793

Class LinesMesh

See

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LinesMesh

Properties

actionManager

See

alpha

alphaIndex

See

alwaysSelectAsActiveMesh

animations

color

cullingStrategy

customMarkAsDirty

decalMap

definedFacingForward

delayLoadingFile

delayLoadState

See

doNotSyncBoundingInfo

edgesColor

See

edgesRenderer

edgesShareWithInstances

edgesWidth

See

ellipsoid

See

ellipsoidOffset

See

enablePointerMoveEvents

forceRenderingWhenOccluded

See

id

ignoreCameraMaxZ

ignoreNonUniformScaling

inspectableCustomProperties

See

instancedBuffers

See

instances

See

intersectionThreshold

isBlocker

See

isNearGrabbable

isNearPickable

isOccluded

See

isOcclusionQueryInProgress

See

isPickable

metadata

name

occlusionQueryAlgorithmType

See

occlusionRetryCount

See

occlusionType

See

onAccessibilityTagChangedObservable

onAfterWorldMatrixUpdateObservable

onCollideObservable

onCollisionPositionChangeObservable

onDisposeObservable

onLODLevelSelection

See

onMaterialChangedObservable

onMeshReadyObservable

onReady

onRebuildObservable

`Optional` `Readonly`useVertexAlpha

`Optional` `Readonly`useVertexColor

`Static` `Readonly`BACKSIDE

`Static`BillboardUseParentOrientation

`Static` `Readonly`BOTTOM

`Static` `Readonly`CAP_ALL

`Static` `Readonly`CAP_END

`Static` `Readonly`CAP_START

`Static` `Readonly`CENTER

`Static` `Readonly`CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY

`Static` `Readonly`CULLINGSTRATEGY_OPTIMISTIC_INCLUSION

`Static` `Readonly`CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY

`Static` `Readonly`CULLINGSTRATEGY_STANDARD

`Static` `Readonly`DEFAULTSIDE

`Static` `Readonly`DOUBLESIDE

`Static` `Readonly`FLIP_N_ROTATE_ROW

`Static` `Readonly`FLIP_N_ROTATE_TILE

`Static` `Readonly`FLIP_ROW

`Static` `Readonly`FLIP_TILE

`Static`ForceGLSL

`Static` `Readonly`FRONTSIDE

`Static`INSTANCEDMESH_SORT_TRANSPARENT

`Static` `Readonly`LEFT

`Static` `Readonly`NO_CAP

`Static` `Readonly`NO_FLIP

`Static`OCCLUSION_ALGORITHM_TYPE_ACCURATE

`Static`OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE

`Static`OCCLUSION_TYPE_NONE

`Static`OCCLUSION_TYPE_OPTIMISTIC

`Static`OCCLUSION_TYPE_STRICT

`Static` `Readonly`RIGHT

`Static` `Readonly`ROTATE_ROW

`Static` `Readonly`ROTATE_TILE

`Static` `Readonly`TOP