honeybee_display.face module

Method to translate a Face to a VisualizationSet.

honeybee_display.face.face_to_vis_set(face, color_by='type')[source]

Translate a Honeybee Face to a VisualizationSet.

Parameters:

  • face – A Honeybee Face object to be converted to a VisualizationSet.

  • color_by –

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

    • type

    • boundary_condition

Returns:

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

honeybee_display.face.face_to_vis_set_wireframe(face, include_sub_faces=True, include_shades=True, color=None)[source]

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

Parameters:

  • face – A Honeybee Face object to be translated to a wireframe.

  • include_sub_faces – Boolean for whether the wireframe should include sub-faces of the Face. (Default: True).

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