honeybee_plus.windowgroup module

Radiance window group.

class honeybee_plus.windowgroup.WindowGroup(name, sorted_points, is_name_set_by_user=False, is_type_set_by_user=False, states=None)

Bases: honeybee_plus.hbdynamicsurface.HBDynamicSurface

Honeybee window group.

A window group is a single or list of Honeybee surfaces with the same normal direction. Window groups are normally dynamic and have serveral states. It’s a subclass of HBDynamicSurface which can only be of type of glass.

Window groups are mainly useful for radiance daylight simulation.

name

A unique string for surface name

sorted_points

A list of 3 points or more as tuple or list with three items (x, y, z). Points should be sorted. This class won’t sort the points. If surfaces has multiple subsurfaces you can pass lists of point lists to this function (e.g. ((0, 0, 0), (10, 0, 0), (0, 10, 0))).

is_name_set_by_user

If you want the name to be changed by honeybee any case set is_name_set_by_user to True. Default is set to False which let Honeybee to rename the surface in cases like creating a newHBZone.

rad_properties

Radiance properties for this surface. If empty default RADProperties will be assigned to surface by Honeybee.

ep_properties

EnergyPlus properties for this surface. If empty default ep_properties will be assigned to surface by Honeybee.

states

A list of SurfaceStates for this dynamic surface.

check_normals()

Check the normal direction of the surfaces to match.

classmethod from_geometry(name, geometry, is_name_set_by_user=False, is_type_set_by_user=False, rad_properties=None, ep_properties=None, states=None)

Honeybee window group.

A window group is a single or list of Honeybee surfaces with the same normal direction. Window groups are normally dynamic and have serveral states.

Parameters

• name – A unique string for surface name.

• geometry – Input geometry.

• is_name_set_by_user – If you want the name to be changed by honeybee any case set is_name_set_by_user to True. Default is set to False which let Honeybee to rename the surface in cases like creating a newHBZone.

• rad_properties – Radiance properties for this surface. If empty default RADProperties will be assigned to surface by Honeybee.

• ep_properties – EnergyPlus properties for this surface. If empty default ep_properties will be assigned to surface by Honeybee.

• states – A list of SurfaceStates for this dynamic surface.

classmethod from_json(srf_json)

Create a surface from json object.

The minimum schema is: {“name”: “”, “vertices”: [[(x, y, z), (x1, y1, z1), (x2, y2, z2)]] }

isWindowGroup()

Return True for WindowGroup.