dragonfly_uwg.properties.room2d module

Room2D UWG Properties.

class dragonfly_uwg.properties.room2d.Room2DUWGProperties(host)[source]

Bases: object

UWG Properties for Dragonfly Room2D.

Parameters

host – A dragonfly_core Room2D object that hosts these properties.

Properties:

  • host

ToString()[source]
apply_properties_from_dict(abridged_data)[source]

Apply properties from a Room2DUWGPropertiesAbridged dictionary.

Parameters

abridged_data – A Room2DUWGPropertiesAbridged dictionary (typically coming from a Model).

duplicate(new_host=None)[source]

Get a copy of this object.

new_host: A new Room2D object that hosts these properties.

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

classmethod from_dict(data, host)[source]

Create Room2DUWGProperties from a dictionary.

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

Parameters

  • data – A dictionary representation of Room2DUWGProperties.

  • host – A Room2D object that hosts these properties.

to_dict(abridged=False)[source]

Return Room2D UWG properties as a dictionary.

Parameters

abridged – Boolean for whether the full dictionary of the Room2D should be written (False) or just the identifier of the the individual properties (True). Default: False.

property host

Get the Room2D object hosting these properties.