Interface IViewpoint

Defines the model viewpoint with markup.

This viewpoint is BCF-compatible.

Optional/mandatory fields clarification:

  • A viewpoint must contain a camera definition.
  • Camera definition is exactly one of perspective_camera or orthogonal_camera.
interface IViewpoint {
    arrows?: IArrow[];
    assembly_id?: string;
    bitmaps?: IBitmap[];
    clipping_planes?: IClippingPlane[];
    clouds?: ICloud[];
    coloring?: IColoring[];
    custom_fields?: any;
    description?: string;
    ellipses?: IEllipse[];
    file_id?: string;
    guid?: string;
    images?: IImage[];
    index?: number;
    lines?: ILine[];
    orthogonal_camera?: IOrthogonalCamera;
    perspective_camera?: IPerspectiveCamera;
    rectangles?: IRectangle[];
    selection?: IEntity[];
    snapshot?: ISnapshot;
    texts?: IText[];
    visibility?: IEntity[];
}

Properties

arrows? assembly_id? bitmaps? clipping_planes? clouds? coloring? custom_fields? description? ellipses? file_id? guid? images? index? lines? orthogonal_camera? perspective_camera? rectangles? selection? snapshot? texts? visibility?

Properties

Optionalarrows

arrows?: IArrow[]

List of markup Arrow objects.

Optionalassembly_id

assembly_id?: string

Identifier of the assembly for which the viewpoint was created.

Optionalbitmaps

bitmaps?: IBitmap[]

Embedded pictures in the viewpoint. A list of bitmaps can be used to add more information, for example, text in the visualization.

Optionalclipping_planes

clipping_planes?: IClippingPlane[]

Clipping planes for the model view.

Optionalclouds

clouds?: ICloud[]

List of markup Cloud objects.

Optionalcoloring

coloring?: IColoring[]

Colored components.

Optionalcustom_fields

custom_fields?: any

Viewpoint custom fields object, to store custom data.

Optionaldescription

description?: string

Viewpoint description.

Optionalellipses

ellipses?: IEllipse[]

List of markup Ellipse objects.

Optionalfile_id

file_id?: string

Identifier of the file for which the viewpoint was created.

Optionalguid

guid?: string

GUID for identifying viewpoint uniquely.

Optionalimages

images?: IImage[]

List of markup Image objects.

Optionalindex

index?: number

Viewpoint index (sort order).

Optionallines

lines?: ILine[]

List of markup Line objects.

Optionalorthogonal_camera

orthogonal_camera?: IOrthogonalCamera

Orthogonal camera view.

Optionalperspective_camera

perspective_camera?: IPerspectiveCamera

Perspective view of the camera.

Optionalrectangles

rectangles?: IRectangle[]

List of markup Rectangle objects.

Optionalselection

selection?: IEntity[]

Selected components.

Optionalsnapshot

snapshot?: ISnapshot

Snapshot image of the viewpoint. The longest dimension of should not exceed 1500 px, length or width.

Optionaltexts

texts?: IText[]

List of markup Texts objects.

Optionalvisibility

visibility?: IEntity[]

Visibility of components.

Settings

Member Visibility

On This Page

Properties