Interface SceneMeshParams

Parameters for a SceneMesh.

See @xeokit/sdk/scene for usage.

interface SceneMeshParams {
    color?: Vec3;
    geometryId: string;
    id: string;
    matrix?: Mat4;
    opacity?: number;
    origin?: Vec3;
    parentTransformId?: string;
    pickColor?: Vec4;
    position?: Vec3;
    quaternion?: Quat;
    rotation?: Vec3;
    scale?: Vec3;
    textureSetId?: string;
}

Properties

color? geometryId id matrix? opacity? origin? parentTransformId? pickColor? position? quaternion? rotation? scale? textureSetId?

Properties

Optionalcolor

color?: Vec3

RGB base color of the new SceneMesh.

  • Default is [1,1,1].

geometryId

geometryId: string

ID of a SceneGeometry that was created previously with SceneModel.createGeometry or SceneModel.createGeometryCompressed.

id

id: string

ID for the new SceneMesh, unique within the SceneModel.

Optionalmatrix

matrix?: Mat4

Optional local 3D transform matrix.

Overrides SceneMeshParams.position, SceneMeshParams.scale, SceneMeshParams.quaternion and SceneMeshParams.rotation.

Optionalopacity

opacity?: number

Opacity of the new SceneMesh.

Default is 1.

Optionalorigin

origin?: Vec3

Relative-to-center (RTC) origin.

When this is given, then SceneMeshParams.matrix will be relative to this origin.

OptionalparentTransformId

parentTransformId?: string

ID of the parent ViewTransform that was created previously with SceneModel.createTransform.

OptionalpickColor

pickColor?: Vec4

RGB pick color of the new SceneMesh.

This is used internally within SceneModel.

Optionalposition

position?: Vec3

Optional local 3D translation vector.

Optionalquaternion

quaternion?: Quat

Optional local 3D rotation quaternion.

Optionalrotation

rotation?: Vec3

Optional local 3D rotation as Euler angles given in degrees, for each of the X, Y and Z axis.

Optionalscale

scale?: Vec3

Optional local 3D scale vector.

OptionaltextureSetId

textureSetId?: string

ID of a SceneTextureSet that was created previously with SceneModel.createTextureSet.

Settings

Member Visibility

On This Page

Properties