honeybee_3dm.layer module¶
Functions to work with layers in a rhino file.
-
honeybee_3dm.layer.child_parent_dict(file_3dm)[source]¶ Get a dictionary with child layer name and parent layer name structure.
- Parameters
file_3dm – A rhino3dm file object
- Returns
A a dictionary with child layer name and parent layer name structure.
-
honeybee_3dm.layer.filter_objects_by_layer_index(file_3dm, layer_index)[source]¶ Get all the objects in a layer based on layer index.
- Parameters
file_3dm – Input Rhino 3DM object.
layer_index – A list of indexes for Rhino layers
- Returns
A list of Rhino3dm objects.
-
honeybee_3dm.layer.objects_on_layer(file_3dm, layer)[source]¶ Get a list of objects on a layer.
- Parameters
file_3dm – Input Rhino3DM object.
layer – A Rhino3dm layer object.
- Returns
A list of Rhino3dm objects on a layer.
-
honeybee_3dm.layer.objects_on_parent_child(file_3dm, layer_name)[source]¶ Get all the objects on a layer and its child-layers.
- Parameters
file_3dm – Input Rhino3DM object.
layer_name – Rhino layer name.
- Returns
A list of Rhino3dm objects on the layer and its child layers.
-
honeybee_3dm.layer.parent_child_layers(file_3dm, layer_name)[source]¶ Get a list of parent and child layers for a layer.
- Parameters
file_3dm – A rhino3dm file object
layer_name – Text string of a layer name.
- Returns
A list of parent and child layer names.
-
honeybee_3dm.layer.visible_layers(file_3dm)[source]¶ Get a list of visible layers in the rhino file.
This function mimics layer visibilty in rhino. Only layers that are “on” in rhino are considered visible layers.
- Parameters
file_3dm – A rhino3dm file object.
- Returns
A list of rhino3dm layer objects for all the layers visible in rhino