on_fire

OnFire

Bases: HeatSourceOrSink, UpdateStateMixin

This state indicates the heat source is currently on fire.

Once the temperature is above ignition_temperature, OnFire will become True and stay True. Its temperature will further raise to fire_temperature, and start heating other objects around it. It may include a heatsource_link annotation (e.g. candle wick), in which case the fire visualization will be placed under that meta link. Otherwise (e.g. charcoal), the fire visualization will be placed under the root link.

Source code in omnigibson/object_states/on_fire.py

class OnFire(HeatSourceOrSink, UpdateStateMixin):
    """
    This state indicates the heat source is currently on fire.

    Once the temperature is above ignition_temperature, OnFire will become True and stay True.
    Its temperature will further raise to fire_temperature, and start heating other objects around it.
    It may include a heatsource_link annotation (e.g. candle wick), in which case the fire visualization will be placed
    under that meta link. Otherwise (e.g. charcoal), the fire visualization will be placed under the root link.
    """

    def __init__(
        self,
        obj,
        ignition_temperature=m.DEFAULT_IGNITION_TEMPERATURE,
        fire_temperature=m.DEFAULT_FIRE_TEMPERATURE,
        heating_rate=m.DEFAULT_HEATING_RATE,
        distance_threshold=m.DEFAULT_DISTANCE_THRESHOLD,
    ):
        """
        Args:
            obj (StatefulObject): The object with the heat source ability.
            ignition_temperature (float): The temperature threshold above which on fire will become true.
            fire_temperature (float): The temperature of the fire (heat source) once on fire is true.
            heating_rate (float): Fraction in [0, 1] of the temperature difference with the
                heat source temperature should be received every step, per second.
            distance_threshold (float): The distance threshold which an object needs
                to be closer than in order to receive heat from this heat source.
        """
        assert fire_temperature > ignition_temperature, "fire temperature should be higher than ignition temperature."

        super().__init__(
            obj,
            temperature=fire_temperature,
            heating_rate=heating_rate,
            distance_threshold=distance_threshold,
            requires_toggled_on=False,
            requires_closed=False,
            requires_inside=False,
        )
        self.ignition_temperature = ignition_temperature

    @classmethod
    def requires_metalink(cls, **kwargs):
        # Does not require metalink to be specified
        return False

    @property
    def _default_link(self):
        # Fallback to root link
        return self.obj.root_link

    @classmethod
    def get_dependencies(cls):
        deps = super().get_dependencies()
        deps.add(Temperature)
        return deps

    def _update(self):
        # If it's on fire, maintain the fire temperature
        if self.get_value():
            self.obj.states[Temperature].set_value(self.temperature)

    def _get_value(self):
        return self.obj.states[Temperature].get_value() >= self.ignition_temperature

    def _set_value(self, new_value):
        if new_value:
            return self.obj.states[Temperature].set_value(self.temperature)
        else:
            # We'll set the temperature just one degree below ignition.
            return self.obj.states[Temperature].set_value(self.ignition_temperature - 1)

    # Nothing needs to be done to save/load OnFire

__init__(obj, ignition_temperature=m.DEFAULT_IGNITION_TEMPERATURE, fire_temperature=m.DEFAULT_FIRE_TEMPERATURE, heating_rate=m.DEFAULT_HEATING_RATE, distance_threshold=m.DEFAULT_DISTANCE_THRESHOLD)

Parameters:

Name	Type	Description	Default
obj	StatefulObject	The object with the heat source ability.	required
ignition_temperature	float	The temperature threshold above which on fire will become true.	m.DEFAULT_IGNITION_TEMPERATURE
fire_temperature	float	The temperature of the fire (heat source) once on fire is true.	m.DEFAULT_FIRE_TEMPERATURE
heating_rate	float	Fraction in [0, 1] of the temperature difference with the heat source temperature should be received every step, per second.	m.DEFAULT_HEATING_RATE
distance_threshold	float	The distance threshold which an object needs to be closer than in order to receive heat from this heat source.	m.DEFAULT_DISTANCE_THRESHOLD

Source code in omnigibson/object_states/on_fire.py

def __init__(
    self,
    obj,
    ignition_temperature=m.DEFAULT_IGNITION_TEMPERATURE,
    fire_temperature=m.DEFAULT_FIRE_TEMPERATURE,
    heating_rate=m.DEFAULT_HEATING_RATE,
    distance_threshold=m.DEFAULT_DISTANCE_THRESHOLD,
):
    """
    Args:
        obj (StatefulObject): The object with the heat source ability.
        ignition_temperature (float): The temperature threshold above which on fire will become true.
        fire_temperature (float): The temperature of the fire (heat source) once on fire is true.
        heating_rate (float): Fraction in [0, 1] of the temperature difference with the
            heat source temperature should be received every step, per second.
        distance_threshold (float): The distance threshold which an object needs
            to be closer than in order to receive heat from this heat source.
    """
    assert fire_temperature > ignition_temperature, "fire temperature should be higher than ignition temperature."

    super().__init__(
        obj,
        temperature=fire_temperature,
        heating_rate=heating_rate,
        distance_threshold=distance_threshold,
        requires_toggled_on=False,
        requires_closed=False,
        requires_inside=False,
    )
    self.ignition_temperature = ignition_temperature