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: str, read-only

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

ReadOnlyError -- If Database is in read only mode.
ValueError -- If trying to set a negative width or a width equal to 0.

property height

The sensor height in millimeters.

Type

float

Raises

ReadOnlyError -- If Database is in read only mode.
ValueError -- If trying to set a negative height or a height equal to 0.

property aspect

The sensor aspect ratio.

Type

float

Raises

ReadOnlyError -- If Database is in read only mode.
ValueError -- If trying to set a negative ratio or a ratio equal to 0.

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: Postprocess or None
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: Overlay or None
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: Background or None
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

InUseError -- If force is False and the sensor is used.
ReadOnlyError -- If Database is in read only mode.