unreal.InterchangeAnimationAPI

class unreal.InterchangeAnimationAPI(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: Object

UInterchangeAnimationAPI is used to store and retrieve animation data(i.e. DCC node attributes, pipelines will have access to those attributes)

C++ Source:

  • Module: InterchangeCore

  • File: InterchangeAnimationAPI.h

classmethod get_custom_is_node_transform_animated(interchange_base_node) → bool or None

Get true if the node transform have animation. Return false if the Attribute is not set.

Parameters:

interchange_base_node (InterchangeBaseNode) –

Returns:

attribute_value (bool):

Return type:

bool or None

classmethod get_custom_node_transform_animation_end_time(interchange_base_node) → double or None

Get the animation end time in second for this node transform. Return false if the Attribute is not set.

Parameters:

interchange_base_node (InterchangeBaseNode) –

Returns:

attribute_value (double):

Return type:

double or None

classmethod get_custom_node_transform_animation_key_count(interchange_base_node) → int32 or None

Get the node transform animation key count. Return false if the Attribute is not set.

Parameters:

interchange_base_node (InterchangeBaseNode) –

Returns:

attribute_value (int32):

Return type:

int32 or None

classmethod get_custom_node_transform_animation_start_time(interchange_base_node) → double or None

Get the animation start time in second for this node transform. Return false if the Attribute is not set.

Parameters:

interchange_base_node (InterchangeBaseNode) –

Returns:

attribute_value (double):

Return type:

double or None

classmethod get_custom_node_transform_payload_key(interchange_base_node) → str or None

Get the payload key needed to retrieve the animation from the source. Return false if the Attribute is not set.

Parameters:

interchange_base_node (InterchangeBaseNode) –

Returns:

attribute_value (str):

Return type:

str or None

classmethod set_custom_is_node_transform_animated(interchange_base_node, attribute_value) → bool

Set true if the node transform has animation.

Parameters:
Return type:

bool

classmethod set_custom_node_transform_animation_end_time(interchange_base_node, attribute_value) → bool

Set the animation end time in second for this node transform.

Parameters:
Return type:

bool

classmethod set_custom_node_transform_animation_key_count(interchange_base_node, attribute_value) → bool

Set the node transform animation key count.

Parameters:
Return type:

bool

classmethod set_custom_node_transform_animation_start_time(interchange_base_node, attribute_value) → bool

Set the animation start time in second for this node transform.

Parameters:
Return type:

bool

classmethod set_custom_node_transform_payload_key(interchange_base_node, attribute_value) → bool

Set the payload key needed to retrieve the animation from the source.

Parameters:
Return type:

bool