honeybee_energy_ph.properties.space module

PH Properties classes for Space objects.

class honeybee_energy_ph.properties.space.SpaceEnergyProperties(_host)[source]

Bases: _Properties

ToString()[source]

Overwrite .NET ToString method.

classmethod from_dict(_input_dict: dict, _host: Any) → SpaceEnergyProperties[source]
is_equivalent(other_properties)

Get a dictionary noting the equivalency of these properties to other ones.

The keys of this dictionary will note the name of each extension (eg. energy, radiance) and the values will be a boolean for whether the extension properties are equivalent or not.

Parameters:

other_properties – Properties of another object for which equivalency will be tested.

move(moving_vec)

Apply a move transform to extension attributes.

This is useful in cases where extension attributes possess geometric data that should be moved alongside the host object. For example, dynamic geometry within the honeybee-radiance state of an aperture should be moved if the host aperture is moved.

Parameters:

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

reflect(plane)

Apply a reflection transform to extension attributes.

This is useful in cases where extension attributes possess geometric data that should be reflected alongside the host object. For example, dynamic geometry within the honeybee-radiance state of an aperture should be reflected if the host aperture is reflected.

Parameters:

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

rotate(axis, angle, origin)

Apply a rotation transform to extension attributes.

This is useful in cases where extension attributes possess geometric data that should be rotated alongside the host object. For example, dynamic geometry within the honeybee-radiance state of an aperture should be rotated if the host aperture is rotated.

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)

Apply a rotation in the XY plane to extension attributes.

This is useful in cases where extension attributes possess geometric data that should be rotated alongside the host object. For example, dynamic geometry within the honeybee-radiance state of an aperture should be rotated if the host aperture is rotated.

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)

Apply a scale transform to extension attributes.

This is useful in cases where extension attributes possess geometric data that should be scaled alongside the host object. For example, dynamic geometry within the honeybee-radiance state of an aperture should be scaled if the host aperture is scaled.

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: bool = False, include: list | None = None) → dict[str, Any][source]

Convert properties to 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.

  • include – A list of keys to be included in dictionary. If None all the available keys will be included.

property host

Get the object hosting these properties.