Hugging Face's logo

Simulate documentation

Lights

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Lights

class simulate.Light

< >

( intensity: float = 1.0 color: typing.Optional[typing.List[float]] = None range: typing.Optional[float] = None inner_cone_angle: typing.Union[float, numpy.ndarray] = 0.0 outer_cone_angle: typing.Union[float, numpy.ndarray] = 45.0 light_type: str = 'directional' name: typing.Optional[str] = None position: typing.Optional[typing.List[float]] = None rotation: typing.Optional[typing.List[float]] = None scaling: typing.Union[float, typing.List[float], NoneType] = None is_actor: bool = False parent: typing.Optional[ForwardRef('Asset')] = None children: typing.Optional[typing.List[ForwardRef('Asset')]] = None )

Parameters

  • intensity (float, optional, defaults to 1.0) — The intensity of the light.
  • color (List[float], optional, defaults to [1.0, 1.0, 1.0]) — The color of the light.
  • range (float, optional, defaults to None) — The range of the light.
  • inner_cone_angle (float or np.ndarray, optional, defaults to 0.0) — The inner cone angle of the light.
  • outer_cone_angle (float or np.ndarray, optional, defaults to 45.0) — The outer cone angle of the light.
  • light_type (str, optional, defaults to "directional") — The type of the light. 2 types of punctual lights are implemented:
    • "directional": an infinitely distant point source
    • "positional": point sources located in the real-world. A cone angle can be defined to limit the spatial distribution of a positional light beam in which case these are often known as spotlight. a Value of None or above 90 degree means no spatial limitation.
  • name (str, optional, defaults to None) — The name of the light.
  • position (List[float], optional, defaults to [0.0, 0.0, 0.0]) — The position of the light.
  • rotation (List[float], optional, defaults to [0.0, 0.0, 0.0]) — The rotation of the light.
  • scaling (float or List[float], optional, defaults to 1.0) — The scaling of the light.
  • is_actor (bool, optional, defaults to False) — Whether the light is an actor.
  • parent (Asset, optional, defaults to None) — The parent of the light.
  • children (List[Asset], optional, defaults to None) — The children of the light.

A Scene Light. Punctual lights are defined as infinitely small points that emit light in well-defined directions and intensities. Angles are in degrees.

copy

< >

( with_children: bool = True **kwargs: typing.Any ) → copy (Light)

Parameters

  • with_children (bool, optional, defaults to True) — Whether to copy the children of the asset.

Returns

copy (Light)

The copy of the asset.

Make a copy of the Asset.

Under construction 🚧.

←Objects Kinematics→