InstancedMesh

Creates an instance based on a source mesh.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

absolutePosition

absolutePosition: Vector3

Returns the current mesh absolute position. Returns a Vector3.

actionManager

actionManager: Nullable<ActionManager>

Gets or sets the current action manager

see

http://doc.babylonjs.com/how_to/how_to_use_actions

alphaIndex

alphaIndex: number

Gets or sets the alpha index used to sort transparent meshes

see

http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index

alwaysSelectAsActiveMesh

alwaysSelectAsActiveMesh: boolean

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

animationPropertiesOverride

animationPropertiesOverride: Nullable<AnimationPropertiesOverride>

Gets or sets the animation properties override

animations

animations: Animation[]

Gets a list of Animations associated with the node

applyFog

applyFog: boolean

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

behaviors

behaviors: Behavior<Node>[]

Gets the list of attached behaviors

see

http://doc.babylonjs.com/features/behaviour

billboardMode

billboardMode: number

Set the billboard mode. Default is 0.

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

checkCollisions

checkCollisions: boolean

Gets or sets a boolean indicating that this mesh can be used in the collision engine

see

http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity

collider

collider: Collider

Gets Collider object used to compute collisions (not physics)

see

http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity

collisionGroup

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

collisionMask

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

computeBonesUsingShaders

computeBonesUsingShaders: boolean

Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)

definedFacingForward

definedFacingForward: boolean

Gets or sets the orientation for POV movement & rotation

doNotSerialize

doNotSerialize: boolean

Gets or sets a boolean used to define if the node must be serialized

edgesColor

edgesColor: Color4

Defines edge color used when edgesRenderer is enabled

see

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

edgesRenderer

edgesRenderer: Nullable<EdgesRenderer>

Gets the edgesRenderer associated with the mesh

edgesWidth

edgesWidth: number

Defines edge width used when edgesRenderer is enabled

see

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

ellipsoid

ellipsoid: Vector3

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

see

http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity

ellipsoidOffset

ellipsoidOffset: Vector3

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

see

http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity

enablePointerMoveEvents

enablePointerMoveEvents: boolean

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

facetDepthSortFrom

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

see

http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort

facetNb

facetNb: number

forward

forward: Vector3

The forward direction of that transform in world space.

hasVertexAlpha

hasVertexAlpha: boolean

Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values

id

id: string

Gets or sets the id of the node

ignoreNonUniformScaling

ignoreNonUniformScaling: boolean

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

infiniteDistance

infiniteDistance: boolean

isBlocked

isBlocked: boolean

Returns true if the mesh is blocked. Implemented by child classes

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

http://doc.babylonjs.com/how_to/how_to_use_lens_flares

isFacetDataEnabled

isFacetDataEnabled: boolean

gets a boolean indicating if facetData is enabled

see

http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet

isOccluded

isOccluded: boolean

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

see

http://doc.babylonjs.com/features/occlusionquery

isOcclusionQueryInProgress

isOcclusionQueryInProgress: boolean

Flag to check the progress status of the query

see

http://doc.babylonjs.com/features/occlusionquery

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

isVisible

isVisible: boolean

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

isWorldMatrixFrozen

isWorldMatrixFrozen: boolean

True if the World matrix has been frozen. Returns a boolean.

layerMask

layerMask: number

Gets or sets the current layer mask (default is 0x0FFFFFFF)

see

http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures

material

material: Nullable<Material>

metadata

metadata: any

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

mustDepthSortFacets

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

see

http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort

name

name: string

Gets or sets the name of the node

nonUniformScaling

nonUniformScaling: boolean

numBoneInfluencers

numBoneInfluencers: number

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

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

http://doc.babylonjs.com/features/occlusionquery

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 retireved, the query result indicates if the object is visible within the scene or not and based on that Babylon.Js engine decideds to show or hide the object. The default value is -1 which means don't break the query and wait till the result

see

http://doc.babylonjs.com/features/occlusionquery

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 whith 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

http://doc.babylonjs.com/features/occlusionquery

onAfterWorldMatrixUpdateObservable

onAfterWorldMatrixUpdateObservable: Observable<TransformNode>

An event triggered after the world matrix is updated

onCollide

onCollide: function

Set a function to call when this mesh collides with another one

Type declaration

    • (): void
    • Returns void

onCollideObservable

onCollideObservable: Observable<AbstractMesh>

An event triggered when this mesh collides with another one

onCollisionPositionChange

onCollisionPositionChange: function

Set a function to call when the collision's position changes

Type declaration

    • (): void
    • Returns void

onCollisionPositionChangeObservable

onCollisionPositionChangeObservable: Observable<Vector3>

An event triggered when the collision's position changes

onDispose

onDispose: function

Sets a callback that will be raised when the node will be disposed

Type declaration

    • (): void
    • Returns void

onDisposeObservable

onDisposeObservable: Observable<Node>

An event triggered when the mesh is disposed

onMaterialChangedObservable

onMaterialChangedObservable: Observable<AbstractMesh>

An event triggered when material is changed

onReady

onReady: function

Callback raised when the node is ready to be used

Type declaration

    • (node: Node): void
    • Parameters

      Returns void

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

parent

parent: Nullable<Node>

Gets or sets the parent of the node

partitioningBBoxRatio

partitioningBBoxRatio: number

The ratio (float) to apply to the bouding box size to set to the partioning space. Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box

see

http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning

partitioningSubdivisions

partitioningSubdivisions: number

Gets or set the number (integer) of subdivisions per axis in the partioning space

see

http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning

physicsImpostor

physicsImpostor: Nullable<PhysicsImpostor>

Gets or sets impostor used for physic simulation

see

http://doc.babylonjs.com/features/physics_engine

position

position: Vector3

receiveShadows

receiveShadows: boolean

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

renderingGroupId

renderingGroupId: number

right

right: Vector3

The right direction of that transform in world space.

rotation

rotation: Vector3

Rotation property : a Vector3 depicting the rotation value in radians around each local axis X, Y, Z. If rotation quaternion is set, this Vector3 will (almost always) be the Zero vector! Default : (0.0, 0.0, 0.0)

rotationQuaternion

rotationQuaternion: Nullable<Quaternion>

Rotation Quaternion property : this a Quaternion object depicting the mesh rotation by using a unit quaternion. It's null by default. If set, only the rotationQuaternion is then used to compute the mesh rotation and its property `.rotation\ is then ignored and set to (0.0, 0.0, 0.0)

scaling

scaling: Vector3

Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)

scalingDeterminant

scalingDeterminant: number

showSubMeshesBoundingBox

showSubMeshesBoundingBox: boolean

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

skeleton

skeleton: Nullable<Skeleton>

sourceMesh

sourceMesh: Mesh

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

http://doc.babylonjs.com/how_to/multi_materials

uniqueId

uniqueId: number

Gets or sets the unique id of the node

up

The up direction of that transform in world space.

useBones

useBones: boolean

Gets a boolean indicating if this mesh has skinning data and an attached skeleton

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)

useVertexColors

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)

visibility

visibility: number

worldMatrixFromCache

worldMatrixFromCache: Matrix

Returns directly the latest state of the mesh World matrix. A Matrix is returned.

Static BILLBOARDMODE_ALL

BILLBOARDMODE_ALL: number

Billboard on all axes

Static BILLBOARDMODE_NONE

BILLBOARDMODE_NONE: number

No billboard

Static BILLBOARDMODE_X

BILLBOARDMODE_X: number

Billboard on X axis

Static BILLBOARDMODE_Y

BILLBOARDMODE_Y: number

Billboard on Y axis

Static BILLBOARDMODE_Z

BILLBOARDMODE_Z: number

Billboard on Z axis

Static OCCLUSION_ALGORITHM_TYPE_ACCURATE

OCCLUSION_ALGORITHM_TYPE_ACCURATE: number

Use an accurante 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 optimisitic

Static OCCLUSION_TYPE_STRICT

OCCLUSION_TYPE_STRICT: number

Occlusion set to strict

Static showBoundingBox

showBoundingBox: boolean

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

Methods

addBehavior

addChild

addRotation

  • 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. Returns the TransformNode.

    Parameters

    • x: number
    • y: number
    • z: number

    Returns TransformNode

alignWithNormal

  • Align the mesh with a normal

    Parameters

    • normal: Vector3

      defines the normal to use

    • Optional upDirection: Vector3

      can be used to redefined the up vector to use (will use the (0, 1, 0) by default)

    Returns AbstractMesh

    the current mesh

applyImpulse

attachToBone

  • 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

beginAnimation

  • beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: function): Nullable<Animatable>
  • Will start the animation sequence

    Parameters

    • name: string

      defines the range frames for animation sequence

    • Optional loop: boolean

      defines if the animation should loop (false by default)

    • Optional speedRatio: number

      defines the speed factor in which to run the animation (1 by default)

    • Optional onAnimationEnd: function

      defines a function to be executed when the animation ended (undefined by default)

        • (): void
        • Returns void

    Returns Nullable<Animatable>

    the object created for this animation. If range does not exist, it will return null

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

    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

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.

    Parameters

    • flipBack: number

      defines the flip

    • twirlClockwise: number

      defines the twirl

    • tiltRight: number

      defines the tilt

    Returns Vector3

    the new rotation vector

clone

  • Creates a new InstancedMesh from the current mesh.

    • name (string) : the cloned mesh name
    • newParent (optional Node) : the optional Node to parent the clone to.
    • doNotCloneChildren (optional boolean, default false) : if true the model children aren't cloned.

    Returns the clone.

    Parameters

    • name: string
    • newParent: Node
    • Optional doNotCloneChildren: boolean

    Returns InstancedMesh

computeWorldMatrix

  • computeWorldMatrix(force?: boolean): Matrix
  • Computes the mesh World matrix and returns it. If the mesh world matrix is frozen, this computation does nothing more than returning the last frozen values. If the parameter force is let to false (default), the current cached World matrix is returned. If the parameter forceis set to true, the actual computation is done. Returns the mesh World Matrix.

    Parameters

    • Optional force: boolean

    Returns Matrix

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

createNormals

  • 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

createOrUpdateSubmeshesOctree

  • createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>

deleteAnimationRange

  • deleteAnimationRange(name: string, deleteFrames?: boolean): void
  • Delete a specific animation range

    Parameters

    • name: string

      defines the name of the range to delete

    • Optional deleteFrames: boolean

      defines if animation frames from the range must be deleted as well

    Returns void

detachFromBone

disableEdgesRendering

disableFacetData

dispose

  • dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void
  • Disposes the InstancedMesh. Returns nothing.

    Parameters

    • Optional doNotRecurse: boolean
    • Optional disposeMaterialAndTextures: boolean

    Returns void

enableEdgesRendering

  • enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh

freezeWorldMatrix

getAbsolutePivotPoint

getAbsolutePivotPointToRef

getAbsolutePosition

getAnimationByName

  • 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

getAnimationRange

  • 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

getBehaviorByName

getBoundingInfo

getChildMeshes

  • getChildMeshes(directDescendantsOnly?: boolean, predicate?: function): AbstractMesh[]
  • Get all child-meshes of this node

    Parameters

    • Optional directDescendantsOnly: 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

    • Optional predicate: function

      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

        • (node: Node): boolean
        • Parameters

          Returns boolean

    Returns AbstractMesh[]

    an array of {BABYLON.AbstractMesh}

getChildTransformNodes

  • getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: function): TransformNode[]
  • Get all child-transformNodes of this node

    Parameters

    • Optional directDescendantsOnly: 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

    • Optional predicate: function

      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

        • (node: Node): boolean
        • Parameters

          Returns boolean

    Returns TransformNode[]

    an array of {BABYLON.TransformNode}

getChildren

  • getChildren(predicate?: function): Node[]
  • Get all direct children of this node

    Parameters

    • Optional predicate: function

      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

        • (node: Node): boolean
        • Parameters

          Returns boolean

    Returns Node[]

    an array of {BABYLON.Node}

getClassName

  • getClassName(): string

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

    see

    http://doc.babylonjs.com/how_to/how_to_use_facetdata

    Parameters

    • x: number

      defines x coordinate

    • y: number

      defines y coordinate

    • z: number

      defines z coordinate

    • Optional projected: Vector3

      sets as the (x,y,z) world projection on the facet

    • Optional checkFace: 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

    • Optional facing: 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)

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

    see

    http://doc.babylonjs.com/how_to/how_to_use_facetdata

    Parameters

    • x: number

      defines x coordinate

    • y: number

      defines y coordinate

    • z: number

      defines z coordinate

    • Optional projected: Vector3

      sets as the (x,y,z) local projection on the facet

    • Optional checkFace: 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

    • Optional facing: 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)

getDescendants

  • getDescendants(directDescendantsOnly?: boolean, predicate?: function): Node[]
  • Will return all nodes that have this node as ascendant

    Parameters

    • Optional directDescendantsOnly: 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

    • Optional predicate: function

      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

        • (node: Node): boolean
        • Parameters

          Returns boolean

    Returns Node[]

    all children nodes of all types

getDirection

  • Returns a new Vector3 what is the localAxis, expressed in the mesh local space, rotated like the mesh. This Vector3 is expressed in the World space.

    Parameters

    Returns Vector3

getDirectionToRef

  • 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 Wordl space from the mesh World matrix. Returns the TransformNode.

    Parameters

    Returns TransformNode

getDistanceToCamera

getEngine

getFacetDataParameters

  • getFacetDataParameters(): any

getFacetLocalNormals

  • getFacetLocalNormals(): Vector3[]

getFacetLocalPartitioning

  • getFacetLocalPartitioning(): number[][]

getFacetLocalPositions

  • getFacetLocalPositions(): Vector3[]

getFacetNormal

  • getFacetNormal(i: number): Vector3

getFacetNormalToRef

  • getFacetNormalToRef(i: number, ref: Vector3): this

getFacetPosition

  • getFacetPosition(i: number): Vector3

getFacetPositionToRef

getFacetsAtLocalCoordinates

  • getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>

getHierarchyBoundingVectors

  • getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<function>): object
  • Return the minimum and maximum world vectors of the entire hierarchy under current mesh

    Parameters

    • Optional includeDescendants: boolean

      Include bounding info from descendants as well (true by default)

    • Optional predicate: Nullable<function>

      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 object

    the new bounding vectors

getIndices

getLOD

getPhysicsImpostor

getPivotMatrix

getPivotPoint

getPivotPointToRef

getPoseMatrix

getPositionExpressedInLocalSpace

  • getPositionExpressedInLocalSpace(): Vector3

getPositionInCameraSpace

getScene

  • Gets the scene of the node

    Returns Scene

    a {BABYLON.Scene}

getTotalVertices

  • getTotalVertices(): number

getVerticesData

  • Returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.

    Parameters

    • kind: string
    • Optional copyWhenShared: boolean

    Returns Nullable<FloatArray>

getWorldMatrix

intersects

intersectsMesh

  • True if the mesh intersects another mesh or a SolidParticle object

    Parameters

    • mesh: AbstractMesh | SolidParticle

      defines a target mesh or SolidParticle to test

    • Optional precise: 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)

    • Optional includeDescendants: 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

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

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

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

isDisposed

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

    Returns boolean

    true if the node was disposed

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

    • Optional checkAncestors: 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

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

isReady

  • isReady(completeCheck?: boolean): boolean
  • Is this node ready to be used/rendered

    Parameters

    • Optional completeCheck: boolean

      defines if a complete check (including materials and lights) has to be done (false by default)

    Returns boolean

    is it ready

isVerticesDataPresent

  • isVerticesDataPresent(kind: string): boolean

locallyTranslate

lookAt

  • 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

    • Optional yawCor: number

      optional yaw (y-axis) correction in radians

    • Optional pitchCor: number

      optional pitch (x-axis) correction in radians

    • Optional rollCor: number

      optional roll (z-axis) correction in radians

    • Optional space: Space

      the choosen space of the target

    Returns TransformNode

    the TransformNode.

markAsDirty

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

    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

moveWithCollisions

normalizeToUnitCube

  • normalizeToUnitCube(includeDescendants?: boolean): AbstractMesh
  • Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)

    Parameters

    • Optional includeDescendants: boolean

      Use the hierarchy's bounding box instead of the mesh's bounding box

    Returns AbstractMesh

    the current mesh

refreshBoundingInfo

  • Sets a new updated BoundingInfo to the mesh. Returns the mesh.

    Returns InstancedMesh

registerAfterWorldMatrixUpdate

releaseSubMeshes

removeBehavior

removeChild

rotate

  • 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 BABYLON.Space.LOCAL, either BABYLON.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. Returns the TransformNode.

    Parameters

    Returns TransformNode

rotateAround

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

    Parameters

    • flipBack: number

      defines the flip

    • twirlClockwise: number

      defines the twirl

    • tiltRight: number

      defines the tilt

    Returns AbstractMesh

    the current mesh

serialize

  • serialize(currentSerializationObject?: any): any

serializeAnimationRanges

  • serializeAnimationRanges(): any

setAbsolutePosition

setBoundingInfo

setEnabled

  • setEnabled(value: boolean): void
  • Set the enabled state of this node

    Parameters

    • value: boolean

      defines the new enabled state

    Returns void

setIndices

  • Sets the mesh indices. Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array). If the mesh has no geometry, a new Geometry object is created and set to the mesh. This method creates a new index buffer each call. Returns the Mesh.

    Parameters

    Returns Mesh

setParent

  • 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 Returns the TransformNode.

    Parameters

    Returns TransformNode

setPhysicsLinkWith

setPivotMatrix

  • Sets a new pivot matrix to the current node

    Parameters

    • matrix: Matrix

      defines the new pivot matrix to use

    • Optional postMultiplyPivotMatrix: 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

setPivotPoint

  • Sets a new pivot point to the current node

    Parameters

    • point: Vector3

      defines the new pivot point to use

    • Optional space: Space

      defines if the point is in world or local space (local by default)

    Returns TransformNode

    the current TransformNode

setPositionWithLocalVector

setPreTransformMatrix

setVerticesData

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

    Possible kind values :

    • BABYLON.VertexBuffer.PositionKind
    • BABYLON.VertexBuffer.UVKind
    • BABYLON.VertexBuffer.UV2Kind
    • BABYLON.VertexBuffer.UV3Kind
    • BABYLON.VertexBuffer.UV4Kind
    • BABYLON.VertexBuffer.UV5Kind
    • BABYLON.VertexBuffer.UV6Kind
    • BABYLON.VertexBuffer.ColorKind
    • BABYLON.VertexBuffer.MatricesIndicesKind
    • BABYLON.VertexBuffer.MatricesIndicesExtraKind
    • BABYLON.VertexBuffer.MatricesWeightsKind
    • BABYLON.VertexBuffer.MatricesWeightsExtraKind

    Returns the Mesh.

    Parameters

    • kind: string
    • data: FloatArray
    • Optional updatable: boolean
    • Optional stride: number

    Returns Mesh

toString

  • toString(fullDetails?: boolean): string
  • Gets a string representation of the current mesh

    Parameters

    • Optional fullDetails: boolean

      defines a boolean indicating if full details must be included

    Returns string

    a string representation of the current mesh

translate

  • Translates the mesh along the axis vector for the passed distance in the given space. space (default LOCAL) can be either BABYLON.Space.LOCAL, either BABYLON.Space.WORLD. Returns the TransformNode.

    Parameters

    Returns TransformNode

unfreezeWorldMatrix

  • unfreezeWorldMatrix(): this

unregisterAfterWorldMatrixUpdate

  • unregisterAfterWorldMatrixUpdate(func: function): TransformNode

updateFacetData

  • 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

    see

    http://doc.babylonjs.com/how_to/how_to_use_facetdata

    Returns AbstractMesh

    the current mesh

updateIndices

updatePoseMatrix

updateVerticesData

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

    Possible kind values :

    • BABYLON.VertexBuffer.PositionKind
    • BABYLON.VertexBuffer.UVKind
    • BABYLON.VertexBuffer.UV2Kind
    • BABYLON.VertexBuffer.UV3Kind
    • BABYLON.VertexBuffer.UV4Kind
    • BABYLON.VertexBuffer.UV5Kind
    • BABYLON.VertexBuffer.UV6Kind
    • BABYLON.VertexBuffer.ColorKind
    • BABYLON.VertexBuffer.MatricesIndicesKind
    • BABYLON.VertexBuffer.MatricesIndicesExtraKind
    • BABYLON.VertexBuffer.MatricesWeightsKind
    • BABYLON.VertexBuffer.MatricesWeightsExtraKind

    Returns the Mesh.

    Parameters

    • kind: string
    • data: FloatArray
    • Optional updateExtends: boolean
    • Optional makeItUnique: boolean

    Returns Mesh

Static AddNodeConstructor

  • 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

Static Construct

  • Construct(type: string, name: string, scene: Scene, options?: any): Nullable<function>
  • 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

    • Optional options: any

      defines optional options to transmit to constructors

    Returns Nullable<function>

    the new constructor or null

Static Parse

  • Returns a new TransformNode object parsed from the source provided. The parameter parsedMesh is the source. The parameter rootUrl is a string, it's the root URL to prefix the delayLoadingFile property with

    Parameters

    • parsedTransformNode: any
    • scene: Scene
    • rootUrl: string

    Returns TransformNode

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

Generated using TypeDoc