Source code for dragonfly_uwg.properties.room2d

# coding=utf-8
"""Room2D UWG Properties."""


class Room2DUWGProperties(object):
    """UWG Properties for Dragonfly Room2D.

    Args:
        host: A dragonfly_core Room2D object that hosts these properties.

    Properties:
        * host
    """

    __slots__ = ('_host',)

    def __init__(self, host):
        """Initialize Room2D UWG properties."""
        self._host = host

    @property
    def host(self):
        """Get the Room2D object hosting these properties."""
        return self._host

    @classmethod
    def from_dict(cls, data, host):
        """Create Room2DUWGProperties from a dictionary.

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

        Args:
            data: A dictionary representation of Room2DUWGProperties.
            host: A Room2D object that hosts these properties.
        """
        assert data['type'] == 'Room2DUWGProperties', \
            'Expected Room2DUWGProperties. Got {}.'.format(data['type'])
        new_prop = cls(host)
        return new_prop

    def apply_properties_from_dict(self, abridged_data):
        """Apply properties from a Room2DUWGPropertiesAbridged dictionary.

        Args:
            abridged_data: A Room2DUWGPropertiesAbridged dictionary (typically
                coming from a Model).
        """
        pass  # currently no properties to apply

    def to_dict(self, abridged=False):
        """Return Room2D UWG properties as a dictionary.

        Args:
            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.
        """
        base = {'uwg': {}}
        base['uwg']['type'] = 'Room2DUWGProperties' if not \
            abridged else 'Room2DUWGPropertiesAbridged'
        return base

    def duplicate(self, new_host=None):
        """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.
        """
        _host = new_host or self._host
        return Room2DUWGProperties(_host)

    def ToString(self):
        return self.__repr__()

    def __repr__(self):
        return 'Room2D UWG Properties: {}'.format(self.host.identifier)