PositionLayer

class PositionLayer

property id

The id of the layer.

Type: str, read-only

property name

The name of the layer.

Type: str
Raises: ReadOnlyError -- If Database is in read only mode.

property visible

The layer visibility.

Type: bool
Raises: ReadOnlyError -- If Database is in read only mode.

property index

The index of this layer in the layer list.

Type: int
Raises: ReadOnlyError -- If Database is in read only mode.

property configured

If the layer is used in configuration or not.

Type: bool, read-only

is_active()

Whether the position layer is active or not.

Returns: The position layer's active state.
Return type: bool

set_active_layer()

Set this position layer as active layer.

Raises: ReadOnlyError -- If Database is in read only mode.

duplicate()

Duplicate this position layer.

Returns: The duplicated layer.
Return type: PositionLayer
Raises: ReadOnlyError -- If Database is in read only mode.

remove(remove_configuration=True)

Delete this position layer.

Parameters

remove_configuration (bool) -- If True, delete the configuration rule for this position layer.

Raises

ReadOnlyError -- If Database is in read only mode.
ValueError -- Cannot be removed if the position layer is the base layer.

has_scene_object_position(object)

Returns whether the SceneObject's position is in the current PositionLayer.

Parameters: object (SceneObject) -- Object in the PositionLayer.
Returns: Whether the SceneObject's position is in the current PositionLayer.
Return type: bool

remove_scene_object_position_from_layer(object)

Remove the SceneObject's position from the current PositionLayer.

Parameters: object (SceneObject) -- Scene Object which position is to be removed from the PositionLayer.
Raises: ReadOnlyError -- If Database is in read only mode.

set_scene_object_translation(object, translation)

Save the SceneObject's translation into the current PositionLayer.

Parameters

object (SceneObject) -- Scene Object to be in the PositionLayer.
translation (Vector3) -- Translation for the object to be in the PositionLayer.

Raises

ReadOnlyError -- If Database is in read only mode.

scene_object_translation(object)

Returns the SceneObject translation in the current PositionLayer.

Parameters: object (SceneObject) -- SceneObject in the PositionLayer.
Returns: The object translation in the current PositionLayer.
Return type: Vector3
Raises: ValueError -- If the position layer is not applied to this object.

set_scene_object_rotation(object, rotation)

Save the SceneObject's rotation into the current PositionLayer, in degrees.

Parameters

object (SceneObject) -- SceneObject to be in the PositionLayer.
rotation (Vector3) -- Rotation for the object to be in the PositionLayer.

Raises

ReadOnlyError -- If Database is in read only mode.

scene_object_rotation(object)

Returns the SceneObject rotation in the current PositionLayer, in degrees.

Parameters: object (SceneObject) -- SceneObject in the PositionLayer.
Returns: The object srotation in the current PositionLayer.
Return type: Vector3
Raises: ValueError -- If the position layer is not applied to this object.

set_scene_object_scale(object, scale)

Save the SceneObject's scale into the current PositionLayer.

Parameters

object (SceneObject) -- SceneObject to be in the PositionLayer.
scale (Vector3) -- Scale for the object to be in the PositionLayer.

Raises

ReadOnlyError -- If Database is in read only mode.
ValueError -- If the object is a kinematics object.

scene_object_scale(object)

Returns the SceneObject scale in the current PositionLayer.

Parameters: object (SceneObject) -- SceneObject in the PositionLayer.
Returns: The object scale in the current PositionLayer.
Return type: Vector3
Raises: ValueError -- If the position layer is not applied to this object.