honeybee_3dm.helper module

A collection of general and config helper functions

honeybee_3dm.helper.check_parent_in_config(file_3dm, config, layer_name, parent_layer_name)

Checks if the parent layer of a layer is already mentioned in the config file.

This function will return True if the parent layer of a layer is already mentioned in the config file and child layers are requested from that parent layer in the config file.

Parameters

• file_3dm – A rhino3dm file objects.

• config – A dictionary of the config settings.

• layer_name – A text string of the layer name

• parent_layer_name – A text string of the parent layer name

Returns

A bool.

honeybee_3dm.helper.child_layer_control(config, layer_name)

Checks if child layers are requested for a layer in the config file.

Parameters

• config – A dictionary of the config settings.

• layer_name – A text string of the layer name

Returns

A bool.

honeybee_3dm.helper.face3d_to_hb_face_with_face_type(config, face_obj, name, layer_name)

Create a Honeybee Face object with a specific face_type.

This function returns a Honeybee Face object with a specific face_type requested in the config file and also assign a radiance material to the face if requested from the config file.

Parameters

• config – A dictionary of the config settings.

• face_obj – A Ladybug Face3d object.

• name – A text string of the name of the rhino object.

• layer_name – A text string of the rhino layer name.

Returns

A Honeybee Face object.

honeybee_3dm.helper.face3d_to_hb_face_with_rad(config, face_obj, name, layer_name)

Create a Honeybee Face object with a radiance material assigned to it.

Parameters

• config – A dictionary of the config settings.

• face_obj – A Ladybug Face3d object.

• name – A text string of the name of the rhino object.

• layer_name – A text string of the rhino layer name.

Returns

A Honeybee Face object.

honeybee_3dm.helper.face3d_to_hb_object(config, face_obj, name, layer_name)

Create Honeybee Aperture, Shade, and Door objects.

Parameters

• config – A dictionary of the config settings.

• face_obj – A Ladybug Face3d object.

• name – A text string of the name of the rhino object.

• layer_name – A text string of the rhino layer name.

Returns

A tuple of lists;

• Honeybee Aperture objects,

• Honeybee Shade objects,

• Honeybee Door objects.

List will be empty if no objects are found for that Honeybee object.

honeybee_3dm.helper.get_unit_system(file_3dm)

Get units from a 3dm file object.

Parameters

file_3dm – A Rhino3dm file object.

Returns

Rhino3dm file unit as a string.

honeybee_3dm.helper.grid_controls(config, layer_name)

Returns grid controls for a layer from the config.

Parameters

grid_controls – A list of grid controls from the config file

Returns

A tuple of grid controls

• grid_size,

• grid_offset.

if valid grid settings are found in the config file or None