Interface SceneModelParams

Parameters for a SceneModel.

See @xeokit/sdk/scene for usage.

interface SceneModelParams {
    aabb?: number[];
    coordinateSystem?: CoordinateSystemParams;
    geometries?: SceneGeometryParams[];
    geometriesCompressed?: SceneGeometryCompressedParams[];
    globalizedIds?: boolean;
    id: string;
    layerId?: string;
    matrix?: FloatArrayParam;
    meshes?: SceneMeshParams[];
    objects?: SceneObjectParams[];
    position?: FloatArrayParam;
    quaternion?: FloatArrayParam;
    retained?: boolean;
    rotation?: FloatArrayParam;
    scale?: FloatArrayParam;
    streamParams?: SceneModelStreamParams;
    textures?: SceneTextureParams[];
    textureSets?: SceneTextureSetParams[];
}

Properties

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

Properties

Optionalaabb

aabb?: number[]

The axis-aligned 3D World-space boundary of the SceneModel.

This is created by SceneModel.toParams to provide the SceneModel's boundary, and is ignored by SceneModel.fromParams and the SceneModel constructor.

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?: FloatArrayParam

4x4 transform matrix.

Optionalmeshes

meshes?: SceneMeshParams[]

Parameters for SceneMeshes in the SceneModel.

Optionalobjects

objects?: SceneObjectParams[]

Parameters for SceneObjects in the SceneModel.

Optionalposition

position?: FloatArrayParam

World-space position of the SceneModel.

Optionalquaternion

quaternion?: FloatArrayParam

Quaternion defining the orientation of the SceneModel.

Optionalretained

retained?: boolean

Whether this SceneModel retains its SceneObjects, SceneMeshes, SceneGeometries etc. after we call SceneModel.build.

Default value is true.

Optionalrotation

rotation?: FloatArrayParam

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

Optionalscale

scale?: FloatArrayParam

Scale of the SceneModel.

Default is [1,1,1].

OptionalstreamParams

streamParams?: SceneModelStreamParams

Indicates what renderer resources will need to be allocated in a Viewer's Renderer to support progressive loading for a SceneModel.

Optionaltextures

textures?: SceneTextureParams[]

Parameters for SceneTextures in the SceneModel.

OptionaltextureSets

textureSets?: SceneTextureSetParams[]

Parameters for SceneTextureSets in the SceneModel.

Settings

Member Visibility

On This Page

Properties