TextureDome | Babylon.js API documentation

Class TextureDome<T>`Abstract`

Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes. As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene. This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere. Potential additions to this helper include zoom and and non-infinite distance rendering effects.

Type Parameters

T extends Texture

Hierarchy (View Summary)

TransformNode
- TextureDome
  - VideoDome
  - PhotoDome

Index

Constructors

constructor

Methods

addBehavior addChild addRotation applyAngularImpulse applyImpulse attachToBone beginAnimation clone computeWorldMatrix createAnimationRange deleteAnimationRange detachFromBone dispose freezeWorldMatrix getAbsolutePivotPoint getAbsolutePivotPointToRef getAbsolutePosition getAnimationByName getAnimationRange getAnimationRanges getBehaviorByName getChildMeshes getChildren getChildTransformNodes getClassName getDescendants getDirection getDirectionToRef getDistanceToCamera getEngine getHierarchyBoundingVectors getPhysicsBody getPivotMatrix getPivotPoint getPivotPointToRef getPoseMatrix getPositionExpressedInLocalSpace getPositionInCameraSpace getScene getWorldMatrix instantiateHierarchy isDescendantOf isDisposed isEnabled isReady isUsingPivotMatrix isUsingPostMultiplyPivotMatrix isWorldMatrixCameraDependent locallyTranslate lookAt markAsDirty normalizeToUnitCube registerAfterWorldMatrixUpdate removeBehavior removeChild resetLocalMatrix rotate rotateAround serialize serializeAnimationRanges setAbsolutePosition setDirection setEnabled setParent setPivotMatrix setPivotPoint setPositionWithLocalVector setPreTransformMatrix translate unfreezeWorldMatrix unregisterAfterWorldMatrixUpdate updatePoseMatrix AddNodeConstructor Construct Parse ParseAnimationRanges

Constructors

constructor

new TextureDome<T extends Texture>(
    name: string,
    textureUrlOrElement: string | string[] | HTMLVideoElement,
    options: {
        autoPlay?: boolean;
        clickToPlay?: boolean;
        crossEyeMode?: boolean;
        faceForward?: boolean;
        generateMipMaps?: boolean;
        halfDomeMode?: boolean;
        loop?: boolean;
        mesh?: Mesh;
        poster?: string;
        resolution?: number;
        size?: number;
        useDirectMapping?: boolean;
    },
    scene: Scene,
    onError?: Nullable<(message?: string, exception?: any) => void>,
): TextureDome<T>
Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
Type Parameters
- T extends Texture
Parameters
- name: string
  Element's name, child elements will append suffixes for their own names.
- textureUrlOrElement: string | string[] | HTMLVideoElement
  defines the url(s) or the (video) HTML element to use
- options: {
      autoPlay?: boolean;
      clickToPlay?: boolean;
      crossEyeMode?: boolean;
      faceForward?: boolean;
      generateMipMaps?: boolean;
      halfDomeMode?: boolean;
      loop?: boolean;
      mesh?: Mesh;
      poster?: string;
      resolution?: number;
      size?: number;
      useDirectMapping?: boolean;
  }
  An object containing optional or exposed sub element properties
- scene: Scene
- OptionalonError: Nullable<(message?: string, exception?: any) => void>
Returns TextureDome<T>
Overrides TransformNode.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97559

Properties

animations

animations: Animation[]

Gets a list of Animations associated with the node

customMarkAsDirty

customMarkAsDirty: () => void

Allow user to specify custom mechanism for mark as dirty

id

id: string

Gets or sets the id of the node

ignoreNonUniformScaling

ignoreNonUniformScaling: boolean

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

inspectableCustomProperties

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

See

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

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

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

onDisposeObservable

onDisposeObservable: Observable<Node>

An event triggered when the mesh is disposed

onLoadErrorObservable

onLoadErrorObservable: Observable<string>

Observable raised when an error occurred while loading the texture

onLoadObservable

onLoadObservable: Observable<void>

Observable raised when the texture finished loading

onReady

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

Callback raised when the node is ready to be used

physicsBody

physicsBody: Nullable<PhysicsBody>

See

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

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

state

state: string

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

uniqueId

uniqueId: number

Gets or sets the unique id of the node

`Static`BILLBOARDMODE_ALL

BILLBOARDMODE_ALL: number

Object will rotate to face the camera

`Static`BILLBOARDMODE_NONE

BILLBOARDMODE_NONE: number

Object will not rotate to face the camera

`Static`BILLBOARDMODE_USE_POSITION

BILLBOARDMODE_USE_POSITION: number

Object will rotate to face the camera's position instead of orientation

`Static`BILLBOARDMODE_X

BILLBOARDMODE_X: number

Object will rotate to face the camera but only on the x axis

`Static`BILLBOARDMODE_Y

BILLBOARDMODE_Y: number

Object will rotate to face the camera but only on the y axis

`Static`BILLBOARDMODE_Z

BILLBOARDMODE_Z: number

Object will rotate to face the camera but only on the z axis

`Static`BillboardUseParentOrientation

BillboardUseParentOrientation: boolean

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

`Static` `Readonly`MODE_MONOSCOPIC

MODE_MONOSCOPIC: 0

Define the source as a Monoscopic panoramic 360/180.

`Static` `Readonly`MODE_SIDEBYSIDE

MODE_SIDEBYSIDE: 2

Define the source as a Stereoscopic Side by Side panoramic 360/180.

`Static` `Readonly`MODE_TOPBOTTOM

MODE_TOPBOTTOM: 1

Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.

Accessors

absolutePosition

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

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

absoluteRotationQuaternion

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

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

absoluteScaling

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

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

accessibilityTag

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

animationPropertiesOverride

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

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

behaviors

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

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

billboardMode

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

Value Type Description

0 BILLBOARDMODE_NONE

1 BILLBOARDMODE_X

2 BILLBOARDMODE_Y

4 BILLBOARDMODE_Z

7 BILLBOARDMODE_ALL

Returns number
Inherited from TransformNode.billboardMode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46205
set billboardMode(value: number): void
Parameters
- value: number
Returns void
Inherited from TransformNode.billboardMode
- 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

crossEye

get crossEye(): boolean
Is it a cross-eye texture?

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97522
set crossEye(enabled: boolean): void
Set the cross-eye mode. If set, images that can be seen when crossing eyes will render correctly
Parameters
- enabled: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97518

doNotSerialize

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

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

forward

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

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

fovMultiplier

get fovMultiplier(): number
The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out". Also see the options.resolution property.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97490
set fovMultiplier(value: number): void
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97491

halfDome

get halfDome(): boolean
Is it a 180 degrees dome (half dome) or 360 texture (full dome)

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97510
set halfDome(enabled: boolean): void
Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
Parameters
- enabled: boolean
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97514

infiniteDistance

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

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

isWorldMatrixFrozen

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

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

material

get material(): BackgroundMaterial
The background material of this dome.

Returns BackgroundMaterial
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97526

mesh

get mesh(): Mesh
Gets the mesh used for the dome.

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

nonUniformScaling

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

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

onClonedObservable

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

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

onDispose

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

onEnabledStateChangedObservable

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

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

parent

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

position

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

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

right

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

Returns Vector3
Inherited from TransformNode.right
- 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
Inherited from TransformNode.rotation
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46277
set rotation(newRotation: Vector3): void
Parameters
- newRotation: Vector3
Returns void
Inherited from TransformNode.rotation
- 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>
Inherited from TransformNode.rotationQuaternion
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46288
set rotationQuaternion(quaternion: Nullable<Quaternion>): void
Parameters
- quaternion: Nullable<Quaternion>
Returns void
Inherited from TransformNode.rotationQuaternion
- 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
Inherited from TransformNode.scaling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46282
set scaling(newScaling: Vector3): void
Parameters
- newScaling: Vector3
Returns void
Inherited from TransformNode.scaling
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46283

texture

get texture(): T
Gets the texture being displayed on the sphere

Returns T
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97465
set texture(newTexture: T): void
Sets the texture being displayed on the sphere
Parameters
- newTexture: T
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97469

textureMode

get textureMode(): number
Gets or set the current texture mode for the texture. It can be:
- TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
- TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
- TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97499
set textureMode(value: number): void
Sets the current texture mode for the texture. It can be:
- TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
- TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
- TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
Parameters
- value: number
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97506

up

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

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

worldMatrixFromCache

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

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

Methods

addBehavior

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

See
https://doc.babylonjs.com/features/featuresDeepDive/behaviors
Inherited from TransformNode.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 TransformNode.addChild
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46506

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

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

applyImpulse

applyImpulse(force: Vector3, contactPoint: Vector3): TransformNode
Apply a physic impulse to the mesh
Parameters
- force: Vector3
  defines the force to apply
- contactPoint: Vector3
  defines where to apply the force
Returns TransformNode
the current mesh
Inherited from TransformNode.applyImpulse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:27204

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

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

clone

clone(
    name: string,
    newParent: Nullable<Node>,
    doNotCloneChildren?: boolean,
): Nullable<TransformNode>
Clone the current transform node
Parameters
- name: string
  Name of the new clone
- newParent: Nullable<Node>
  New parent for the clone
- OptionaldoNotCloneChildren: boolean
  Do not clone children hierarchy
Returns Nullable<TransformNode>
the new transform node
Inherited from TransformNode.clone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46641

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

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

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

dispose

dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void
Releases resources associated with this node.
Parameters
- OptionaldoNotRecurse: boolean
  Set to true to not recurse into each children (recurse into each children by default)
- OptionaldisposeMaterialAndTextures: boolean
  Set to true to also dispose referenced materials and textures (false by default)
Returns void
Overrides TransformNode.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:97580

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

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

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

getClassName

getClassName(): string
Gets a string identifying the name of the class

Returns string
"TransformNode" string
Inherited from TransformNode.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46258

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

getEngine

getEngine(): AbstractEngine
Gets the engine of the node

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

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

getPhysicsBody

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

getPivotMatrix

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

Returns Matrix
the matrix
Inherited from TransformNode.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 TransformNode.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 TransformNode.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 TransformNode.getPoseMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46317

getPositionExpressedInLocalSpace

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

Returns Vector3
a new Vector3.
Inherited from TransformNode.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 TransformNode.getPositionInCameraSpace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46627

getScene

getScene(): Scene
Gets the scene of the node

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

getWorldMatrix

getWorldMatrix(): Matrix
Returns the latest update of the World matrix

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

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

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

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
true if the node is ready
Inherited from TransformNode.isReady
- Defined in .temp/typedoc/docdirectory/doc.d.ts:4645

isUsingPivotMatrix

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

Returns boolean
true if a pivot matrix is used
Inherited from TransformNode.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 TransformNode.isUsingPostMultiplyPivotMatrix
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46272

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

markAsDirty

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

normalizeToUnitCube

normalizeToUnitCube(
    includeDescendants?: boolean,
    ignoreRotation?: boolean,
    predicate?: Nullable<(node: AbstractMesh) => boolean>,
): TransformNode
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 TransformNode
the current mesh
Inherited from TransformNode.normalizeToUnitCube
- Defined in .temp/typedoc/docdirectory/doc.d.ts:46676

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

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

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

serialize

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

serializeAnimationRanges

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

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

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

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

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

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

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

unfreezeWorldMatrix

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

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

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

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

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

`Static`Construct

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

`Static`Parse

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

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

Class TextureDome<T>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TextureDome<T>

Properties

animations

customMarkAsDirty

id

ignoreNonUniformScaling

inspectableCustomProperties

See

metadata

name

onAccessibilityTagChangedObservable

onAfterWorldMatrixUpdateObservable

onDisposeObservable

onLoadErrorObservable

onLoadObservable

onReady

physicsBody

See

reIntegrateRotationIntoRotationQuaternion

reservedDataStore

scalingDeterminant

state

uniqueId

StaticBILLBOARDMODE_ALL

StaticBILLBOARDMODE_NONE

StaticBILLBOARDMODE_USE_POSITION

StaticBILLBOARDMODE_X

StaticBILLBOARDMODE_Y

StaticBILLBOARDMODE_Z

StaticBillboardUseParentOrientation

Static ReadonlyMODE_MONOSCOPIC

Static ReadonlyMODE_SIDEBYSIDE

Static ReadonlyMODE_TOPBOTTOM

Accessors

absolutePosition

Returns Vector3

absoluteRotationQuaternion

Returns Quaternion

absoluteScaling

Returns Vector3

accessibilityTag

Returns Nullable<IAccessibilityTag>

Parameters

Returns void

animationPropertiesOverride

Returns Nullable<AnimationPropertiesOverride>

Parameters

Returns void

behaviors

Returns Behavior<Node>[]

See

billboardMode

Returns number

Parameters

Returns void

crossEye

Returns boolean

Parameters

Returns void

doNotSerialize

Returns boolean

Parameters

Returns void

forward

Returns Vector3

fovMultiplier

Returns number

Parameters

Class TextureDome<T>`Abstract`

`Static`BILLBOARDMODE_ALL

`Static`BILLBOARDMODE_NONE

`Static`BILLBOARDMODE_USE_POSITION

`Static`BILLBOARDMODE_X

`Static`BILLBOARDMODE_Y

`Static`BILLBOARDMODE_Z

`Static`BillboardUseParentOrientation

`Static` `Readonly`MODE_MONOSCOPIC

`Static` `Readonly`MODE_SIDEBYSIDE

`Static` `Readonly`MODE_TOPBOTTOM