honeybee_radiance.properties.shademesh module

ShadeMesh Radiance Properties.

class honeybee_radiance.properties.shademesh.ShadeMeshRadianceProperties(host, modifier=None, modifier_blk=None)

Bases: _RadianceProperties

Radiance Properties for Honeybee ShadeMesh.

Parameters:

• host – A honeybee_core ShadeMesh object that hosts these properties.

• modifier – A Honeybee Radiance Modifier object for the shade mesh. If None, it will be set by the default generic ModifierSet.

• modifier_blk – A Honeybee Radiance Modifier object to be used for this shade mesh in direct solar simulations and in isolation studies (assessing the contribution of individual Apertures). If None, this will be a completely black material if the Shade’s modifier is opaque and will be equal to the modifier if the Shade’s modifier is non-opaque.

Properties:

• host

• modifier

• modifier_blk

• is_opaque

• is_modifier_set_on_object

• is_blk_overridden

ToString()

apply_properties_from_dict(abridged_data, modifiers)

Apply properties from a ShadeMeshRadiancePropertiesAbridged dictionary.

Parameters:

• abridged_data – A ShadeMeshRadiancePropertiesAbridged dictionary (typically coming from a Model) with the format below.

• modifiers – A dictionary of modifiers with modifier identifiers as keys, which will be used to re-assign modifiers.

{
'type': 'ShadeMeshRadiancePropertiesAbridged',
'modifier': str,  # A Honeybee Radiance Modifier identifier
'modifier_blk': str  # A Honeybee Radiance Modifier identifier
}

duplicate(new_host=None)

Get a copy of this object.

new_host: A new object that hosts these properties.

If None, the properties will be duplicated with the same host.

classmethod from_dict(data, host)

Create ShadeMeshRadianceProperties from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters:

• data – A dictionary representation of ShadeMeshRadianceProperties with the format below.

• host – A ShadeMesh object that hosts these properties.

{
'type': 'ShadeMeshRadianceProperties',
'modifier': {},  # A Honeybee Radiance Modifier dictionary
'modifier_blk': {}  # A Honeybee Radiance Modifier dictionary
}

is_equivalent(other)

Check to see if these energy properties are equivalent to another object.

This will only be True if all properties match (except for the host) and will otherwise be False.

reset_to_default()

Reset a Modifier assigned at the level of this Shade to the default.

This means that the Shade’s modifier will be assigned by a ModifierSet instead.

to_dict(abridged=False)

Return radiance properties as a dictionary.

Parameters:

abridged – Boolean to note whether the full dictionary describing the object should be returned (False) or just an abridged version (True). Default: False.

property host

Get the object hosting these properties.

property is_blk_overridden

Boolean noting if modifier_blk has been overridden from default on this object.

property is_modifier_set_on_object

Boolean noting if modifier is assigned on the level of this object.

This is opposed to having the modifier assigned by a ModifierSet.

property is_opaque

Boolean noting whether this object has an opaque modifier.

This has repercussions for how this object is written into the Radiance folder structure.

property modifier

Get or set the ShadeMesh modifier.

If the modifier is not set on the shade-level, then it will be the generic context material or the generic exterior shade modifier if it is not detached.

property modifier_blk

Get or set a modifier to be used in direct solar and in isolation studies.

If None, this will be a completely black material if the object’s modifier is opaque and will be equal to the modifier if the object’s modifier is non-opaque.