BIM.works SDKs - v3.0.0-b.115
    Preparing search index...

    Interface ViewpointValue

    A stored viewpoint (docs/markup-components-design.md §3.4): the buildingSMART BCF-API 3.0 viewpoint JSON with a bimworks member for what BCF cannot hold. Every coordinate is in the version frame of bimworks.version_uuid (VersionFrames), in metres. The object ids and uuids only mean something on the BIM.works instance it was stored on

    interface ViewpointValue {
        bimworks: {
            camera?: {
                pivot: [number, number, number] | null;
                target_distance: number;
            };
            measurements?: ViewpointMeasurement[];
            model_set?: { models: ViewpointModel[]; placement: "LOCAL"
            | "GEO" };
            models?: string[];
            parts?: ViewpointPart[];
            planes?: { name: string | null; standard: string | null }[];
            schema: "bimworks.viewpoint/1";
            sets?: {
                coloring?: (
                    | { color: string; qids: ViewpointQids }
                    | { alter: number; qids: ViewpointQids }
                )[];
                exceptions?: ViewpointQids;
                selection?: ViewpointQids;
                xray?: ViewpointQids;
            };
            version_uuid: string;
            visibility?: { default_visibility: boolean };
            [member: string]: unknown;
        };
        clipping_planes?: { direction: ViewpointXyz; location: ViewpointXyz }[];
        orthogonal_camera?: ViewpointCamera & { view_to_world_scale: number };
        perspective_camera?: ViewpointCamera & { field_of_view: number };
    }
    Index

    Properties

    bimworks clipping_planes? orthogonal_camera? perspective_camera?

    Properties

    bimworks: {
        camera?: {
            pivot: [number, number, number] | null;
            target_distance: number;
        };
        measurements?: ViewpointMeasurement[];
        model_set?: { models: ViewpointModel[]; placement: "LOCAL"
        | "GEO" };
        models?: string[];
        parts?: ViewpointPart[];
        planes?: { name: string | null; standard: string | null }[];
        schema: "bimworks.viewpoint/1";
        sets?: {
            coloring?: (
                | { color: string; qids: ViewpointQids }
                | { alter: number; qids: ViewpointQids }
            )[];
            exceptions?: ViewpointQids;
            selection?: ViewpointQids;
            xray?: ViewpointQids;
        };
        version_uuid: string;
        visibility?: { default_visibility: boolean };
        [member: string]: unknown;
    }

    Type Declaration

    • [member: string]: unknown

      The application's parts (display settings, sun ...)

    • Optionalcamera?: { pivot: [number, number, number] | null; target_distance: number }

      target_distance in metres; pivot: the point the camera orbits around

    • Optionalmeasurements?: ViewpointMeasurement[]

      The finished measurements

    • Optionalmodel_set?: { models: ViewpointModel[]; placement: "LOCAL" | "GEO" }

      The loaded models and the placement mode (Viewer3d.getMode), whatever the parts: the objects and the frame refer to them

    • Optionalmodels?: string[]

      The loaded versions

    • Optionalparts?: ViewpointPart[]

      The parts stored; without it, every part the value has members for

    • Optionalplanes?: { name: string | null; standard: string | null }[]

      Per clipping plane, in the same order: the name it is listed by and the standard plane it is

    • schema: "bimworks.viewpoint/1"
    • Optionalsets?: {
          coloring?: (
              | { color: string; qids: ViewpointQids }
              | { alter: number; qids: ViewpointQids }
          )[];
          exceptions?: ViewpointQids;
          selection?: ViewpointQids;
          xray?: ViewpointQids;
      }
      • Optionalcoloring?: (
            | { color: string; qids: ViewpointQids }
            | { alter: number; qids: ViewpointQids }
        )[]

        The colours as they were: a colour "#rrggbbaa", or an alteration of the object's own colour (ColorChangeMap.alterQid)

      • Optionalexceptions?: ViewpointQids
      • Optionalselection?: ViewpointQids
      • Optionalxray?: ViewpointQids
    • version_uuid: string

      The version whose frame the coordinates are in

    • Optionalvisibility?: { default_visibility: boolean }

      BCF's default visibility: true when sets.exceptions are the hidden objects, false when they are the shown ones

    clipping_planes?: { direction: ViewpointXyz; location: ViewpointXyz }[]

    Each plane cuts away the side its direction points to; a section box is stored as its six planes

    orthogonal_camera?: ViewpointCamera & { view_to_world_scale: number }

    view_to_world_scale: the height of the view in metres

    perspective_camera?: ViewpointCamera & { field_of_view: number }

    Settings

    Member Visibility

    On This Page

    Properties