honeybee_radiance.properties.shade module

Shade Radiance Properties.

class honeybee_radiance.properties.shade.ShadeRadianceProperties(host, modifier=None, modifier_blk=None, dynamic_group_identifier=None)[source]

Bases: honeybee_radiance.properties._base._DynamicRadianceProperties

Radiance Properties for Honeybee Shade.

Parameters
  • host – A honeybee_core Shade object that hosts these properties.

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

  • modifier_blk – A Honeybee Radiance Modifier object to be used for this shade 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.

  • dynamic_group_identifier – An optional string to note the dynamic group to which the Shade is a part of. Shades sharing the same dynamic_group_identifier will have their states change in unison. If None, the Shade is assumed to be static.

Properties:
  • host

  • modifier

  • modifier_blk

  • dynamic_group_identifier

  • states

  • state_count

  • is_opaque

  • is_modifier_set_on_object

  • is_blk_overridden

ToString()
add_state(state)

Add a Radiance state object to this object.

Parameters

state – A Radiance state object to add to the this object.

apply_properties_from_dict(abridged_data, modifiers)[source]

Apply properties from a ShadeRadiancePropertiesAbridged dictionary.

Parameters
  • abridged_data – A ShadeRadiancePropertiesAbridged 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': 'ShadeRadiancePropertiesAbridged',
'modifier': str,  # A Honeybee Radiance Modifier identifier
'modifier_blk': str,  # A Honeybee Radiance Modifier identifier
'dynamic_group_identifier': str,  # An optional dynamic group identifier
'states': []  # An optional list of states
}
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)[source]

Create ShadeRadianceProperties from a dictionary.

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

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

  • host – A Shade object that hosts these properties.

{
'type': 'ShadeRadianceProperties',
'modifier': {},  # A Honeybee Radiance Modifier dictionary
'modifier_blk': {},  # A Honeybee Radiance Modifier dictionary
'dynamic_group_identifier': str,  # An optional dynamic group identifier
'states': []  # An optional list of states
}
move(moving_vec)

Move all state geometry along a vector.

Parameters

moving_vec – A ladybug_geometry Vector3D with the direction and distance to move the shades.

reflect(plane)

Reflect all state geometry across a plane.

Parameters

plane – A ladybug_geometry Plane across which the object will be reflected.

remove_states()

Remove all states assigned to this object.

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.

rotate(axis, angle, origin)

Rotate all state geometry.

Parameters
  • axis – A ladybug_geometry Vector3D axis representing the axis of rotation.

  • angle – An angle for rotation in degrees.

  • origin – A ladybug_geometry Point3D for the origin around which the object will be rotated.

rotate_xy(angle, origin)

Rotate all state geometry counterclockwise in the world XY plane.

Parameters
  • angle – An angle in degrees.

  • origin – A ladybug_geometry Point3D for the origin around which the object will be rotated.

scale(factor, origin=None)

Scale all state geometry by a factor.

Parameters
  • factor – A number representing how much the object should be scaled.

  • origin – A ladybug_geometry Point3D representing the origin from which to scale. If None, it will be scaled from the World origin (0, 0, 0).

to_dict(abridged=False)[source]

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 dynamic_group_identifier

Get or set a text string for the dynamic_group_identifier.

Objects sharing the same dynamic_group_identifier will have their states change in unison. If None, the object is assumed to be static.

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 Shade modifier.

If the modifier is not set on the shade-level, then it will be assigned based on the ModifierSet assigned to the parent Room. If the parent Room’s ModifierSet has no modifier for the Shade type, it will be assigned using the honeybee default generic ModifierSet. If there is no parent Room, it will be the generic context material.

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.

property state_count

Get an integer for the number of dynamic states assigned to the object.

property states

Get or set an array of radiance states assigned to this object.

These cannot be set unless there is also a dynamic_group_identifier for the object.