Link Search Menu Expand Document

arena-py API v1.3.0

arena.objects.light

class Light(arena.objects.arena_object.Object):

Light object class to manage its properties in the ARENA: A light. More properties at https://aframe.io/docs/1.5.0/components/light.html A-Frame Light.

Parameters
  • **float angle: Maximum extent of spot light from its direction (in degrees). Requires type**: spot. Defaults to '60' (optional)
  • bool castShadow: Whether this light casts shadows on the scene. Defaults to 'False' (optional)
  • str color: Light color. For 'hemisphere', light color from above. Defaults to '#ffffff' (optional)
  • **float decay: Amount the light dims along the distance of the light. Requires type**: point or spot. Defaults to '1' (optional)
  • **float distance: Distance where intensity becomes 0. If distance is 0, then the point light does not decay with distance. Requires type**: point or spot. Defaults to '0' (optional)
  • str envMap: Cube Map to load. Defaults to 'None' (optional)
  • **str groundColor: Light color from below. Requires type**: hemisphere. Defaults to '#ffffff' (optional)
  • float intensity: Amount of light provided. Defaults to '1' (optional)
  • dict light: </strong>DEPRECATED: data.light.[property] is *</em>deprecated*, use object_type</strong>: light and data.[property] instead. (deprecated)</li>
  • **float penumbra: Percent of the spotlight cone that is attenuated due to penumbra. Requires type**: spot. Defaults to '0' (optional)
  • float shadowBias: Offset depth when deciding whether a surface is in shadow. Tiny adjustments here (in the order of +/-0.0001) may reduce artifacts in shadows. Defaults to '0' (optional)
  • **float shadowCameraBottom: Bottom plane of shadow camera frustum. Requires type**: directional. Defaults to '-5' (optional)
  • float shadowCameraFar: Far plane of shadow camera frustum. Defaults to '500' (optional)
  • **float shadowCameraFov: Shadow camera's FOV. Requires type**: point or spot. Defaults to '50' (optional)
  • **float shadowCameraLeft: Left plane of shadow camera frustum. Requires type**: directional. Defaults to '-5' (optional)
  • float shadowCameraNear: Near plane of shadow camera frustum. Defaults to '0.5' (optional)
  • **float shadowCameraRight: Right plane of shadow camera frustum. Requires type**: directional. Defaults to '5' (optional)
  • **float shadowCameraTop: Top plane of shadow camera frustum. Requires type**: directional. Defaults to '5' (optional)
  • bool shadowCameraVisible: Displays a visual aid showing the shadow camera's position and frustum. This is the light's view of the scene, used to project shadows. Defaults to 'False' (optional)
  • float shadowMapHeight: Shadow map's vertical resolution. Larger shadow maps display more crisp shadows, at the cost of performance. Defaults to '512' (optional)
  • float shadowMapWidth: Shadow map's horizontal resolution. Defaults to '512' (optional)
  • float shadowRadius: shadowRadius (castShadow=true) Defaults to '1' (optional)
  • **str target: Id of element the spot should point to. Set to null to transform spotlight by orientation, pointing to it's -Z axis. Requires type**: spot. Defaults to 'None' (optional)
  • str type: The type of light, or what shape the light should take. Allows [ambient, directional, hemisphere, point, spot] Defaults to 'directional' (optional)
    • </ul> </div>
    Light(**kwargs)
    object_type = 'light'
    light
    Inherited Members
    </section> </main> </div>