Interface ShellRepParams

Parameters for creating a shell representation set in a SceneModel.

The created representation set has two representations:

  • a detailed representation referencing the supplied source SceneObjects
  • a shell representation referencing one generated shell SceneObject

All referenced SceneObjects belong to the same SceneModel. The helper does not create cross-model representation sets.

interface ShellRepParams {
    detailedRange?: SceneRepRangeParams;
    detailedRepId?: string;
    generation?: ShellGenerationParams;
    generator?: ShellGenerator;
    id: string;
    model: SceneModel;
    objectIds: string[];
    selection?: SceneRepSetSelectionParams;
    shellColor?: Vec3;
    shellGeometryId?: string;
    shellMaterialId?: string;
    shellMeshId?: string;
    shellObjectId?: string;
    shellOpacity?: number;
    shellRange?: SceneRepRangeParams;
    shellRepId?: string;
}

Properties

detailedRange? detailedRepId? generation? generator? id model objectIds selection? shellColor? shellGeometryId? shellMaterialId? shellMeshId? shellObjectId? shellOpacity? shellRange? shellRepId?

Properties

OptionaldetailedRange

detailedRange?: SceneRepRangeParams

Projected-size range for the detailed representation.

OptionaldetailedRepId

detailedRepId?: string

ID for the detailed representation.

Default is "detailed".

Optionalgeneration

generation?: ShellGenerationParams

Shell generation settings.

Optionalgenerator

generator?: ShellGenerator

Optional shell generator. Defaults to a new ShellGenerator.

id

id: string

Representation set ID to create.

model

model: SceneModel

SceneModel that owns the source objects, generated shell object and resulting representation set.

objectIds

objectIds: string[]

Source SceneObject IDs for the detailed representation.

Optionalselection

selection?: SceneRepSetSelectionParams

Declarative selection hints for the created representation set.

OptionalshellColor

shellColor?: Vec3

Shell material/mesh color.

Default is [0.72, 0.76, 0.78].

OptionalshellGeometryId

shellGeometryId?: string

ID for the generated shell geometry.

Default is "shellGeometry:${id}".

OptionalshellMaterialId

shellMaterialId?: string

ID for the shell material.

Default is "shellMaterial".

OptionalshellMeshId

shellMeshId?: string

ID for the generated shell mesh.

Default is "shellMesh:${id}".

OptionalshellObjectId

shellObjectId?: string

ID for the generated shell SceneObject.

Default is "shellObject:${id}".

OptionalshellOpacity

shellOpacity?: number

Shell material/mesh opacity.

Default is 1.

OptionalshellRange

shellRange?: SceneRepRangeParams

Projected-size range for the shell representation.

OptionalshellRepId

shellRepId?: string

ID for the shell representation.

Default is "shell".

Settings

Member Visibility

On This Page

Properties