Class SceneMesh

destroyed

Readonlygeometry

Readonlyid

Optional Readonlymaterial

Readonlymodel

object

color

• get color(): Vec3

  Gets the RGB color for this SceneMesh.

  Each element of the color is in range [0..1].

  Returns Vec3
• set color(value: Vec3): void

  Sets the RGB color for this SceneMesh.

  • Fires an SceneEvents.onSceneMeshColorChanged event on the Scene.
  • Each element of the color is in range [0..1].

  Parameters

  • value: Vec3

  Returns void

geometryId

• get geometryId(): string

  Gets the ID of the SceneGeometry used by this SceneMesh.

  Returns string
• set geometryId(value: string): void

  Sets the SceneGeometry used by this SceneMesh.

  The SceneMesh will already have the SceneGeometry it was created with, and then you can change it to a different SceneGeometry using this setter.

  This mechanism allows you to dynamically switch the geometric representation of a SceneMesh at runtime.

  When the switch succeeds, SceneMesh.geometry will reference the new SceneGeometry and an SceneEvents.onSceneMeshGeometryChanged event is dispatched on the Scene.

  If the given geometryId is invalid, such as when the SceneGeometry does not exist in the SceneModel, an error will be logged and the SceneGeometry will not be changed.

  Note that you cannot destroy a SceneGeometry that is currently in use by a SceneMesh.

  Parameters

  • value: string

    The ID of the new SceneGeometry to use. Must exist in the SceneModel.

  Returns void

globalColor

• get globalColor(): Vec3

  Gets the global RGB color for this SceneMesh, which is the color of the material if it has one, or the local color otherwise.

  Returns Vec3

globalMatrix

• get globalMatrix(): Mat4

  Gets the global transform matrix for this SceneMesh.

  Returns Mat4

globalOpacity

• get globalOpacity(): number

  Gets the global opacity factor for this SceneMesh, which is the opacity of the material if it has one, or the local opacity otherwise. This is a factor in range [0..1].

  Returns number

materialId

• get materialId(): string

  Gets the ID of the SceneMaterial used by this SceneMesh.

  Returns string
• set materialId(value: string): void

  Sets the SceneMaterial used by this SceneMesh.

  The SceneMesh will already have the SceneMaterial it was created with, and then you can change it to a different SceneMaterial using this setter.

  This mechanism allows you to dynamically switch the geometric representation of a SceneMesh at runtime.

  When the switch succeeds, SceneMesh.material will reference the new SceneMaterial and an SceneEvents.onSceneMeshMaterialChanged event is dispatched on the Scene.

  If the given materialId is invalid, such as when the SceneMaterial does not exist in the SceneModel, an error will be logged and the SceneMaterial will not be changed.

  Note that you cannot destroy a SceneMaterial that is currently in use by a SceneMesh.

  Parameters

  • value: string

    The ID of the new SceneMaterial to use. Must exist in the SceneModel.

  Returns void

matrix

• get matrix(): Mat4

  Gets this SceneMesh's local modeling transform matrix.

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

  Returns Mat4
• set matrix(matrix: Mat4): void

  Updates this SceneMesh's local modeling transform matrix.

  • Fires an SceneEvents.onSceneMeshMatrixChanged event on the Scene.
  • Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].

  Parameters

  • matrix: Mat4

  Returns void

opacity

• get opacity(): number

  Gets the opacity factor for this SceneMesh.

  This is a factor in range [0..1].

  Returns number
• set opacity(opacity: number): void

  Sets the opacity factor for this SceneMesh.

  • This is a factor in range [0..1].
  • Fires an SceneEvents.onSceneMeshOpacityChanged event on the Scene.

  Parameters

  • opacity: number

  Returns void

parentTransform

• get parentTransform(): SceneTransform

  Gets the parent SceneTransform of this SceneMesh, or null if this SceneMesh is not parented.

  Returns SceneTransform

destroy

• destroy(): SDKResult<void>

  Destroys this SceneMesh.

  • Fires an SceneEvents.onSceneMeshDestroyed event on the Scene.
  • You cannot destroy a SceneMesh that is currently used by a SceneObject; you must destroy the SceneObject first.

  Returns SDKResult<void>

setGlobalMatrixDirty

• setGlobalMatrixDirty(): void
  Internal

  Updates the global transform matrix.

  Returns void

setParentTransformId

• setParentTransformId(
      parentTransformId: string,
      opts?: { preserveWorld?: boolean },
  ): SDKResult<any>

  Sets the parent transform for this mesh.

  Parameters

  • parentTransformId: string

    The ID of the new parent transform, or null to detach.
  • Optionalopts: { preserveWorld?: boolean }

    Options to preserve world transformation.

  Returns SDKResult<any>

toParams

• toParams(): SDKResult<SceneMeshParams>

  Gets this SceneMesh as SceneMeshParams.

  Returns SDKResult<SceneMeshParams>