honeybee_designbuilder.properties.room module¶

Room DesignBuilder Properties.

class honeybee_designbuilder.properties.room.RoomDesignBuilderProperties(host, floor_geometry=None)[source]¶

Bases: object

DesignBuilder Properties for Honeybee Room.

Parameters:

host – A honeybee_core Room object that hosts these properties.
floor_geometry – An optional horizontal Face3D object, which will be used to compute block partitions and perimeters during export to dsbXML. If None, floor geometry is auto-calculated from the 3D Room geometry. Specifying a geometry here can help overcome some limitations of this auto-calculation and improve performance of dsbXML translation. (Default: None).

Properties:

apply_properties_from_dict(data)[source]¶

Apply properties from a RoomDesignBuilderProperties dictionary.

Parameters:: data – A RoomDesignBuilderProperties dictionary (typically coming from a Model).

duplicate(new_host=None)[source]¶

Get a copy of this object.

Parameters:: new_host – A new Room object that hosts these properties. If None, the properties will be duplicated with the same host.

classmethod from_dict(data, host)[source]¶

Create RoomDesignBuilderProperties from a dictionary.

Parameters:

data – A dictionary representation of RoomDesignBuilderProperties with the format below.
host – A Room object that hosts these properties.

{
"type": 'RoomDesignBuilderProperties',
"floor_geometry": {}  # optional Face3D dictionary
}

move(moving_vec)[source]¶

Move this object along a vector.

Parameters:: moving_vec – A ladybug_geometry Vector3D with the direction and distance to move the object.

reflect(plane)[source]¶

Reflect this object across a plane.

Parameters:: plane – A ladybug_geometry Plane across which the object will be reflected.

rotate(angle, axis, origin)[source]¶

Rotate this object by a certain angle around an axis and origin.

Parameters:

angle – An angle for rotation in degrees.
axis – Rotation axis as a Vector3D.
origin – A ladybug_geometry Point3D for the origin around which the object will be rotated.

rotate_xy(angle, origin)[source]¶

Rotate this object counterclockwise in the world XY plane by a certain angle.

Parameters:

angle – An angle in degrees.
origin – A ladybug_geometry Point3D for the origin around which the object will be rotated.

scale(factor, origin=None)[source]¶

Scale this object by a factor from an origin point.

Parameters:

factor – A number representing how much the object should be scaled.
origin – A ladybug_geometry Point3D representing the origin from which to scale. If None, it will be scaled from the World origin (0, 0, 0).

to_dict(abridged=False)[source]¶: Return Room DesignBuilder properties as a dictionary.

property floor_geometry¶: Get or set a horizontal Face3D to set the floor geometry.