Animation

class Animation

property id

The id of the animation.

Type: str, read-only

property name

The name of the animation.

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

property type

The animation type.

Type: TimelineTrackType, read-only

AnimationCurve

class AnimationCurve

property id

The id of the animation curve.

Type: str, read-only

property color

The color of the animation curve.

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

property name

The name of the animation curve.

Type: str, read-only

property key_frame_data

The data of the curve in json.

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

list_key_frames()

Returns the list of AnimationKeyFrame.

Returns: The list of AnimationKeyFrame.
Return type: list(AnimationKeyFrame)

key_frame_from_id(id)

Returns a AnimationKeyFrame with the id.

Parameters: id (str) -- Id of the key frame.
Returns: The AnimationKeyFrame with the given id.
Return type: AnimationKeyFrame

insert_key_frame(time, value)

Add a AnimationKeyFrame to the curve at the given time with the given value.

Parameters

time (float) -- Time at which the key frame will be inserted.
value (float) -- The value of the key frame.

Returns

The newly inserted AnimationKeyFrame.

Return type

AnimationKeyFrame

Raises

ReadOnlyError -- If Database is in read only mode.

remove_key_frame(id)

Remove the AnimationKeyFrame with the given id.

Parameters: id (str) -- The id of the key frame to be removed.
Raises: ReadOnlyError -- If Database is in read only mode.

remove()

Delete this curve.

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

AnimationEasingType

class AnimationEasingType

LINEAR = 0: Linear.

EASING_IN = 1: Quad easing in.

EASING_OUT = 2: Quad easing out.

EASING_IN_OUT = 3: Quad easing in out.

AnimationKeyFrame

class AnimationKeyFrame

property id

The id of the key frame.

Type: str, read-only

property name

The name of the curve containing this keyframe.

Type: str, read-only

property value

The value of the key frame.

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

property time

The time of the key frame in seconds.

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

property right_tangent_type

The right tangent type.

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

property left_tangent_type

The left tangent type.

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

property right_tangent_value

The right tangent value.

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

property left_tangent_value

The left tangent value.

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

CameraAnimation

class CameraAnimation

Base class: Animation

property id

The id of the animation.

Type: str, read-only

property name

The name of the animation.

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

property type

The animation type.

Type: TimelineTrackType, read-only

remove()

Delete the camera animation.

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

CameraBezierPathAnimation

class CameraBezierPathAnimation

Base class: CameraAnimation

property duration

The duration of the animation.

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

property position_type

The position type of the animation.

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

property bezier_path_used_for_position

The Bezier path used for position.

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

property position_bezier_path_inverted

Whether the Bezier path used for position is inverted.

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

property position_null

The null used for position.

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

property position_fixed_from

The fixed position camera origin.

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

property position_fixed_to

The fixed position camera target.

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

property target_type

The target type of the animation.

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

property bezier_path_used_for_target

The Bezier path used for target.

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

property target_bezier_path_inverted

Whether the Bezier path used for target is inverted.

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

property target_null

The null used for target.

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

property target_fixed_direction

The fixed direction for the target.

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

property target_fixed_direction_up

The fixed direction up vector for the target.

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

property target_fixed

The fixed position for target.

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

remove()

Delete the camera animation.

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

duplicate()

Duplicate this camera Bezier path animation.

Returns: The duplicated camera Bezier path animation.
Return type: CameraBezierPathAnimation
Raises: ReadOnlyError -- If Database is in read only mode.

CameraBezierPathAnimationPositionType

class CameraBezierPathAnimationPositionType

FOLLOW_BEZIER_PATH = 0: Follow Bezier path.

FIXED = 1: Stationary.

FOLLOW_NULL = 2: Follow Null.

CameraBezierPathAnimationTargetType

class CameraBezierPathAnimationTargetType

FOLLOW_BEZIER_PATH = 0: Follow Bezier path.

FOLLOW_POSITION_PATH = 1: Follow the position path.

FIXED_DIRECTION = 2: Prevent modification of the camera orientation.

FIXED_POSITION = 3: Stationary.

FOLLOW_NULL = 4: Follow Null.

CameraBookmark

class CameraBookmark

property id

Id of the camera bookmark.

Type: str, read-only

property enabled

Whether the camera bookmark is included in the animation.

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

property name

The name of the camera bookmark.

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

property index

The index of the camera bookmark in the animation.

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

property sleep

The duration of the pause of the bookmarked image (in seconds).

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

property duration

The duration of the animated transition to the next bookmark (in seconds).

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

property smoothness

The fluidity of the camera behavior.

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

property path_type

The type of camera path.

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

property turn_duration

The percentage of the step dedicated to the rotation (in percentage).

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

property turn_count

The number of 360-degree turns to carry out.

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

duplicate()

Duplicate this camera bookmark.

Returns: The duplicated camera bookmark.
Return type: CameraBookmark
Raises: ReadOnlyError -- If Database is in read only mode.

remove()

Delete a camera bookmark.

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

CameraBookmarkAnimation

class CameraBookmarkAnimation

Base class: CameraAnimation

property duration

The global duration of the animation.

Type: float, read-only

property sleep_add_constant

The constant to add to each camera bookmark sleep value (in seconds).

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

property sleep_factor

The factor to multiply each camera bookmark sleep value.

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

property duration_add_constant

The constant to add to each camera bookmark duration value (in seconds).

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

property duration_factor

The factor to multiply each camera bookmark duration value.

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

property closed_path

Animate the transition between the last and the first bookmarks when the animation playback is looped.

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

remove()

Delete the camera animation.

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

list_camera_bookmarks()

List all the camera bookmarks in the animation.

Returns: The list of camera bookmarks in the animation.
Return type: list(CameraBookmark)

find_camera_bookmark_in_animation(id)

Find camera bookmark in the animation using id.

Parameters: id (str) -- Id of the camera bookmark to find.
Returns: The camera bookmark found.
Return type: CameraBookmark

add_new_camera_bookmark_to_animation(name)

Add a camera bookmark to the animation.

Parameters: name (str) -- Name for the new camera bookmark.
Returns: The newly added camera bookmark.
Return type: CameraBookmark
Raises: ReadOnlyError -- If Database is in read only mode.

remove_camera_bookmark_from_animation(bookmark)

Camera bookmark to remove from the animation.

Parameters: bookmark (CameraBookmark) -- Camera bookmark to remove.
Raises: ReadOnlyError -- If Database is in read only mode.

add_camera_from_camera_group_to_animation(group)

Add a camera bookmark to the animation.

Parameters: group (CameraGroup) -- Camera group containing camera to add to the animation.
Raises: ReadOnlyError -- If Database is in read only mode.

duplicate()

Duplicate this camera bookmark animation.

Returns: The duplicated camera bookmark animation.
Return type: CameraBookmarkAnimation
Raises: ReadOnlyError -- If Database is in read only mode.

CameraBookmarkPathType

class CameraBookmarkPathType

LINEAR = 0: Straight path.

JUMP = 1: Moves from one stage to the next with no transition.

ORBIT = 2: Circular path.

HEAD = 3: Pivots the camera.

SPLINE = 4: Smooths the transitions when the camera moves from bookmark to bookmark.

ChannelsAnimation

class ChannelsAnimation

Base class: Animation

property id

The id of the animation.

Type: str, read-only

property name

The name of the animation.

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

property type

The animation type.

Type: TimelineTrackType, read-only

list_available_channels(object)

List all channels that can be animated for the SceneObject

Note

only SceneObject of type Axis, Null and Vector can be animated, object of other types will return an empty list.

Parameters: object (SceneObject) -- Object for which the list of channels that can animated will be returned.
Returns: The list all paths to channels that can animated for the object.
Return type: list(str)

animated_channels_for(id)

Add a Vector animation of the channel.

Parameters: id (str) -- Id for the object to get the list of animated paths.
Returns: The list of animated channel path, the list is empty if the given object is not animated by this animation.
Return type: list(str)

remove()

Delete the channels animation.

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

ChannelsCurveAnimation

class ChannelsCurveAnimation

Base class: ChannelsAnimation

property duration

The duration of the animation.

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

list_available_channels(object)

List all channels that can be animated for the SceneObject

Note

only SceneObject of type Axis, Null and Vector can be animated, object of other types will return an empty list.

Parameters: object (SceneObject) -- Object for which the list of channels that can animated will be returned.
Returns: The list all paths to channels that can animated for the object.
Return type: list(str)

animated_channels_for(id)

Add a Vector animation of the channel.

Parameters: id (str) -- Id for the object to get the list of animated paths.
Returns: The list of animated channel path, the list is empty if the given object is not animated by this animation.
Return type: list(str)

remove()

Delete the channels animation.

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

list_curves()

Returns the list of curves for this animation.

Returns: The list of Curve contained in this animation.
Return type: list(AnimationCurve)

add_axis_channel_animation(object)

Add a Axis animation of the channel.

Parameters: object (Axis) -- Axis object to animate.
Returns: The created Curve for this channel animation.
Return type: AnimationCurve
Raises: ReadOnlyError -- If Database is in read only mode.

add_null_channel_animation(object, channel)

Add a Null animation of the channel.

Parameters

object (Null) -- Null object to animate.
channel (str) -- Path to the channel to animate, separated with '/'.

Returns

The created Curve for this channel animation.

Return type

AnimationCurve

Raises

ReadOnlyError -- If Database is in read only mode.

add_vector_channel_animation(object)

Add a Vector animation of the channel.

Parameters: object (Vector) -- Vector object to animate.
Returns: The created Curve for this channel animation.
Return type: AnimationCurve
Raises: ReadOnlyError -- If Database is in read only mode.

duplicate()

Duplicate this channels animation.

Returns: The duplicated channels animation.
Return type: ChannelsCurveAnimation
Raises: ReadOnlyError -- If Database is in read only mode.

ChannelsSimpleAnimation

class ChannelsSimpleAnimation

Base class: ChannelsAnimation

property duration

The duration of the animation.

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

property initial_value

The initial value of the animation.

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

property final_value

The final value of the animation.

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

property easing

The easing of the animation.

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

list_available_channels(object)

List all channels that can be animated for the SceneObject

Note

only SceneObject of type Axis, Null and Vector can be animated, object of other types will return an empty list.

Parameters: object (SceneObject) -- Object for which the list of channels that can animated will be returned.
Returns: The list all paths to channels that can animated for the object.
Return type: list(str)

animated_channels_for(id)

Add a Vector animation of the channel.

Parameters: id (str) -- Id for the object to get the list of animated paths.
Returns: The list of animated channel path, the list is empty if the given object is not animated by this animation.
Return type: list(str)

remove()

Delete the channels animation.

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

set_axis_channel_animation(object, start, end)

Set a Axis animation of the channel.

Parameters

object (Axis) -- Axis object to animate.
start (float) -- Initial value for channel animation.
end (float) -- Final value for channel animation.

Raises

ReadOnlyError -- If Database is in read only mode.

set_null_channel_animation(object, channel, start, end)

Set a Null animation of the channel.

Parameters

object (Null) -- Null object to animate.
channel (str) -- Path to the channel to animate, separated with '/'.
start (float) -- Initial value for channel animation.
end (float) -- Final value for channel animation.

Raises

ReadOnlyError -- If Database is in read only mode.

set_vector_channel_animation(object, start, end)

Set a Vector animation of the channel.

Parameters

object (Vector) -- Vector object to animate.
start (float) -- Initial value for channel animation.
end (float) -- Final value for channel animation.

Raises

ReadOnlyError -- If Database is in read only mode.

duplicate()

Duplicate this channels animation.

Returns: The duplicated channels animation.
Return type: ChannelsSimpleAnimation
Raises: ReadOnlyError -- If Database is in read only mode.

ConfigurationKeyAnimation

class ConfigurationKeyAnimation

Base class: Animation

property id

The id of the animation.

Type: str, read-only

property name

The name of the animation.

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

property type

The animation type.

Type: TimelineTrackType, read-only

list_symbols()

List of symbols defined for this configuration key animation.

Returns: The list of symbols defined for this configuration key animation.
Return type: list(str)

list_values()

List of values defined for this configuration key animation, if the parameter is a check box there is no available values.

Returns: The list of values defined for this configuration key animation or an empty list if the parameter is a check box.
Return type: list(str)

set_configuration_symbol(label, value)

Set value for the symbol for this animation.

Parameters

label (str) -- The label of the symbol to be used in the animation.
value (str) -- The value of the symbol.

Raises

ReadOnlyError -- If Database is in read only mode.

set_check_box_configuration_symbol(label, value)

Set value for the symbol for this animation.

Parameters

label (str) -- The label of the symbol to be used in the animation.
value (bool) -- The value of the symbol.

Raises

ReadOnlyError -- If Database is in read only mode.

keep_previous_value(label)

Keep previous value for the symbol with the label label for this animation.

Parameters: label (str) -- The label of the symbol to be modified in the animation.
Raises: ReadOnlyError -- If Database is in read only mode.

initialize_from_configuration_preset(preset)

Initialize the configuration for this animation using the preset.

Parameters: preset (ConfigurationPreset) -- The configuration preset from which the animation configuration will be initialized.
Raises: ReadOnlyError -- If Database is in read only mode.

duplicate()

Duplicate this configuration key animation.

Returns: The duplicated configuration key animation.
Return type: ConfigurationKeyAnimation
Raises: ReadOnlyError -- If Database is in read only mode.

remove()

Delete the configuration key animation.

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

KeyFrameTangentType

class KeyFrameTangentType

BEZIER = 0: Bezier Path.

LINEAR = 1: Linear.

STEP = 2: Step.

ProductKeyAnimation

class ProductKeyAnimation

Base class: Animation

property id

The id of the animation.

Type: str, read-only

property name

The name of the animation.

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

property type

The animation type.

Type: TimelineTrackType, read-only

SurfaceBakedAnimation

class SurfaceBakedAnimation

Base class: ChannelsAnimation

property duration

The duration of the animation.

Type: float, read-only

list_available_channels(object)

List all channels that can be animated for the SceneObject

Note

only SceneObject of type Axis, Null and Vector can be animated, object of other types will return an empty list.

Parameters: object (SceneObject) -- Object for which the list of channels that can animated will be returned.
Returns: The list all paths to channels that can animated for the object.
Return type: list(str)

animated_channels_for(id)

Add a Vector animation of the channel.

Parameters: id (str) -- Id for the object to get the list of animated paths.
Returns: The list of animated channel path, the list is empty if the given object is not animated by this animation.
Return type: list(str)

remove()

Delete the channels animation.

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

duplicate()

Duplicate this channels animation.

Returns: The duplicated channels animation.
Return type: SurfaceBakedAnimation
Raises: ReadOnlyError -- If Database is in read only mode.

TextureAnimation

class TextureAnimation

Base class: Animation

property id

The id of the animation.

Type: str, read-only

property name

The name of the animation.

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

property type

The animation type.

Type: TimelineTrackType, read-only

property duration

The duration of the animation.

Type: float, read-only