Interface SceneModelParams

Parameters for a SceneModel.

See @xeokit/sdk/scene for usage.

interface SceneModelParams {
    coordinateSystem?: CoordinateSystemParams;
    geometries?: SceneGeometryParams[];
    geometriesCompressed?: SceneGeometryCompressedParams[];
    globalizedIds?: boolean;
    id: string;
    layerId?: string;
    matrix?: Mat4;
    meshes?: SceneMeshParams[];
    objects?: SceneObjectParams[];
    position?: Vec3;
    quaternion?: Quat;
    rotation?: Vec3;
    scale?: Vec3;
    textures?: SceneTextureParams[];
    textureSets?: SceneTextureSetParams[];
    transforms?: SceneTransform[];
}

Properties

coordinateSystem? geometries? geometriesCompressed? globalizedIds? id layerId? matrix? meshes? objects? position? quaternion? rotation? scale? textures? textureSets? transforms?

Properties

OptionalcoordinateSystem

coordinateSystem?: CoordinateSystemParams

Configures the SceneModel's local coordinate system.

Optionalgeometries

geometries?: SceneGeometryParams[]

Parameters for SceneGeometries in the SceneModel.

OptionalgeometriesCompressed

geometriesCompressed?: SceneGeometryCompressedParams[]

Compressed parameters for SceneGeometries in the SceneModel.

OptionalglobalizedIds

globalizedIds?: boolean

Whether IDs of the SceneObjects are globalized.

When globalized, the IDs are prefixed with the value of SceneModel.id

Default is false.

id

id: string

Unique ID for the SceneModel.

The SceneModel is stored with this ID in Scene.models

OptionallayerId

layerId?: string

If we want to view the SceneModel with a Viewer, an optional ID of the ViewLayer to view the SceneModel in.

Will be "default" by default.

Overrides SceneObjectParams.layerId.

Optionalmatrix

matrix?: Mat4

4x4 transform matrix.

Optionalmeshes

meshes?: SceneMeshParams[]

Parameters for SceneMeshes in the SceneModel.

Optionalobjects

objects?: SceneObjectParams[]

Parameters for SceneObjects in the SceneModel.

Optionalposition

position?: Vec3

World-space position of the SceneModel.

Optionalquaternion

quaternion?: Quat

Quaternion defining the orientation of the SceneModel.

Optionalrotation

rotation?: Vec3

Orientation of the SceneModel, given as Euler angles in degrees for X, Y and Z axis.

Optionalscale

scale?: Vec3

Scale of the SceneModel.

Default is [1,1,1].

Optionaltextures

textures?: SceneTextureParams[]

Parameters for SceneTextures in the SceneModel.

OptionaltextureSets

textureSets?: SceneTextureSetParams[]

Parameters for SceneTextureSets in the SceneModel.

Optionaltransforms

transforms?: SceneTransform[]

Parameters for SceneTransform | SceneTransforms in the SceneModel.

Settings

Member Visibility

On This Page

Properties