Interface ICamera

Interface defining camera control operations in the 3D viewer

interface ICamera {
    frameAll(blendTime?: number): Promise<Segment>;
    frameBox(box: Box3, blendTime?: number): Promise<Segment>;
    frameObject(
        object: Core.Ultra.Element3D,
        blendTime?: number,
    ): Promise<Segment>;
    frameVim(
        vim: Core.Ultra.Vim,
        nodes: "all" | number[],
        blendTime?: number,
    ): Promise<Segment>;
    pause(value: boolean): void;
    restoreSavedPosition(blendTime?: number): void;
    save(segment?: Segment): void;
}

Implemented by

Methods

frameAll frameBox frameObject frameVim pause restoreSavedPosition save

Methods

frameAll

  • frameAll(blendTime?: number): Promise<Segment>

  • Frames all Vim models in the viewer to fit within the camera view

    Parameters

    • OptionalblendTime: number

      Animation duration in seconds

    Returns Promise<Segment>

    Promise resolving to the final camera position segment

frameBox

  • frameBox(box: Box3, blendTime?: number): Promise<Segment>

  • Frames a specified bounding box in the viewer

    Parameters

    • box: Box3

      The 3D bounding box to frame

    • OptionalblendTime: number

      Animation duration in seconds

    Returns Promise<Segment>

    Promise resolving to the final camera position segment

frameObject

frameVim

  • frameVim(
        vim: Core.Ultra.Vim,
        nodes: "all" | number[],
        blendTime?: number,
    ): Promise<Segment>

  • Frames specified nodes of a Vim model in the camera view

    Parameters

    • vim: Core.Ultra.Vim

      The target Vim model

    • nodes: "all" | number[]

      Array of node indices or 'all' for entire model

    • OptionalblendTime: number

      Animation duration in seconds

    Returns Promise<Segment>

    Promise resolving to the final camera position segment

pause

restoreSavedPosition

  • restoreSavedPosition(blendTime?: number): void

  • Restores the camera to its previously saved position Initially that will be the first call to a Frame method

    Parameters

    • OptionalblendTime: number

      Animation duration in seconds

    Returns void

save

Settings

Member Visibility

On This Page

Methods