Source code for dtcc_core.model.object.building

# Copyright(C) 2023 Dag Wästberg
# Licensed under the MIT License

from dataclasses import dataclass, field
from typing import Union
from shapely.geometry import Polygon

from .object import Object, GeometryType
from ..geometry import Bounds
from .. import dtcc_pb2 as proto



[docs]
@dataclass
class Building(Object):
    """Represents a building in a city."""

    @property
    def building_parts(self):
        """Return list of building parts in building."""
        return self.children[BuildingPart] if BuildingPart in self.children else []

    @property
    def height(self):
        height = self.attributes.get("height", None)
        if height is None:
            height = self.bounds.zmax - self.bounds.zmin
        return height


[docs]
    def to_proto(self) -> proto.Object:
        """Return a protobuf representation of the Building.

        Returns
        -------
        proto.Object
            A protobuf representation of the Building as an Object.
        """

        # Handle Object fields
        pb = Object.to_proto(self)

        # Handle specific fields (currently none)
        _pb = proto.Building()
        pb.building.CopyFrom(_pb)

        return pb



[docs]
    def from_proto(self, pb: Union[proto.Object, bytes]):
        """Initialize Building from a protobuf representation.

        Parameters
        ----------
        pb: Union[proto.Object, bytes]
            The protobuf message or its serialized bytes representation.
        """

        # Handle byte representation
        if isinstance(pb, bytes):
            pb = proto.Object.FromString(pb)

        # Handle Object fields
        Object.from_proto(self, pb)

        # Handle specific fields (currently none)
        pass





[docs]
class BuildingPart(Object):


[docs]
    def to_proto(self) -> proto.Object:
        """Return a protobuf representation of the BuildingPart.

        Returns
        -------
        proto.Object
            A protobuf representation of the BuildingPart as an Object.
        """

        # Handle Object fields
        pb = Object.to_proto(self)

        # Handle specific fields (currently none)
        _pb = proto.BuildingPart()
        pb.building_part.CopyFrom(_pb)

        return pb



[docs]
    def from_proto(self, pb: Union[proto.Object, bytes]):
        """Initialize BuildingPart from a protobuf representation.

        Parameters
        ----------
        pb: Union[proto.Object, bytes]
            The protobuf message or its serialized bytes representation.
        """

        # Handle byte representation
        if isinstance(pb, bytes):
            pb = proto.Object.FromString(pb)

        # Handle Object fields
        Object.from_proto(self, pb)

        # Handle specific fields (currently none)
        pass