honeybee_display.shade module

Method to translate a Shade to a VisualizationSet.

honeybee_display.shade.shade_to_vis_set(shade, color_by='type')

Translate a Honeybee Shade to a VisualizationSet.

Parameters:

• shade – A Honeybee Shade object to be converted to a VisualizationSet.

• color_by –

  Text for the property that dictates the colors of the Shade geometry. (Default: type). Choose from the following:

  • type

  • boundary_condition

Returns:

A VisualizationSet object that represents the Shade with a single ContextGeometry.

honeybee_display.shade.shade_to_vis_set_wireframe(shade, color=None)

Get a VisualizationSet with a single ContextGeometry for the shade wireframe.

Parameters:

• shade – A Honeybee Shade object to be translated to a wireframe.

• 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 Shade.