# Sensor¶

class BackgroundMode
NONE = 0

No backround.

GRADIENT = 1

Use the specified background.

ENVIRONMENT = 2

Use the environment as background.

## Sensor¶

class Sensor
property id

The id of the sensor.

Type

property name

The name of the sensor.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property group

The group of the sensor.

Type

SensorGroup

Raises

ReadOnlyError -- If Database is in read only mode.

property isometric

Wether the sensor uses isometric projection.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property width

The sensor width in millimeters.

Type

float

Raises
property height

The sensor height in millimeters.

Type

float

Raises
property aspect

The sensor aspect ratio.

Type

float

Raises
property dynamic_aspect

Wether the aspect ratio is dynamic (i.e. it corresponds to the viewport aspect ratio).

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property postprocess

The postprocess of the sensor or None if there is no postprocess assigned.

Type
Raises

ReadOnlyError -- If Database is in read only mode.

property overlay

The overlay of the sensor or None if there is no overlay assigned.

Type
Raises

ReadOnlyError -- If Database is in read only mode.

property background_mode

The background mode of the sensor.

Type

BackgroundMode

Raises

ReadOnlyError -- If Database is in read only mode.

property background

The background of the sensor or None if there is no background assigned. It only has effect if backgroundMode is GRADIENT.

Type
Raises

ReadOnlyError -- If Database is in read only mode.

duplicate()

Duplicate this sensor.

Returns

The duplicated sensor.

Return type

Sensor

Raises

ReadOnlyError -- If Database is in read only mode.

remove(force = False)

Delete this sensor

Note

By default, only not used sensor can be deleted (InUseError is raised otherwise), use force to force deletion of used sensors.

Parameters

force (bool) -- Force the deletion of the sensor even if it is in use.

Raises