ladybug_rhino.bakeobjects module

Functions to bake entire Ladybug objects into the Rhino scene.

The methods here are intended to help translate groups of geometry that are commonly generated by several objects in Ladybug core (ie. legends, compasses, visualization sets, etc.)

ladybug_rhino.bakeobjects.bake_analysis(analysis, layer_name=None, bake_3d_legend=False, min_point=None, max_point=None)[source]

Add a Ladybug Display AnalysisGeometry object to the Rhino scene.

Parameters:

  • analysis – A Ladybug Display AnalysisGeometry object to be added to the Rhino scene.

  • layer_name – Optional text string for the parent layer name on which to place the AnalysisGeometry. The actual layer of the context will always have a name that aligns with the AnalysisGeometry.display_name.

  • bake_3d_legend – A Boolean to note whether the AnalysisGeometry should be baked with 3D legends for any AnalysisGeometries it includes. (Default: False).

  • min_point – An optional Point3D to override the default min point that are used to generate the legend. (Default: None).

  • max_point – An optional Point3D to override the default max point that are used to generate the legend. (Default: None).

Returns:

A list of IDs that point to the objects in the Rhino scene.

ladybug_rhino.bakeobjects.bake_context(context, layer_name=None)[source]

Add a Ladybug Display ContextGeometry object to the Rhino scene.

Parameters:

  • context – A Ladybug Display ContextGeometry object to be added to the Rhino scene.

  • layer_name – Optional text string for the parent layer name on which to place the ContextGeometry. The actual layer of the context will always have a name that aligns with the ContextGeometry.display_name.

Returns:

A list of IDs that point to the objects in the Rhino scene.

ladybug_rhino.bakeobjects.bake_legend(legend, layer_name=None)[source]

Add a Ladybug Legend object to the Rhino scene.

Parameters:

  • legend – A Ladybug Legend object to be added to the Rhino scene.

  • layer_name – Optional text string for the layer name on which to place the legend. If None, text will be added to the current layer.

Returns:

A list of IDs that point to the objects in the Rhino scene in the following order:

  • legend_mesh – A colored mesh for the legend.

  • legend_title – A text object for the legend title.

  • legend_text – Text objects for the rest of the legend text.

ladybug_rhino.bakeobjects.bake_visualization_set(vis_set, bake_3d_legend=False)[source]

Add a Ladybug Display VisualizationSet object to the Rhino scene.

Parameters:

  • context_geometry – A Ladybug VisualizationSet object to be added to the Rhino scene.

  • bake_3d_legend – A Boolean to note whether the VisualizationSet should be baked with 3D legends for any AnalysisGeometries it includes. (Default: False).

Returns:

A list of IDs that point to the objects in the Rhino scene.