Class DynamicElements

Represents dynamic elements that can be transformed.

Hierarchy

DynamicElements

Constructors

constructor

new DynamicElements(_renderer: BaseRenderer): DynamicElements
Creates an instance of DynamicElements.
Parameters
- _renderer: BaseRenderer
  
  The renderer associated with the dynamic elements.
Returns DynamicElements
- Defined in elements/dynamic.ts:27

Accessors

transformObjectsCount

get transformObjectsCount(): number
Returns number
- Defined in elements/dynamic.ts:55

transformationChangedEvent

get transformationChangedEvent(): IEvent<BaseRenderer, TransformationChangedEvent>
Returns IEvent<BaseRenderer, TransformationChangedEvent>
- Defined in elements/dynamic.ts:51

Methods

concatenate

concatenate(internalIds: Int64[], matrices: number[][], updateRender?: boolean): Promise<void>
Concatenates the transformations for the specified internal IDs and matrices.
Parameters
- internalIds: Int64[]
  
  The internal IDs of the elements.
- matrices: number[][]
  
  The transformation matrices.
- updateRender: boolean = true
  
  Whether to update the render.
Returns Promise<void>
- Defined in elements/dynamic.ts:254

getState

getState(): DynamicElementsState
Gets the state of the dynamic elements.

Returns
The state of the dynamic elements.

Returns DynamicElementsState
- Defined in elements/dynamic.ts:121

hasTransformation

hasTransformation(internalId: Int64): boolean
Checks if there is a transformation for the specified internal ID.

Returns
Whether there is a transformation for the internal ID.
Parameters
- internalId: Int64
  
  The internal ID of the element.
Returns boolean
- Defined in elements/dynamic.ts:47

hasTransformations

hasTransformations(): boolean
Checks if there are any transformations.

Returns
Whether there are transformations.

Returns boolean
- Defined in elements/dynamic.ts:38

invert

invert(internalIds: Int64[], updateRender?: boolean): Promise<void>
Inverts the transformations for the specified internal IDs.
Parameters
- internalIds: Int64[]
  
  The internal IDs of the elements.
- updateRender: boolean = false
  
  Whether to update the render.
Returns Promise<void>
- Defined in elements/dynamic.ts:225

invertedMatrix

invertedMatrix(internalId: Int64): number[]
Gets the inverted transformation matrix for the specified internal ID.

Returns
The inverted transformation matrix.
Parameters
- internalId: Int64
  
  The internal ID of the element.
Returns number[]
- Defined in elements/dynamic.ts:208

lookAt

lookAt(internalIds: Int64[], origin: Vector3D, lookVector: Vector3D, upVector?: Vector3D): Promise<void>
Rotates the elements to look at the specified vector.
Parameters
- internalIds: Int64[]
  
  The internal IDs of the elements.
- origin: Vector3D
  
  The origin point.
- lookVector: Vector3D
  
  The look vector.
- upVector: Vector3D = ...
  
  The up vector.
Returns Promise<void>
- Defined in elements/dynamic.ts:356

matrices

matrices(internalIds: Int64[]): number[][]
Gets the transformation matrices for the specified internal IDs.

Returns
The transformation matrices.
Parameters
- internalIds: Int64[]
  
  The internal IDs of the elements.
Returns number[][]
- Defined in elements/dynamic.ts:193

matrix

matrix(internalId: Int64, nullOnIdentity?: boolean): number[]
Gets the transformation matrix for the specified internal ID.

Returns
The transformation matrix.
Parameters
- internalId: Int64
  
  The internal ID of the element.
- nullOnIdentity: boolean = false
  
  Whether to return null on identity matrix.
Returns number[]
- Defined in elements/dynamic.ts:178

moveTo

moveTo(internalIds: Int64[], targetPosition: Vector3D, currentPosition?: Vector3D, updateRender?: boolean): Promise<void>
Moves the elements to the specified target position.
Parameters
- internalIds: Int64[]
  
  The internal IDs of the elements.
- targetPosition: Vector3D
  
  The target position.
- Optional currentPosition: Vector3D
  
  The current position.
- updateRender: boolean = true
  
  Whether to update the render.
Returns Promise<void>
- Defined in elements/dynamic.ts:310

reset

reset(ids: Int64 | Int64[], updateRender?: boolean): Promise<void>
Resets the transformations for the specified IDs.
Parameters
- ids: Int64 | Int64[]
  
  The IDs of the elements.
- updateRender: boolean = false
  
  Whether to update the render.
Returns Promise<void>
- Defined in elements/dynamic.ts:78

resetAll

resetAll(updateRender?: boolean): Promise<void>
Resets all transformations.
Parameters
- updateRender: boolean = false
  
  Whether to update the render.
Returns Promise<void>
- Defined in elements/dynamic.ts:63

rotateAroundQuat

rotateAroundQuat(internalIds: Int64[], origin: Vector3D, quaternion: Quaternion, updateRender?: boolean): Promise<void>
Rotates the elements around the specified quaternion.
Parameters
- internalIds: Int64[]
  
  The internal IDs of the elements.
- origin: Vector3D
  
  The origin point.
- quaternion: Quaternion
  
  The rotation quaternion.
- updateRender: boolean = true
  
  Whether to update the render.
Returns Promise<void>
- Defined in elements/dynamic.ts:410

rotateAroundX

rotateAroundX(internalIds: Int64[], origin: Vector3D, deg: number): Promise<void>
Rotates the elements around the X-axis.
Parameters
- internalIds: Int64[]
  
  The internal IDs of the elements.
- origin: Vector3D
  
  The origin point.
- deg: number
  
  The rotation angle in degrees.
Returns Promise<void>
- Defined in elements/dynamic.ts:480

rotateAroundXYZ

rotateAroundXYZ(internalIds: Int64[], origin: Vector3D, rotationAnglesXYZ: Vector3D, updateRender?: boolean): Promise<void>
Rotates the elements around the specified XYZ angles.
Parameters
- internalIds: Int64[]
  
  The internal IDs of the elements.
- origin: Vector3D
  
  The origin point.
- rotationAnglesXYZ: Vector3D
  
  The rotation angles in XYZ.
- updateRender: boolean = true
  
  Whether to update the render.
Returns Promise<void>
- Defined in elements/dynamic.ts:421

rotateAroundY

rotateAroundY(internalIds: Int64[], origin: Vector3D, deg: number): Promise<void>
Rotates the elements around the Y-axis.
Parameters
- internalIds: Int64[]
  
  The internal IDs of the elements.
- origin: Vector3D
  
  The origin point.
- deg: number
  
  The rotation angle in degrees.
Returns Promise<void>
- Defined in elements/dynamic.ts:521

rotateAroundZ

rotateAroundZ(internalIds: Int64[], origin: Vector3D, deg: number): Promise<void>
Rotates the elements around the Z-axis.
Parameters
- internalIds: Int64[]
  
  The internal IDs of the elements.
- origin: Vector3D
  
  The origin point.
- deg: number
  
  The rotation angle in degrees.
Returns Promise<void>
- Defined in elements/dynamic.ts:562

scaleAroundXYZ

scaleAroundXYZ(internalIds: Int64[], origin: Vector3D, scaleFactors: Vector3D, updateRender?: boolean): Promise<void>
Scales the elements around the specified XYZ factors.
Parameters
- internalIds: Int64[]
  
  The internal IDs of the elements.
- origin: Vector3D
  
  The origin point.
- scaleFactors: Vector3D
  
  The scale factors in XYZ.
- updateRender: boolean = true
  
  Whether to update the render.
Returns Promise<void>
- Defined in elements/dynamic.ts:604

set

set(internalIds: Int64[], matrices: number[][], updateRender?: boolean): Promise<void>
Sets the transformations for the specified internal IDs and matrices.
Parameters
- internalIds: Int64[]
  
  The internal IDs of the elements.
- matrices: number[][]
  
  The transformation matrices.
- updateRender: boolean = true
  
  Whether to update the render.
Returns Promise<void>
- Defined in elements/dynamic.ts:104

setState

setState(state: DynamicElementsState): Promise<void>
Sets the state of the dynamic elements.
Parameters
- state: DynamicElementsState
  
  The state of the dynamic elements.
Returns Promise<void>
- Defined in elements/dynamic.ts:144

translateTo

translateTo(internalIds: Int64[], vector: Vector3D, updateRender?: boolean): Promise<void>
Translates the elements to the specified vector.
Parameters
- internalIds: Int64[]
  
  The internal IDs of the elements.
- vector: Vector3D
  
  The translation vector.
- updateRender: boolean = true
  
  Whether to update the render.
Returns Promise<void>
- Defined in elements/dynamic.ts:279

unloadModel

unloadModel(modelInfo: ModelInfo): void
Unloads the model and removes its dynamic elements.
Parameters
- modelInfo: ModelInfo
  
  The model information.
Returns void
- Defined in elements/dynamic.ts:646

Class DynamicElements

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

_renderer: BaseRenderer

Returns DynamicElements

Accessors

transformObjectsCount

Returns number

transformationChangedEvent

Returns IEvent<BaseRenderer, TransformationChangedEvent>

Methods

concatenate

Parameters

internalIds: Int64[]

matrices: number[][]

updateRender: boolean = true

Returns Promise<void>

getState

Returns

Returns DynamicElementsState

hasTransformation

Returns

Parameters

internalId: Int64

Returns boolean

hasTransformations

Returns

Returns boolean

invert

Parameters

internalIds: Int64[]

updateRender: boolean = false

Returns Promise<void>

invertedMatrix

Returns

Parameters

internalId: Int64

Returns number[]

lookAt

Parameters

internalIds: Int64[]

origin: Vector3D

lookVector: Vector3D

upVector: Vector3D = ...

Returns Promise<void>

matrices

Returns

Parameters

internalIds: Int64[]

Returns number[][]

matrix

Returns

Parameters

internalId: Int64

nullOnIdentity: boolean = false

Returns number[]

moveTo

Parameters

internalIds: Int64[]

targetPosition: Vector3D

Optional currentPosition: Vector3D

updateRender: boolean = true

Returns Promise<void>

reset

Parameters

ids: Int64 | Int64[]

updateRender: boolean = false

Returns Promise<void>

resetAll

Parameters

updateRender: boolean = false

Returns Promise<void>

rotateAroundQuat

Parameters

`Optional` currentPosition: Vector3D