honeybee_display.aperture module

Method to translate a Aperture to a VisualizationSet.

honeybee_display.aperture.aperture_to_vis_set(aperture, color_by='type')

Translate a Honeybee Aperture to a VisualizationSet.

Parameters:

• aperture – A Honeybee Aperture object to be converted to a VisualizationSet.

• color_by –

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

  • type

  • boundary_condition

Returns:

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

honeybee_display.aperture.aperture_to_vis_set_wireframe(aperture, include_shades=True, color=None)

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

Parameters:

• aperture – A Honeybee Aperture object to be translated to a wireframe.

• include_shades – Boolean for whether the wireframe should include shades of the Aperture. (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 Aperture.