honeybee_display.room module¶
Method to translate a Room to a VisualizationSet.
- honeybee_display.room.room_to_vis_set(room, color_by='type')[source]¶
Translate a Honeybee Room to a VisualizationSet.
- Parameters:
room – A Honeybee Room object to be converted to a VisualizationSet.
color_by –
Text for the property that dictates the colors of the Room geometry. (Default: type). Choose from the following:
type
boundary_condition
- Returns:
A VisualizationSet object that represents the Room with a single ContextGeometry.
- honeybee_display.room.room_to_vis_set_wireframe(room, include_sub_faces=True, include_shades=True, color=None)[source]¶
Get a VisualizationSet with a single ContextGeometry for the room wireframe.
- Parameters:
room – A Honeybee Room object to be translated to a wireframe.
include_sub_faces – Boolean for whether the wireframe should include sub-faces of the Room. (Default: True).
include_shades – Boolean for whether the wireframe should include shades of the Room. (Default: True).
color – An optional Color object to set the color of the wireframe. If None, the color will be black.
- Returns:
A VisualizationSet with a single ContextGeometry and a list of DisplayLineSegment3D for the wireframe of the Room.