BCFclass
File reader for BIM Collaboration Format (BCF) files
Public Member Functions | Properties | List of all members
BCFvisinfo.VisualizationInfo Class Reference

Visualization Info (.bcfv) definition More...

Public Member Functions

Boolean CameraDefined ()
 Returns if a Camera is defined (either Orthogonal or Perspective More...
 
Boolean OrthogonalDefined ()
 Returns if an Orthogonal Camera is defined More...
 
Boolean PerspectiveDefined ()
 Returns if an Orthogonal Camera is defined More...
 
String CameraText ()
 Returns a text with Camera definition More...
 

Properties

Components Components [get, set]
 
OrthogonalCamera OrthogonalCamera [get, set]
 
PerspectiveCamera PerspectiveCamera [get, set]
 
Collection< LineLines [get]
 
Boolean LinesSpecified [get]
 
Collection< ClippingPlaneClippingPlanes [get]
 
Boolean ClippingPlanesSpecified [get]
 
Collection< VisualizationInfoBitmapBitmap [get]
 
Boolean BitmapSpecified [get]
 
String Guid [get, set]
 

Detailed Description

Visualization Info (.bcfv) definition

The Visualization Info includes the following properties :

ComponentsThe components node contains a set of Component references
The components node has also the DefaultVisibility attribute which indicates true or false for all components of the viewpoint
OrthogonalCameraThis element describes a viewpoint using orthogonal camera
PerspectiveCameraThis element describes a viewpoint using perspective camera
LinesLines can be used to add markup in 3D
ClippingPlanesClippingPlanes can be used to define a subsection of a building model that is related to the topic
BitmapA list of bitmaps can be used to add more information, for example, text in the visualization
GuidGuid of the viewpoint

The numeric values in this file are all given in fixed units (meters for length and degrees for angle)
Unit conversion is not required, since the values are not relevant to the user

Member Function Documentation

◆ CameraDefined()

Boolean BCFvisinfo.VisualizationInfo.CameraDefined ( )
inline

Returns if a Camera is defined (either Orthogonal or Perspective

In addition to the class extracted from the BCF schema

◆ CameraText()

String BCFvisinfo.VisualizationInfo.CameraText ( )
inline

Returns a text with Camera definition

In addition to the class extracted from the BCF schema

◆ OrthogonalDefined()

Boolean BCFvisinfo.VisualizationInfo.OrthogonalDefined ( )
inline

Returns if an Orthogonal Camera is defined

In addition to the class extracted from the BCF schema

◆ PerspectiveDefined()

Boolean BCFvisinfo.VisualizationInfo.PerspectiveDefined ( )
inline

Returns if an Orthogonal Camera is defined

In addition to the class extracted from the BCF schema

Property Documentation

◆ Bitmap

Collection< VisualizationInfoBitmap > BCFvisinfo.VisualizationInfo.Bitmap[get]
get

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

◆ ClippingPlanes

Collection< ClippingPlane > BCFvisinfo.VisualizationInfo.ClippingPlanes[get]
get

ClippingPlanes can be used to define a subsection of a building model that is related to the topic
Each clipping plane is defined by a location Point and a normal Direction

◆ Components

Components BCFvisinfo.VisualizationInfo.Components[get, set]
getset

The components node contains a set of Component references
The components node has also the DefaultVisibility attribute which indicates true or false for all components of the viewpoint

◆ Guid

string BCFvisinfo.VisualizationInfo.Guid[get, set]
getset

Guid of the viewpoint

◆ Lines

Collection< Line > BCFvisinfo.VisualizationInfo.Lines[get]
get

Lines can be used to add markup in 3D
Each line is defined by three dimensional Start Point and End Point
Lines that have the same start and end points are to be considered points and may be displayed accordingly

◆ OrthogonalCamera

OrthogonalCamera BCFvisinfo.VisualizationInfo.OrthogonalCamera[get, set]
getset

This element describes a viewpoint using orthogonal camera

◆ PerspectiveCamera

PerspectiveCamera BCFvisinfo.VisualizationInfo.PerspectiveCamera[get, set]
getset

This element describes a viewpoint using perspective camera