BIM.works SDKs - v3.0.0-beta.168
    Preparing search index...

    Interface TransitionStep

    One step of ObjectStateManager.transition: these changes at once, as the methods of the same meaning make them. They apply in this order: unghost, visible, show, hide, ghost, the selection keys, the x-ray keys, resetColors, colors, camera

    interface TransitionStep {
        camera?:
            | TransitionCameraFit
            | TransitionCameraPose
            | TransitionCameraProjection;
        colors?: ColorChangeMap;
        deselect?: string
        | Iterable<Qid, any, any>;
        duration?: number;
        easing?: TransitionEasing;
        ghost?: string | Iterable<Qid, any, any>;
        ghosted?: string | Iterable<Qid, any, any>;
        hide?: string | Iterable<Qid, any, any>;
        resetColors?: string | Iterable<Qid, any, any>;
        select?: string | Iterable<Qid, any, any>;
        selected?: string | Iterable<Qid, any, any>;
        show?: string | Iterable<Qid, any, any>;
        unghost?: string | Iterable<Qid, any, any>;
        unxray?: string | Iterable<Qid, any, any>;
        visible?: string | Iterable<Qid, any, any>;
        xray?: string | Iterable<Qid, any, any>;
        xrayed?: string | Iterable<Qid, any, any>;
    }
    Index

    Properties

    As changeColorMulti: fixed colours (an alpha below 1 makes the objects transparent) and transparency alterations of the objects' own colours. Disposed once its queries have resolved

    deselect?: string | Iterable<Qid, any, any>

    As removeFromSelectionSet

    duration?: number

    Milliseconds, default 500. A step lasts the longer of this and camera.duration; the next one starts when it ends. A step without changes is a pause. 0: at once, and a chain of 0 ms steps applies in one go

    Default "ease-in-out"; the camera keeps its own smooth curve

    ghost?: string | Iterable<Qid, any, any>

    As addToGhostSet, after the visibility keys: ghosting hides what is visible at that point and draws it as a ghost

    ghosted?: string | Iterable<Qid, any, any>

    Exactly these objects ghosts, as setGhostSet: the others leave the set before the visibility keys, these join it after them

    hide?: string | Iterable<Qid, any, any>

    As removeFromVisibleSet; after show, so an object in both ends up hidden

    resetColors?: string | Iterable<Qid, any, any>

    Back to their own colour, as resetColor; before colors

    select?: string | Iterable<Qid, any, any>

    As addToSelectionSet

    selected?: string | Iterable<Qid, any, any>

    Exactly these objects selected, as setSelectionSet; after the visibility keys, so it wins over the deselection of hidden objects

    show?: string | Iterable<Qid, any, any>

    As addToVisibleSet

    unghost?: string | Iterable<Qid, any, any>

    As removeFromGhostSet, before the visibility keys: leaving the set shows what ghosting hid

    unxray?: string | Iterable<Qid, any, any>

    As removeFromXRaySet

    visible?: string | Iterable<Qid, any, any>

    Exactly these objects visible, as setVisibleSet

    xray?: string | Iterable<Qid, any, any>

    As addToXRaySet

    xrayed?: string | Iterable<Qid, any, any>

    Exactly these objects in the x-ray set, as setXRaySet