`bcf.v2.model`¶

Submodules¶

Package Contents¶

class bcf.v2.model.BimSnippet¶

is_external: bool = False¶

reference: str¶

reference_schema: str¶

snippet_type: str¶

class bcf.v2.model.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.v2.model.ClippingPlane¶

direction: Direction¶

location: Point¶

class bcf.v2.model.Comment¶

author: str¶

comment: str¶

date: xsdata.models.datatype.XmlDateTime¶

guid: str¶

modified_author: str | None = None¶

modified_date: xsdata.models.datatype.XmlDateTime | None = None¶

viewpoint: CommentViewpoint | None = None¶

class bcf.v2.model.CommentViewpoint¶

class Meta¶

global_type = False¶

guid: str¶

class bcf.v2.model.Component¶

authoring_tool_id: str | None = None¶

ifc_guid: str | None = None¶

originating_system: str | None = None¶

class bcf.v2.model.ComponentColoring¶

color: List[ComponentColoringColor] = []¶

class bcf.v2.model.ComponentColoringColor¶

class Meta¶

global_type = False¶

color: str | None = None¶

component: List[Component] = []¶

class bcf.v2.model.ComponentSelection¶

component: List[Component] = []¶

class bcf.v2.model.ComponentVisibility¶

default_visibility: bool | None = None¶

exceptions: ComponentVisibilityExceptions | None = None¶

class bcf.v2.model.ComponentVisibilityExceptions¶

class Meta¶

global_type = False¶

component: List[Component] = []¶

class bcf.v2.model.Components¶

coloring: ComponentColoring | None = None¶

selection: ComponentSelection | None = None¶

view_setup_hints: ViewSetupHints | None = None¶

visibility: ComponentVisibility¶

class bcf.v2.model.Direction¶

x: float¶

y: float¶

z: float¶

class bcf.v2.model.Header¶

file: List[HeaderFile] = []¶

class bcf.v2.model.HeaderFile¶

class Meta¶

global_type = False¶

date: xsdata.models.datatype.XmlDateTime | None = None¶

filename: str | None = None¶

ifc_project: str | None = None¶

ifc_spatial_structure_element: str | None = None¶

is_external: bool = True¶

reference: str | None = None¶

class bcf.v2.model.Line¶

end_point: Point¶

start_point: Point¶

class bcf.v2.model.Markup¶

comment: List[Comment] = []¶

header: Header | None = None¶

topic: Topic¶

viewpoints: List[ViewPoint] = []¶

class bcf.v2.model.OrthogonalCamera¶

Attributes: camera_view_point: camera_direction: camera_up_vector: view_to_world_scale: view’s visible size in meters

camera_direction: Direction¶

camera_up_vector: Direction¶

camera_view_point: Point¶

view_to_world_scale: float¶

class bcf.v2.model.PerspectiveCamera¶

Attributes: camera_view_point: camera_direction: camera_up_vector: field_of_view: 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.

camera_direction: Direction¶

camera_up_vector: Direction¶

camera_view_point: Point¶

field_of_view: float¶

class bcf.v2.model.Point¶

x: float¶

y: float¶

z: float¶

class bcf.v2.model.Project¶

name: str | None = None¶

project_id: str¶

class bcf.v2.model.ProjectExtension¶

extension_schema: str¶

project: Project | None = None¶

class bcf.v2.model.Topic¶

assigned_to: str | None = None¶

bim_snippet: BimSnippet | None = None¶

creation_author: str¶

creation_date: xsdata.models.datatype.XmlDateTime¶

description: str | None = None¶

document_reference: List[TopicDocumentReference] = []¶

due_date: xsdata.models.datatype.XmlDateTime | None = None¶

guid: str¶

index: int | None = None¶

labels: List[str] = []¶

modified_author: str | None = None¶

modified_date: xsdata.models.datatype.XmlDateTime | None = None¶

priority: str | None = None¶

reference_link: List[str] = []¶

related_topic: List[TopicRelatedTopic] = []¶

stage: str | None = None¶

title: str¶

topic_status: str | None = None¶

topic_type: str | None = None¶

class bcf.v2.model.TopicDocumentReference¶

class Meta¶

global_type = False¶

description: str | None = None¶

guid: str | None = None¶

is_external: bool = False¶

referenced_document: str | None = None¶

class bcf.v2.model.TopicRelatedTopic¶

class Meta¶

global_type = False¶

guid: str¶

class bcf.v2.model.Version¶

detailed_version: str | None = None¶

version_id: str | None = None¶

class bcf.v2.model.ViewPoint¶

guid: str¶

index: int | None = None¶

snapshot: str | None = None¶

viewpoint: str | None = None¶

class bcf.v2.model.ViewSetupHints¶

openings_visible: bool | None = None¶

space_boundaries_visible: bool | None = None¶

spaces_visible: bool | None = None¶

class bcf.v2.model.VisualizationInfo¶

VisualizationInfo documentation.

bitmap: List[VisualizationInfoBitmap] = []¶

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.v2.model.VisualizationInfoBitmap¶

class Meta¶

global_type = False¶

bitmap: BitmapFormat¶

height: float¶

location: Point¶

normal: Direction¶

reference: str¶

up: Direction¶

class bcf.v2.model.VisualizationInfoClippingPlanes¶

class Meta¶

global_type = False¶

clipping_plane: List[ClippingPlane] = []¶

class bcf.v2.model.VisualizationInfoLines¶

class Meta¶

global_type = False¶

line: List[Line] = []¶

bcf.v2.model¶

Submodules¶

Package Contents¶

`bcf.v2.model`¶