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(*args, **kwds)

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

  • attribute access:

    >>> Color.RED
<Color.RED: 1>

  • value lookup:

    >>> Color(1)
<Color.RED: 1>

  • name lookup:

    >>> Color['RED']
<Color.RED: 1>

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

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 = None
ifc_guid: str | None = None
originating_system: str | None = 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 = False
exceptions: ComponentVisibilityExceptions | None = None
view_setup_hints: ViewSetupHints | None = None
class bcf.v3.model.visinfo.ComponentVisibilityExceptions
class Meta
global_type = False
component: List[Component] = []
class bcf.v3.model.visinfo.Components
coloring: ComponentColoring | None = None
selection: ComponentSelection | None = None
visibility: ComponentVisibility | None = 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 = False
space_boundaries_visible: bool = False
spaces_visible: bool = False
class bcf.v3.model.visinfo.VisualizationInfo

VisualizationInfo documentation.

bitmaps: VisualizationInfoBitmaps | None = None
clipping_planes: VisualizationInfoClippingPlanes | None = None
components: Components | None = None
guid: str
lines: VisualizationInfoLines | None = None
orthogonal_camera: OrthogonalCamera | None = None
perspective_camera: PerspectiveCamera | None = 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] = []