honeybee_idaice.face module

honeybee_idaice.face.face_reference_plane(face: Face, angle_tolerance: float = 1.0)[source]

Get a reference plane that is used to translate openings for a Face.

This plane will point inwards to the Room geometry and start in the lower left corner of the Face.

Parameters:

  • face – A Face from which the reference plane will be derived.

  • angle_tolerance – The max angle in degrees that Face normal can differ from the World Z before the Face is treated as being in the World XY plane. (Default: 1).

honeybee_idaice.face.face_to_idm(face: Face, origin: Point3D, index: int, angle_tolerance: float = 1.0, decimal_places: int = 3)[source]

Translate a HBJSON face to an IDM ENCLOSING-ELEMENT.

Parameters:

  • face – A Honeybee Face to be translated to IDM.

  • origin – A Point3D for the origin of the parent Room.

  • index – An integer for the index of the Face in the parent Room. The index starts from 1 for Walls, -1000 for ceilings and -2000 from floors.

  • angle_tolerance – The max angle in degrees that Face normal can differ from the World Z before the Face is treated as being in the World XY plane. (Default: 1).

  • decimal_places – An integer for the number of decimal places to which coordinate values will be rounded. (Default: 3).

honeybee_idaice.face.opening_to_idm(opening: Aperture | Door, ref_plane: Plane, is_aperture=True, decimal_places: int = 3, angle_tolerance: float = 1.0) → str[source]

Translate a HBJSON aperture or Door to an IDM Window.

Parameters:

  • opening – A Honeybee Aperture or Door to be translated to IDM.

  • ref_plane – A ladybug-geometry Plane object for the reference Plane of the parent geometry. This plane should be pointing inwards towards the Room volume.

  • is_aperture – A boolean to note whether the opening is an Aperture or a Door. (Default: True).

  • decimal_places – An integer for the number of decimal places to which coordinate values will be rounded. (Default: 3).

  • angle_tolerance – The max angle in degrees that opening normal can differ from the World Z before the opening is treated as being in the World XY plane. (Default: 1).