Light

class Light

property id

The id of the light.

Type

str, read-only

property name

The name of the light.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property layer

The parent lighting layer of this light.

Type

LightingLayer, read-only

property group

The group of this light or None if the light is at the root of the hierarchy.

Type

LightGroup or None

Raises

ReadOnlyError -- If Database is in read only mode.

property enabled

The light enabled state.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property position

The light position in world.

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property rotation

The light rotation in world (in degrees).

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property color

The color of the light.

Type

ColorRgb

Raises

ReadOnlyError -- If Database is in read only mode.

property intensity

The light intensity.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property cast_shadow

Whether the light casts shadows.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property shadow_intensity

The shadow intensity (the intensity of the light when in shadows).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property shadow_integrity

The shadow integrity.

Type

ShadowIntegrity

Raises

ReadOnlyError -- If Database is in read only mode.

remove()

Delete this light.

Raises

ReadOnlyError -- If Database is in read only mode.

CylinderAreaLight

class CylinderAreaLight

Base class: Light

property id

The id of the light.

Type

str, read-only

property name

The name of the light.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property layer

The parent lighting layer of this light.

Type

LightingLayer, read-only

property group

The group of this light or None if the light is at the root of the hierarchy.

Type

LightGroup or None

Raises

ReadOnlyError -- If Database is in read only mode.

property enabled

The light enabled state.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property position

The light position in world.

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property rotation

The light rotation in world (in degrees).

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property color

The color of the light.

Type

ColorRgb

Raises

ReadOnlyError -- If Database is in read only mode.

property intensity

The light intensity.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property cast_shadow

Whether the light casts shadows.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property shadow_intensity

The shadow intensity (the intensity of the light when in shadows).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property shadow_integrity

The shadow integrity.

Type

ShadowIntegrity

Raises

ReadOnlyError -- If Database is in read only mode.

property attenuation_type

The light attenuation type.

Note

When bounded_attenuation is True, the attenuation type affects how the light is attenuated between attenuation_full_effect and attenuation_falloff.

Type

LightAttenuation

Raises

ReadOnlyError -- If Database is in read only mode.

property bounded_attenuation

Whether the light attenuation is bounded by attenuation_full_effect and attenuation_falloff.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property attenuation_full_effect

The distance (in meters) from light for which surfaces are illuminated without attenuation. It is only effective if bounded_attenuation is True.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If attenuation_full_effect > attenuation_falloff or if trying to set a negative distance.

property attenuation_falloff

The distance (in meters) from light for which surfaces are not illuminated anymore. It is only effective if bounded_attenuation is True.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If attenuation_falloff < attenuation_full_effect or if trying to set a negative distance.

property diameter

The diameter (in meters) of the cylinder.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative size.

property length

The length (in meters) of the cylinder.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative size.

remove()

Delete this light.

Raises

ReadOnlyError -- If Database is in read only mode.

MeshAreaLight

class MeshAreaLight

Base class: Light

property id

The id of the light.

Type

str, read-only

property name

The name of the light.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property layer

The parent lighting layer of this light.

Type

LightingLayer, read-only

property group

The group of this light or None if the light is at the root of the hierarchy.

Type

LightGroup or None

Raises

ReadOnlyError -- If Database is in read only mode.

property enabled

The light enabled state.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property position

The light position in world.

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property rotation

The light rotation in world (in degrees).

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property color

The color of the light.

Type

ColorRgb

Raises

ReadOnlyError -- If Database is in read only mode.

property intensity

The light intensity.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property cast_shadow

Whether the light casts shadows.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property shadow_intensity

The shadow intensity (the intensity of the light when in shadows).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property shadow_integrity

The shadow integrity.

Type

ShadowIntegrity

Raises

ReadOnlyError -- If Database is in read only mode.

property attenuation_type

The light attenuation type.

Note

When bounded_attenuation is True, the attenuation type affects how the light is attenuated between attenuation_full_effect and attenuation_falloff.

Type

LightAttenuation

Raises

ReadOnlyError -- If Database is in read only mode.

property bounded_attenuation

Whether the light attenuation is bounded by attenuation_full_effect and attenuation_falloff.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property attenuation_full_effect

The distance (in meters) from light for which surfaces are illuminated without attenuation. It is only effective if bounded_attenuation is True.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If attenuation_full_effect > attenuation_falloff or if trying to set a negative distance.

property attenuation_falloff

The distance (in meters) from light for which surfaces are not illuminated anymore. It is only effective if bounded_attenuation is True.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If attenuation_falloff < attenuation_full_effect or if trying to set a negative distance.

property surface

The surface to use as area light or None if no surface is set.

Type

Surface or None

Raises

ReadOnlyError -- If Database is in read only mode.

remove()

Delete this light.

Raises

ReadOnlyError -- If Database is in read only mode.

OmniLight

class OmniLight

Base class: Light

property id

The id of the light.

Type

str, read-only

property name

The name of the light.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property layer

The parent lighting layer of this light.

Type

LightingLayer, read-only

property group

The group of this light or None if the light is at the root of the hierarchy.

Type

LightGroup or None

Raises

ReadOnlyError -- If Database is in read only mode.

property enabled

The light enabled state.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property position

The light position in world.

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property rotation

The light rotation in world (in degrees).

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property color

The color of the light.

Type

ColorRgb

Raises

ReadOnlyError -- If Database is in read only mode.

property intensity

The light intensity.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property cast_shadow

Whether the light casts shadows.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property shadow_intensity

The shadow intensity (the intensity of the light when in shadows).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property shadow_integrity

The shadow integrity.

Type

ShadowIntegrity

Raises

ReadOnlyError -- If Database is in read only mode.

property diameter

The diameter of the light (in meters).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative diameter.

property attenuation_type

The light attenuation type.

Note

When bounded_attenuation is True, the attenuation type affects how the light is attenuated between attenuation_full_effect and attenuation_falloff.

Type

LightAttenuation

Raises

ReadOnlyError -- If Database is in read only mode.

property bounded_attenuation

Whether the light attenuation is bounded by attenuation_full_effect and attenuation_falloff.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property attenuation_full_effect

The distance (in meters) from light for which surfaces are illuminated without attenuation. It is only effective if bounded_attenuation is True.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If attenuation_full_effect > attenuation_falloff or if trying to set a negative distance.

property attenuation_falloff

The distance (in meters) from light for which surfaces are not illuminated anymore. It is only effective if bounded_attenuation is True.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If attenuation_falloff < attenuation_full_effect or if trying to set a negative distance.

remove()

Delete this light.

Raises

ReadOnlyError -- If Database is in read only mode.

PlaneAreaLight

class PlaneAreaLight

Base class: Light

property id

The id of the light.

Type

str, read-only

property name

The name of the light.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property layer

The parent lighting layer of this light.

Type

LightingLayer, read-only

property group

The group of this light or None if the light is at the root of the hierarchy.

Type

LightGroup or None

Raises

ReadOnlyError -- If Database is in read only mode.

property enabled

The light enabled state.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property position

The light position in world.

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property rotation

The light rotation in world (in degrees).

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property color

The color of the light.

Type

ColorRgb

Raises

ReadOnlyError -- If Database is in read only mode.

property intensity

The light intensity.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property cast_shadow

Whether the light casts shadows.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property shadow_intensity

The shadow intensity (the intensity of the light when in shadows).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property shadow_integrity

The shadow integrity.

Type

ShadowIntegrity

Raises

ReadOnlyError -- If Database is in read only mode.

property attenuation_type

The light attenuation type.

Note

When bounded_attenuation is True, the attenuation type affects how the light is attenuated between attenuation_full_effect and attenuation_falloff.

Type

LightAttenuation

Raises

ReadOnlyError -- If Database is in read only mode.

property bounded_attenuation

Whether the light attenuation is bounded by attenuation_full_effect and attenuation_falloff.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property attenuation_full_effect

The distance (in meters) from light for which surfaces are illuminated without attenuation. It is only effective if bounded_attenuation is True.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If attenuation_full_effect > attenuation_falloff or if trying to set a negative distance.

property attenuation_falloff

The distance (in meters) from light for which surfaces are not illuminated anymore. It is only effective if bounded_attenuation is True.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If attenuation_falloff < attenuation_full_effect or if trying to set a negative distance.

property width

The width (in meters) of the plane.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative size.

property height

The height (in meters) of the plane.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative size.

remove()

Delete this light.

Raises

ReadOnlyError -- If Database is in read only mode.

SkyLight

class SkyLight

Base class: Light

property id

The id of the light.

Type

str, read-only

property name

The name of the light.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property layer

The parent lighting layer of this light.

Type

LightingLayer, read-only

property group

The group of this light or None if the light is at the root of the hierarchy.

Type

LightGroup or None

Raises

ReadOnlyError -- If Database is in read only mode.

property enabled

The light enabled state.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property position

The light position in world.

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property rotation

The light rotation in world (in degrees).

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property color

The color of the light.

Type

ColorRgb

Raises

ReadOnlyError -- If Database is in read only mode.

property intensity

The light intensity.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property cast_shadow

Whether the light casts shadows.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property shadow_intensity

The shadow intensity (the intensity of the light when in shadows).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property shadow_integrity

The shadow integrity.

Type

ShadowIntegrity

Raises

ReadOnlyError -- If Database is in read only mode.

property top_angle

The sky top angle (in degrees in [-90, 90] range).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If top_angle <= bottom_angle or if not in [-90, 90] range.

property bottom_angle

The sky bottom angle (in degrees in [-90, 90] range).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If bottom_angle >= top_angle or if not in [-90, 90] range.

remove()

Delete this light.

Raises

ReadOnlyError -- If Database is in read only mode.

SpotLight

class SpotLight

Base class: Light

property id

The id of the light.

Type

str, read-only

property name

The name of the light.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property layer

The parent lighting layer of this light.

Type

LightingLayer, read-only

property group

The group of this light or None if the light is at the root of the hierarchy.

Type

LightGroup or None

Raises

ReadOnlyError -- If Database is in read only mode.

property enabled

The light enabled state.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property position

The light position in world.

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property rotation

The light rotation in world (in degrees).

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property color

The color of the light.

Type

ColorRgb

Raises

ReadOnlyError -- If Database is in read only mode.

property intensity

The light intensity.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property cast_shadow

Whether the light casts shadows.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property shadow_intensity

The shadow intensity (the intensity of the light when in shadows).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property shadow_integrity

The shadow integrity.

Type

ShadowIntegrity

Raises

ReadOnlyError -- If Database is in read only mode.

property diameter

The diameter of the light (in meters).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative diameter.

property target

The target position of the spot in world.

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property falloff

The falloff of the spot (in degrees in [0, 175] range).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If falloff < hot_spot or if not in [0, 175] range.

property hot_spot

The hot spot (aperture) of the spot (in degrees in [0, 175] range).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If hot_spot > falloff or if not in [0, 175] range.

property attenuation_type

The light attenuation type.

Note

When bounded_attenuation is True, the attenuation type affects how the light is attenuated between attenuation_full_effect and attenuation_falloff.

Type

LightAttenuation

Raises

ReadOnlyError -- If Database is in read only mode.

property bounded_attenuation

Whether the light attenuation is bounded by attenuation_full_effect and attenuation_falloff.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property attenuation_full_effect

The distance (in meters) from light for which surfaces are illuminated without attenuation. It is only effective if bounded_attenuation is True.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If attenuation_full_effect > attenuation_falloff or if trying to set a negative distance.

property attenuation_falloff

The distance (in meters) from light for which surfaces are not illuminated anymore. It is only effective if bounded_attenuation is True.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If attenuation_falloff < attenuation_full_effect or if trying to set a negative distance.

remove()

Delete this light.

Raises

ReadOnlyError -- If Database is in read only mode.

SunLight

class SunLight

Base class: Light

property id

The id of the light.

Type

str, read-only

property name

The name of the light.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property layer

The parent lighting layer of this light.

Type

LightingLayer, read-only

property group

The group of this light or None if the light is at the root of the hierarchy.

Type

LightGroup or None

Raises

ReadOnlyError -- If Database is in read only mode.

property enabled

The light enabled state.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property position

The light position in world.

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property rotation

The light rotation in world (in degrees).

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.

property color

The color of the light.

Type

ColorRgb

Raises

ReadOnlyError -- If Database is in read only mode.

property intensity

The light intensity.

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property cast_shadow

Whether the light casts shadows.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property shadow_intensity

The shadow intensity (the intensity of the light when in shadows).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative intensity.

property shadow_integrity

The shadow integrity.

Type

ShadowIntegrity

Raises

ReadOnlyError -- If Database is in read only mode.

property diameter

The diameter of the light (in meters).

Type

float

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- If trying to set a negative diameter.

remove()

Delete this light.

Raises

ReadOnlyError -- If Database is in read only mode.