bcf.v3.model

Submodules

Package Contents

class bcf.v3.model.BimSnippet
is_external: bool
reference: str
reference_schema: str
snippet_type: str
class bcf.v3.model.Bitmap
format: BitmapFormat
height: float
location: Point
normal: Direction
reference: str
up: Direction
class bcf.v3.model.BitmapFormat

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

JPG = 'jpg'
PNG = 'png'
class bcf.v3.model.ClippingPlane
direction: Direction
location: Point
class bcf.v3.model.Comment
author: str
comment: str | None
date: xsdata.models.datatype.XmlDateTime
guid: str
modified_author: str | None
modified_date: xsdata.models.datatype.XmlDateTime | None
viewpoint: CommentViewpoint | None
class bcf.v3.model.CommentViewpoint
class Meta
global_type = False
guid: str
class bcf.v3.model.Component
authoring_tool_id: str | None
ifc_guid: str | None
originating_system: str | None
class bcf.v3.model.ComponentColoring
color: List[ComponentColoringColor]
class bcf.v3.model.ComponentColoringColor
class Meta
global_type = False
color: str
components: ComponentColoringColorComponents
class bcf.v3.model.ComponentColoringColorComponents
class Meta
global_type = False
component: List[Component]
class bcf.v3.model.ComponentSelection
component: List[Component]
class bcf.v3.model.ComponentVisibility
default_visibility: bool
exceptions: ComponentVisibilityExceptions | None
view_setup_hints: ViewSetupHints | None
class bcf.v3.model.ComponentVisibilityExceptions
class Meta
global_type = False
component: List[Component]
class bcf.v3.model.Components
coloring: ComponentColoring | None
selection: ComponentSelection | None
visibility: ComponentVisibility | None
class bcf.v3.model.Direction
x: float
y: float
z: float
class bcf.v3.model.Document
description: str | None
filename: str
guid: str
class bcf.v3.model.DocumentInfo
documents: DocumentInfoDocuments | None
class bcf.v3.model.DocumentInfoDocuments
class Meta
global_type = False
document: List[Document]
class bcf.v3.model.DocumentReference
description: str | None
document_guid: str | None
guid: str
url: str | None
class bcf.v3.model.Extensions
priorities: ExtensionsPriorities | None
snippet_types: ExtensionsSnippetTypes | None
stages: ExtensionsStages | None
topic_labels: ExtensionsTopicLabels | None
topic_statuses: ExtensionsTopicStatuses | None
topic_types: ExtensionsTopicTypes | None
users: ExtensionsUsers | None
class bcf.v3.model.ExtensionsPriorities
class Meta
global_type = False
priority: List[str]
class bcf.v3.model.ExtensionsSnippetTypes
class Meta
global_type = False
snippet_type: List[str]
class bcf.v3.model.ExtensionsStages
class Meta
global_type = False
stage: List[str]
class bcf.v3.model.ExtensionsTopicLabels
class Meta
global_type = False
topic_label: List[str]
class bcf.v3.model.ExtensionsTopicStatuses
class Meta
global_type = False
topic_status: List[str]
class bcf.v3.model.ExtensionsTopicTypes
class Meta
global_type = False
topic_type: List[str]
class bcf.v3.model.ExtensionsUsers
class Meta
global_type = False
user: List[str]
class bcf.v3.model.File
date: xsdata.models.datatype.XmlDateTime | None
filename: str | None
ifc_project: str | None
ifc_spatial_structure_element: str | None
is_external: bool
reference: str | None
class bcf.v3.model.Header
files: HeaderFiles | None
class bcf.v3.model.HeaderFiles
class Meta
global_type = False
file: List[File]
class bcf.v3.model.Line
end_point: Point
start_point: Point
class bcf.v3.model.Markup
header: Header | None
topic: Topic
class bcf.v3.model.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.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.Point
x: float
y: float
z: float
class bcf.v3.model.Project
name: str | None
project_id: str
class bcf.v3.model.ProjectInfo
project: Project
class bcf.v3.model.Topic
assigned_to: str | None
bim_snippet: BimSnippet | None
comments: TopicComments | None
creation_author: str
creation_date: xsdata.models.datatype.XmlDateTime
description: str | None
document_references: TopicDocumentReferences | None
due_date: xsdata.models.datatype.XmlDateTime | None
guid: str
index: int | None
labels: TopicLabels | None
modified_author: str | None
modified_date: xsdata.models.datatype.XmlDateTime | None
priority: str | None
related_topics: TopicRelatedTopics | None
server_assigned_id: str | None
stage: str | None
title: str
topic_status: str
topic_type: str
viewpoints: TopicViewpoints | None
class bcf.v3.model.TopicComments
class Meta
global_type = False
comment: List[Comment]
class bcf.v3.model.TopicDocumentReferences
class Meta
global_type = False
document_reference: List[DocumentReference]
class bcf.v3.model.TopicLabels
class Meta
global_type = False
label: List[str]
class Meta
global_type = False
class bcf.v3.model.TopicRelatedTopics
class Meta
global_type = False
related_topic: List[TopicRelatedTopicsRelatedTopic]
class bcf.v3.model.TopicRelatedTopicsRelatedTopic
class Meta
global_type = False
guid: str
class bcf.v3.model.TopicViewpoints
class Meta
global_type = False
view_point: List[ViewPoint]
class bcf.v3.model.Version
version_id: str
class bcf.v3.model.ViewPoint
guid: str
index: int | None
snapshot: str | None
viewpoint: str | None
class bcf.v3.model.ViewSetupHints
openings_visible: bool
space_boundaries_visible: bool
spaces_visible: bool
class bcf.v3.model.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.VisualizationInfoBitmaps
class Meta
global_type = False
bitmap: List[Bitmap]
class bcf.v3.model.VisualizationInfoClippingPlanes
class Meta
global_type = False
clipping_plane: List[ClippingPlane]
class bcf.v3.model.VisualizationInfoLines
class Meta
global_type = False
line: List[Line]