honeybee_display.model module

Method to translate a Model to a VisualizationSet.

honeybee_display.model.model_comparison_to_vis_set(base_model, incoming_model, base_color=None, incoming_color=None)

Translate two Honeybee Models to be compared to a VisualizationSet.

Parameters:

• base_model – A Honeybee Model object for the base model used in the comparison. Typically, this is the model with more data to be kept.

• incoming_model – A Honeybee Model object for the incoming model used in the comparison. Typically, this is the model with new data to be evaluated against the base model.

• base_color – An optional ladybug Color to set the color of the base model. If None, a default blue color will be used. (Default: None).

• incoming_color – An optional ladybug Color to set the color of the incoming model. If None, a default red color will be used. (Default: None).

honeybee_display.model.model_to_vis_set(model, color_by='type', include_wireframe=True, use_mesh=True, hide_color_by=False, room_attrs=None, face_attrs=None, grid_display_mode='Default', hide_grid=True, grid_data_path=None, grid_data_display_mode='Surface', active_grid_data=None)

Translate a Honeybee Model to a VisualizationSet.

Parameters:

• model – A Honeybee Model object to be converted to a VisualizationSet.

• color_by –

  Text that dictates the colors of the Model geometry. If none, only a wireframe of the Model will be generated, assuming include_wireframe is True. This is useful when the primary purpose of the visualization is to display results in relation to the Model geometry or display some room_attrs or face_attrs as an AnalysisGeometry or Text labels. (Default: type). Choose from the following:

  • type

  • boundary_condition

  • None

• include_wireframe – Boolean to note whether a ContextGeometry dedicated to the Model Wireframe (in DisplayLineSegment3D) should be included in the output VisualizationSet. (Default: True).

• use_mesh – Boolean to note whether the colored model geometries should be represented with DisplayMesh3D objects (True) instead of DisplayFace3D objects (False). Meshes can usually be rendered faster and they scale well for large models but all geometry is triangulated (meaning that the wireframe in certain platforms might not appear ideal). (Default: True).

• hide_color_by – Boolean to note whether the color_by geometry should be hidden or shown by default. Hiding the color-by geometry is useful when the primary purpose of the visualization is to display grid_data or room/face attributes but it is still desirable to have the option to turn on the geometry.

• room_attrs – An optional list of room attribute objects.

• face_attrs – An optional list of face attribute objects.

• grid_display_mode –

  Text that dictates how the ContextGeometry for Model SensorGrids should display in the resulting visualization. The Default option will draw sensor points whenever there is no grid_data_path and won’t draw them at all when grid data is provided, assuming the AnalysisGeometry of the grids is sufficient. Choose from the following:

  • Default

  • Points

  • Wireframe

  • Surface

  • SurfaceWithEdges

  • None

• hide_grid – Boolean to note whether the SensorGrid ContextGeometry should be hidden or shown by default. (Default: True).

• grid_data_path – An optional path to a folder containing data that aligns with the SensorGrids in the model. Any sub folder within this path that contains a grids_into.json (and associated CSV files) will be converted to an AnalysisGeometry in the resulting VisualizationSet. If a vis_metadata.json file is found within this sub-folder, the information contained within it will be used to customize the AnalysisGeometry. Note that it is acceptable if data and grids_info.json exist in the root of this grid_data_path. Also note that this argument has no impact if honeybee-radiance is not installed and SensorGrids cannot be decoded. (Default: None).

• grid_data_display_mode –

  Optional text to set the display_mode of the AnalysisGeometry that is is generated from the grid_data_path above. Note that this has no effect if there are no meshes associated with the model SensorGrids. (Default: Surface). Choose from the following:

  • Surface

  • SurfaceWithEdges

  • Wireframe

  • Points

• active_grid_data – Optional text to specify the active data in the AnalysisGeometry. This should match the name of the sub-folder within the grid_data_path that should be active. If None, the first data set in the grid_data_path with be active. (Default: None).

Returns:

A VisualizationSet object that represents the model.

honeybee_display.model.model_to_vis_set_wireframe(model, color=None)

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

Parameters:

• model – A Honeybee Model 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 Model.