import {SceneModelTransform} from '@xeokit/xeokit-sdk/src/viewer/scene/model/SceneModelTransform.js'

public class | source

SceneModelTransform

A dynamically-updatable transform within a SceneModel.

Can be composed into hierarchies
Shared by multiple SceneModelMeshes
Created with SceneModel#createTransform
Stored by ID in SceneModel#transforms
Referenced by SceneModelMesh#transform

Member Summary

Public Members
public	id: * Unique ID of this SceneModelTransform.
public set	matrix: Number[] Sets the SceneModelTransform's transform matrix. Default value is `[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]`.
public get	matrix: Number[] Gets the SceneModelTransform's transform matrix. Default value is `[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]`.
public get	meshes: []: * The SceneModelMeshes transformed by this SceneModelTransform.
public get	parentTransform: SceneModelTransform The optional parent SceneModelTransform.
public set	position: Number[] Sets the SceneModelTransform's local translation. Default value is `[0,0,0]`.
public get	position: Number[] Gets the SceneModelTransform's translation. Default value is `[0,0,0]`.
public set	quaternion: Number[] Sets the SceneModelTransform's rotation quaternion. Default value is `[0,0,0,1]`.
public get	quaternion: Number[] Gets the SceneModelTransform's rotation quaternion. Default value is `[0,0,0,1]`.
public set	rotation: Number[] Sets the SceneModelTransform's rotation, as Euler angles given in degrees, for each of the X, Y and Z axis. Default value is `[0,0,0]`.
public get	rotation: Number[] Gets the SceneModelTransform's rotation, as Euler angles given in degrees, for each of the X, Y and Z axis. Default value is `[0,0,0]`.
public set	scale: Number[] Sets the SceneModelTransform's scale. Default value is `[1,1,1]`.
public get	scale: Number[] Gets the SceneModelTransform's scale. Default value is `[1,1,1]`.
public get	worldMatrix: Number[] Gets the SceneModelTransform's World matrix.

Method Summary

Public Methods
public	rotate(axis: Number[], angle: Number): * Rotates the SceneModelTransform about the given axis by the given increment.
public	rotateOnWorldAxis(axis: Number[], angle: Number): * Rotates the SceneModelTransform about the given World-space axis by the given increment.
public	rotateX(angle: Number): * Rotates the SceneModelTransform about the local X-axis by the given increment.
public	rotateY(angle: Number): * Rotates the SceneModelTransform about the local Y-axis by the given increment.
public	rotateZ(angle: Number): * Rotates the SceneModelTransform about the local Z-axis by the given increment.
public	translate(axis: Number[], distance: Number): * Translates the SceneModelTransform along the local axis by the given increment.
public	translateX(distance: Number): * Translates the SceneModelTransform along the local X-axis by the given increment.
public	translateY(distance: Number): * Translates the SceneModelTransform along the local Y-axis by the given increment.
public	translateZ(distance: Number): * Translates the SceneModelTransform along the local Z-axis by the given increment.

Public Members

public id: * source

Unique ID of this SceneModelTransform.

The SceneModelTransform is registered against this ID in SceneModel#transforms.

public set matrix: Number[] source

Sets the SceneModelTransform's transform matrix.

Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].

public get matrix: Number[] source

Gets the SceneModelTransform's transform matrix.

Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].

public get meshes: []: * source

The SceneModelMeshes transformed by this SceneModelTransform.

Return:

[]

public get parentTransform: SceneModelTransform source

The optional parent SceneModelTransform.

public set position: Number[] source

Sets the SceneModelTransform's local translation.

Default value is [0,0,0].

public get position: Number[] source

Gets the SceneModelTransform's translation.

Default value is [0,0,0].

public set quaternion: Number[] source

Sets the SceneModelTransform's rotation quaternion.

Default value is [0,0,0,1].

public get quaternion: Number[] source

Gets the SceneModelTransform's rotation quaternion.

Default value is [0,0,0,1].

public set rotation: Number[] source

Sets the SceneModelTransform's rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.

Default value is [0,0,0].

public get rotation: Number[] source

Gets the SceneModelTransform's rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.

Default value is [0,0,0].

public set scale: Number[] source

Sets the SceneModelTransform's scale.

Default value is [1,1,1].

public get scale: Number[] source

Gets the SceneModelTransform's scale.

Default value is [1,1,1].

public get worldMatrix: Number[] source

Gets the SceneModelTransform's World matrix.

Properties:

Name	Type	Attribute	Description
worldMatrix	*

Public Methods

public rotate(axis: Number[], angle: Number): * source

Rotates the SceneModelTransform about the given axis by the given increment.

Params:

Name	Type	Attribute	Description
axis	Number[]		Local axis about which to rotate.
angle	Number		Angle increment in degrees.

Return:

public rotateOnWorldAxis(axis: Number[], angle: Number): * source

Rotates the SceneModelTransform about the given World-space axis by the given increment.

Params:

Name	Type	Attribute	Description
axis	Number[]		Local axis about which to rotate.
angle	Number		Angle increment in degrees.

Return:

public rotateX(angle: Number): * source

Rotates the SceneModelTransform about the local X-axis by the given increment.

Params:

Name	Type	Attribute	Description
angle	Number		Angle increment in degrees.

Return:

public rotateY(angle: Number): * source

Rotates the SceneModelTransform about the local Y-axis by the given increment.

Params:

Name	Type	Attribute	Description
angle	Number		Angle increment in degrees.

Return:

public rotateZ(angle: Number): * source

Rotates the SceneModelTransform about the local Z-axis by the given increment.

Params:

Name	Type	Attribute	Description
angle	Number		Angle increment in degrees.

Return:

public translate(axis: Number[], distance: Number): * source

Translates the SceneModelTransform along the local axis by the given increment.

Params:

Name	Type	Attribute	Description
axis	Number[]		Normalized local space 3D vector along which to translate.
distance	Number		Distance to translate along the vector.

Return:

public translateX(distance: Number): * source

Translates the SceneModelTransform along the local X-axis by the given increment.

Params:

Name	Type	Attribute	Description
distance	Number		Distance to translate along the X-axis.

Return:

public translateY(distance: Number): * source

Translates the SceneModelTransform along the local Y-axis by the given increment.

Params:

Name	Type	Attribute	Description
distance	Number		Distance to translate along the Y-axis.

Return:

public translateZ(distance: Number): * source

Translates the SceneModelTransform along the local Z-axis by the given increment.

Params:

Name	Type	Attribute	Description
distance	Number		Distance to translate along the Z-axis.