honeybee_plus.hbshadesurface module

class honeybee_plus.hbshadesurface.HBShadingSurface(name, sorted_points=[], is_name_set_by_user=False, rad_properties=None, ep_properties=None, states=None)[source]

Bases: honeybee_plus._hbanalysissurface.HBAnalysisSurface

Honeybee shading surface.

Parameters

  • 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.

classmethod from_ep_string(ep_string)[source]

Init Honeybee shading from an ep_string.

Supported types are Shading:Site:Detailed, Shading:Building:Detailed, Shading:Zone:Detailed

Parameters

ep_string – The full ep_string for an EnergyPlus shading object.

property isHBShadingSurface

Return True for HBFenSurface.

property is_child_surface

Return True if Honeybee surface is Fenestration Surface.

property parent

Get or set parent zone.