bcf.v3.model.visinfo

Module Contents

class bcf.v3.model.visinfo.Bitmap

format: BitmapFormat

height: float

location: Point

normal: Direction

reference: str

up: Direction

class bcf.v3.model.visinfo.BitmapFormat

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

JPG = 'jpg'

PNG = 'png'

class bcf.v3.model.visinfo.ClippingPlane

direction: Direction

location: Point

class bcf.v3.model.visinfo.Component

authoring_tool_id: str | None

ifc_guid: str | None

originating_system: str | None

class bcf.v3.model.visinfo.ComponentColoring

color: List[ComponentColoringColor]

class bcf.v3.model.visinfo.ComponentColoringColor

class Meta

global_type = False

color: str

components: ComponentColoringColorComponents

class bcf.v3.model.visinfo.ComponentColoringColorComponents

class Meta

global_type = False

component: List[Component]

class bcf.v3.model.visinfo.ComponentSelection

component: List[Component]

class bcf.v3.model.visinfo.ComponentVisibility

default_visibility: bool

exceptions: ComponentVisibilityExceptions | None

view_setup_hints: ViewSetupHints | None

class bcf.v3.model.visinfo.ComponentVisibilityExceptions

class Meta

global_type = False

component: List[Component]

class bcf.v3.model.visinfo.Components

coloring: ComponentColoring | None

selection: ComponentSelection | None

visibility: ComponentVisibility | None

class bcf.v3.model.visinfo.Direction

x: float

y: float

z: float

class bcf.v3.model.visinfo.Line

end_point: Point

start_point: Point

class bcf.v3.model.visinfo.OrthogonalCamera

Attributes

camera_view_point: camera_direction: camera_up_vector: view_to_world_scale: view’s visible vertical size in meters aspect_ratio: Proportional relationship between the width and

the height of the view (w/h).

aspect_ratio: float

camera_direction: Direction

camera_up_vector: Direction

camera_view_point: Point

view_to_world_scale: float

class bcf.v3.model.visinfo.PerspectiveCamera

Attributes

camera_view_point: camera_direction: camera_up_vector: field_of_view: Vertical field of view, in degrees. It is

currently limited to a value between 45 and 60 degrees. This limitation will be dropped in the next release and viewers should be expect values outside this range in current implementations.

aspect_ratio: Proportional relationship between the width and

the height of the view (w/h).

aspect_ratio: float

camera_direction: Direction

camera_up_vector: Direction

camera_view_point: Point

field_of_view: float

class bcf.v3.model.visinfo.Point

x: float

y: float

z: float

class bcf.v3.model.visinfo.ViewSetupHints

openings_visible: bool

space_boundaries_visible: bool

spaces_visible: bool

class bcf.v3.model.visinfo.VisualizationInfo

VisualizationInfo documentation.

bitmaps: VisualizationInfoBitmaps | None

clipping_planes: VisualizationInfoClippingPlanes | None

components: Components | None

guid: str

lines: VisualizationInfoLines | None

orthogonal_camera: OrthogonalCamera | None

perspective_camera: PerspectiveCamera | None

class bcf.v3.model.visinfo.VisualizationInfoBitmaps

class Meta

global_type = False

bitmap: List[Bitmap]

class bcf.v3.model.visinfo.VisualizationInfoClippingPlanes

class Meta

global_type = False

clipping_plane: List[ClippingPlane]

class bcf.v3.model.visinfo.VisualizationInfoLines

class Meta

global_type = False

line: List[Line]