Interface SaveBCFViewpointParams

Parameters for saveBCFViewpoint.

See @xeokit/sdk/bcf for usage.

interface SaveBCFViewpointParams {
    defaultInvisible?: boolean;
    excludeViewLayerIds?: string[];
    includeViewLayerIds?: string[];
    openings_translucent?: boolean;
    openingsVisible?: boolean;
    originatingSystem?: string;
    reverseClippingPlanes?: boolean;
    snapshot?: boolean;
    space_boundaries_translucent?: boolean;
    spaceBoundariesVisible?: boolean;
    spaces_translucent?: boolean;
    spacesVisible?: boolean;
    view: View;
}

Properties

defaultInvisible?: boolean
excludeViewLayerIds?: string[]

Never save BCF viewpoint components if their corresponding ViewObjects are in ViewLayers that have the given IDs.

The saveBCFViewpoint function will silently ignore each component state that has a corresponding ViewObject in any of these ViewLayers.

Each ViewLayer's occurrence in this list will override its occurrance in SaveBCFViewpointParams.includeViewLayerIds.

includeViewLayerIds?: string[]

Only save BCF viewpoint components if their corresponding ViewObjects are in ViewLayers that match these IDs.

The saveBCFViewpoint function will silently ignore each component state that has no corresponding ViewObject in any of these ViewLayers.

Each ViewLayer's occurrence in SaveBCFViewpointParams.excludeViewLayerIds will override its appearance in this list.

openings_translucent?: boolean

Value to set on BCFViewSetupHints.openings_translucent within the BCF viewpoint.

openingsVisible?: boolean

Value to set on BCFViewSetupHints.openings_visible within the BCF viewpoint.

originatingSystem?: string

Identifies the system that authors this BCF viewpoint.

reverseClippingPlanes?: boolean

Whether to flip the direction of the SectionPlanes captured in the BCF viewpoint.

snapshot?: boolean

Whether to capture a snapshot image in the BCF viewpoint.

The snapshot would be saved in BCFViewpoint.snapshot.

space_boundaries_translucent?: boolean

Value to set on BCFViewSetupHints.space_boundaries_translucent within the BCF viewpoint.

spaceBoundariesVisible?: boolean

Value to set on BCFViewSetupHints.space_boundaries_visible within the BCF viewpoint.

spaces_translucent?: boolean

Value to set on BCFViewSetupHints.spaces_translucent within the BCF viewpoint.

spacesVisible?: boolean

Value to set on BCFViewSetupHints.spaces_visible within the BCF viewpoint.

view: View

The View to save as a BCF viewpoint.

This will save component states in the BCF (see BCFComponents) for all ViewObjects in this View.