Interface SceneObjectParams

Parameters for a SceneObject.

See @xeokit/sdk/scene for usage.

interface SceneObjectParams {
    id: string;
    layerId?: string;
    meshIds: string[];
    originalSystemId?: string;
}

Properties

id layerId? meshIds originalSystemId?

Properties

id

id: string

Unique ID for the SceneObject.

OptionallayerId

layerId?: string

Causes each viewer!View to put the corresponding viewer!ViewObject into a viewer!ViewLayer with this ID.

When you create an object in a model, each viewer!View will automatically create a viewer!ViewObject to represent it. When the object has a SceneObjectParams.layerId property, then each View will first ensure that it has a viewer!ViewLayer with this ID, and will register the ViewObject in that ViewLayer.

Overridden by SceneObjectParams.layerId.

meshIds

meshIds: string[]

IDs of meshes previously created with SceneModel.createMesh.

OptionaloriginalSystemId

originalSystemId?: string

ID of this SceneObject within the originating system, is any. Defaults to the value of SceneObjectParams.id.

Settings

Member Visibility

On This Page

Properties