LUX-VIEW - v1.0.0
    Preparing search index...

    Interface IDefaultViewer

    interface IDefaultViewer {
        screenshots: IScreenshots;
        getConfiguration(): IDefaultConfiguration;
        getCurrentState(): IDefaultViewerState;
        setAnimationGroup(
            groupId: string,
            destination?: IAnimationPosition,
            options?: { instant?: boolean },
        ): Promise<void>;
        setCamera(
            id: string,
            transitionProperties?: {
                easing?: string;
                onFinished?: (reason: string) => void;
                time?: number;
            },
        ): Promise<void>;
        setEnvironment(id: string): Promise<void>;
        setHotspots(hotspotIds: string[]): Promise<void>;
        setMaterialGroup(groupId: string, materialId: string): Promise<void>;
        setRenderSettings(id: string): Promise<void>;
        setSkydome(id: string | null): Promise<void>;
        setState(id: string): Promise<void>;
        setVisibilitySet(setId: string, groupId?: string): Promise<void>;
        viewInAR(options?: ARStaticSceneViewerOptions): Promise<IARExportReport>;
    }
    Index

    Properties

    screenshots: IScreenshots

    Methods

    • Starts playing an animation group.

      If the group references animations which are not currently active, an internal state is set so they snap to the correct position once they are loaded.

      The returned promise resolves when all active animations of the group have finished playing.

      Parameters

      • groupId: string

        The id of the animation group.

      • Optionaldestination: IAnimationPosition

        Where to play the group toward. Default: "Toggle".

        • "Start": plays backward to the first frame. No-op if already at the start.
        • "End": plays forward to the last frame. No-op if already at the end.
        • "Toggle": plays toward the opposite of the current position. The first call from rest heads toward "End"; subsequent calls alternate direction, even mid-animation.
      • Optionaloptions: { instant?: boolean }

        instant: true jumps to the destination instead of playing toward it; the promise resolves once the position is applied.

      Returns Promise<void>

    • Parameters

      • id: string
      • OptionaltransitionProperties: { easing?: string; onFinished?: (reason: string) => void; time?: number }

      Returns Promise<void>

    • Parameters

      • id: string

      Returns Promise<void>

    • Parameters

      • hotspotIds: string[]

      Returns Promise<void>

    • Parameters

      • groupId: string
      • materialId: string

      Returns Promise<void>

    • Parameters

      • id: string

      Returns Promise<void>

    • Parameters

      • id: string | null

      Returns Promise<void>

    • Parameters

      • id: string

      Returns Promise<void>

    • Activates a visibility group within a visibility set.

      A visibility set bundles multiple visibility groups (each group is a named collection of meshes). Activating a group makes its meshes visible and hides the other groups in the same set.

      Parameters

      • setId: string

        The id of the visibility set.

      • OptionalgroupId: string

        The id of the visibility group to activate. If omitted, all groups in the set are hidden — effectively switching the set off.

      Returns Promise<void>