unreal.AnimDatabaseFrameAttributeLibrary

class unreal.AnimDatabaseFrameAttributeLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Anim Database Frame Attribute Library

C++ Source:

  • Plugin: AnimDatabase

  • Module: AnimDatabase

  • File: AnimDatabaseFrameAttribute.h

classmethod attribute_type_name(type) → str

Gets the name for a given type

Parameters:

type (AnimDatabaseAttributeType)

Return type:

str

classmethod attribute_type_size(type) → int32

Gets the size (number of channels in the FrameAttribute) for a given type

Parameters:

type (AnimDatabaseAttributeType)

Return type:

int32

classmethod find_frame_attribute_maximum(frame_attribute) -> (out_sequence_idx=int32, out_sequence_frame=int32, out_maximum_value=float)

Find the sequence and sequence frame with the largest value in a float frame attribute

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_sequence_idx (int32):

out_sequence_frame (int32):

out_maximum_value (float):

Return type:

tuple

classmethod find_frame_attribute_minimum(frame_attribute) -> (out_sequence_idx=int32, out_sequence_frame=int32, out_minimum_value=float)

Find the sequence and sequence frame with the smallest value in a float frame attribute

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_sequence_idx (int32):

out_sequence_frame (int32):

out_minimum_value (float):

Return type:

tuple

classmethod find_frame_attribute_minimum_sequence(frame_attribute, database) -> (out_anim_sequence=AnimSequence, out_anim_sequence_time=float, out_anim_sequence_mirrored=bool, out_minimum_value=float)

Find the sequence with the smallest value in a float frame attribute

Parameters:
Returns:

out_anim_sequence (AnimSequence):

out_anim_sequence_time (float):

out_anim_sequence_mirrored (bool):

out_minimum_value (float):

Return type:

tuple

classmethod frame_attribute_abs(a) → AnimDatabaseFrameAttribute

Takes the absolute value of a frame attribute. Assumes operation is valid on the input type

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_add(a, b) → AnimDatabaseFrameAttribute

Adds two frame attributes. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_add_angle_degrees(a, b) → AnimDatabaseFrameAttribute

Adds a constant angle value in degrees to an angle frame attribute.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_add_angle_radians(a, b) → AnimDatabaseFrameAttribute

Adds a constant angle value in radians to an angle frame attribute.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_add_float(a, b) → AnimDatabaseFrameAttribute

Adds a constant float value to a frame attribute. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_add_vector(a, b) → AnimDatabaseFrameAttribute

Adds a constant vector value to a frame attribute. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_and(a, b) → AnimDatabaseFrameAttribute

Computes the logical and of two bool frame attributes

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_angle_at_frame_degrees(frame_attribute, sequence_idx, frame_idx) → float or None

Sample the given FrameAttribute at the provide Sequence and Frame as an angle in degrees. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_value (float):

Return type:

float or None

classmethod frame_attribute_angle_at_frame_radians(frame_attribute, sequence_idx, frame_idx) → float or None

Sample the given FrameAttribute at the provide Sequence and Frame as an angle in radians. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_value (float):

Return type:

float or None

classmethod frame_attribute_angle_average_degrees(angle_frame_attribute) → float

Computes the average of an angle frame attribute in degrees

Parameters:

angle_frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_average_angle (float):

Return type:

float

classmethod frame_attribute_angle_average_radians(angle_frame_attribute) → float

Computes the average of an angle frame attribute in radians

Parameters:

angle_frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_average_angle (float):

Return type:

float

classmethod frame_attribute_angle_min_and_max_degrees(angle_frame_attribute) -> (out_min=float, out_max=float)

Computes the min and max of an angle frame attribute in degrees

Parameters:

angle_frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_min (float):

out_max (float):

Return type:

tuple

classmethod frame_attribute_angle_min_and_max_radians(angle_frame_attribute) -> (out_min=float, out_max=float)

Computes the min and max of an angle frame attribute in radians

Parameters:

angle_frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_min (float):

out_max (float):

Return type:

tuple

classmethod frame_attribute_angle_to_float_degrees(angle_frame_attribute) → AnimDatabaseFrameAttribute

Converts an angle frame attribute to a float frame attribute in degrees

Parameters:

angle_frame_attribute (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_angle_to_float_radians(angle_frame_attribute) → AnimDatabaseFrameAttribute

Converts an angle frame attribute to a float frame attribute in radians

Parameters:

angle_frame_attribute (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_angular_velocity_at_frame(frame_attribute, sequence_idx, frame_idx) → Vector or None

Sample the given FrameAttribute at the provide Sequence and Frame as an angular velocity. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_angular_velocity (Vector):

Return type:

Vector or None

classmethod frame_attribute_anim_sequences(database, frame_attribute) → Array[AnimSequence]

Gets the Frame Ranges associated with a given Frame Attribute

Parameters:
Returns:

out_anim_sequences (Array[AnimSequence]):

Return type:

Array[AnimSequence]

classmethod frame_attribute_apply_transform_direction(a, b) → AnimDatabaseFrameAttribute

Applies a transformation to a constant direction vector. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_apply_transform_location(a, b) → AnimDatabaseFrameAttribute

Applies a transformation to a constant location vector. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_atan2(y, x) → AnimDatabaseFrameAttribute

Computes the atan2 value of two frame attributes. Assumes inputs are Float attributes. Output is an Angle attribute.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_average_std(frame_attribute) → float

Computes the average of the std across all channels of a frame attribute

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Return type:

float

classmethod frame_attribute_bone_speed(database, frame_ranges, bone_name='foot_l') → AnimDatabaseFrameAttribute

Computes a float attribute representing the global speed of a given joint.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_bool_at_frame(frame_attribute, sequence_idx, frame_idx) → bool or None

Sample the given FrameAttribute at the provide Sequence and Frame as a bool. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_bool (bool):

Return type:

bool or None

classmethod frame_attribute_bool_to_float(bool_frame_attribute) → AnimDatabaseFrameAttribute

Converts a bool frame attribute to a float frame attribute

Parameters:

bool_frame_attribute (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_bool_to_frame_ranges(bool_frame_attribute) → AnimDatabaseFrameRanges

Converts a Bool frame attribute into frame ranges

Parameters:

bool_frame_attribute (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameRanges

classmethod frame_attribute_contact_curve(database, frame_ranges, bone_name='ball_l', height_threshold=20.000000, velocity_threshold=25.000000, filter_curve=True, majority_vote_filter_width=5, smooth_curve=True, smoothing_amount=3.000000) → AnimDatabaseFrameAttribute

Computes a float attribute representing a contact state for the given joint.

Parameters:

  • database (AnimDatabase) – Database to use

  • frame_ranges (AnimDatabaseFrameRanges) – Ranges in the database to use

  • bone_name (Name) – Name of the bone to compute the contact state for

  • height_threshold (float) – Maximum height (in cm) for which the bone can be considered in contact

  • velocity_threshold (float) – Maximum velocity (in cm/s) for which the bone can be considered in contact

  • filter_curve (bool) – If to apply the majority vote filter to the curve

  • majority_vote_filter_width (int32) – Filter width (in frames) for the majority vote filter used to remove very short contact transitions. contact periods (or non-contact periods) less than half this duration will be removed.

  • smooth_curve (bool) – If to apply the smoothing filter to the curve

  • smoothing_amount (float) – Amount of smoothing to apply to the resulting contact curve (in frames)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_contact_frames(database, frame_ranges, bone_name='ball_l', height_threshold=20.000000, velocity_threshold=25.000000, filter_curve=True, majority_vote_filter_width=5, frame_offset=0.000000, ignore_first_frame=True) → AnimDatabaseFrames

Computes a frames object representing the contact down times for the given joint.

Parameters:

  • database (AnimDatabase) – Database to use

  • frame_ranges (AnimDatabaseFrameRanges) – Ranges in the database to use

  • bone_name (Name) – Name of the bone to compute the contact state for

  • height_threshold (float) – Maximum height (in cm) for which the bone can be considered in contact

  • velocity_threshold (float) – Maximum velocity (in cm/s) for which the bone can be considered in contact

  • filter_curve (bool) – If to apply the majority vote filter to the curve

  • majority_vote_filter_width (int32) – Filter width (in frames) for the majority vote filter used to remove very short contact transitions. contact periods (or non-contact periods) less than half this duration will be removed.

  • frame_offset (float) – The amount of time before the contact (in seconds) to have the frame

  • ignore_first_frame (bool) – Removes contact frames that occur on the first frame of the frame ranges

Return type:

AnimDatabaseFrames

classmethod frame_attribute_contact_ranges(database, frame_ranges, bone_name='ball_l', height_threshold=20.000000, velocity_threshold=25.000000, filter_curve=True, majority_vote_filter_width=5) → AnimDatabaseFrameRanges

Computes a frame ranges object representing the contact down times for the given joint.

Parameters:

  • database (AnimDatabase) – Database to use

  • frame_ranges (AnimDatabaseFrameRanges) – Ranges in the database to use

  • bone_name (Name) – Name of the bone to compute the contact state for

  • height_threshold (float) – Maximum height (in cm) for which the bone can be considered in contact

  • velocity_threshold (float) – Maximum velocity (in cm/s) for which the bone can be considered in contact

  • filter_curve (bool) – If to apply the majority vote filter to the curve

  • majority_vote_filter_width (int32) – Filter width (in frames) for the majority vote filter used to remove very short contact transitions. contact periods (or non-contact periods) less than half this duration will be removed.

Return type:

AnimDatabaseFrameRanges

classmethod frame_attribute_copy(a) → AnimDatabaseFrameAttribute

Copies a frame attribute.

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_cos(a) → AnimDatabaseFrameAttribute

Takes the cos value of a frame attribute. Assumes input is an Angle attribute.

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_cross(a, b) → AnimDatabaseFrameAttribute

Computes the cross product of two frame attributes. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_direction_at_frame(frame_attribute, sequence_idx, frame_idx) → Vector or None

Sample the given FrameAttribute at the provide Sequence and Frame as a direction. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_direction (Vector):

Return type:

Vector or None

classmethod frame_attribute_direction_average(direction_frame_attribute) → Vector

Computes the average of a direction frame attribute

Parameters:

direction_frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_average_direction (Vector):

Return type:

Vector

classmethod frame_attribute_direction_matching_distance(direction_frame_attribute, direction, weight=1.000000) → AnimDatabaseFrameAttribute

Computes a float frame attribute representing the matching distance between some direction frame attribute and a constant direction value.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_direction_to_location(direction_frame_attribute) → AnimDatabaseFrameAttribute

Converts a direction frame attribute to a location frame attribute

Parameters:

direction_frame_attribute (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_directions_at_frame(frame_attributes, sequence_idx, frame_idx) → Array[Vector] or None

Sample the given FrameAttributes at the provide Sequence and Frame as an array of directions. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_directions (Array[Vector]):

Return type:

Array[Vector] or None

classmethod frame_attribute_divide(a, b) → AnimDatabaseFrameAttribute

Divides two frame attributes. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_divide_float(a, b) → AnimDatabaseFrameAttribute

Divides a frame attribute by a constant float value. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_divide_quat(a, b) → AnimDatabaseFrameAttribute

Divides a frame attribute by a constant quat value. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_divide_transform(a, b) → AnimDatabaseFrameAttribute

Divides a frame attribute by a constant transform value. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_divide_vector(a, b) → AnimDatabaseFrameAttribute

Divides a frame attribute by a constant vector value. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_dot(a, b) → AnimDatabaseFrameAttribute

Computes the dot product of two frame attributes. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_dynamic_weighted_sum(frame_attributes, weights) → AnimDatabaseFrameAttribute

Computes the weighted sum of multiple frame attributes where the weights are dynamic. Assumes all are the same type

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_equal(a, b) → AnimDatabaseFrameAttribute

Returns a bool frame attribute describing if two frame attributes are numerically equal on each frame

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_equal_transform(transform_frame_attribute, transform) → AnimDatabaseFrameAttribute

Returns a bool frame attribute describing if the given transform attribute is equal to the provided transform on each frame

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_event_at_frame(frame_attribute, sequence_idx, frame_idx) → (out_time_until_event_known=bool, out_time_until_event=float) or None

Sample the given FrameAttribute at the provide Sequence and Frame as an event. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_time_until_event_known (bool):

out_time_until_event (float):

Return type:

tuple or None

classmethod frame_attribute_event_matching_distance(event_frame_attribute, time_until_event_known, time_until_event, weight=1.000000) → AnimDatabaseFrameAttribute

Computes a float frame attribute representing the matching distance between some event frame attribute and a constant event value.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_exp(a) → AnimDatabaseFrameAttribute

Takes the exp value of a frame attribute. Assumes operation is valid on the input type

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_extract_phase(frame_ranges, zero_phase_frames, half_phase_frames, extrapolation_mode=AnimDatabasePhaseExtrapolationMode.REPEAT) → AnimDatabaseFrameAttribute

Extracts a phase angle from two sets of frames representing the start of the phase and half way through the phase

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_filter_gaussian(float_frame_attribute, standard_deviation_in_frames=3.000000) → AnimDatabaseFrameAttribute

Applies a Gaussian smoothing filter to the values in each range of a frame attribute. Assumes type is compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_filter_majority_vote(bool_frame_attribute, filter_width_in_frames=5) → AnimDatabaseFrameAttribute

Applies a majority vote filter to the values in each range of a frame attribute. Assumes type is compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_filter_sav_gol(float_frame_attribute, filter_width_in_frames=7, polynomial_degree=3, gaussian_windowed=True) → AnimDatabaseFrameAttribute

Applies a SavGol filter to the values in each range of a frame attribute. Assumes type is compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_fit_transform(database, frame_ranges, fit_locations, fit_forward_directions, fit_right_directions, fit_up_directions, fit_location_weights, fit_forward_direction_weights, fit_right_direction_weights, fit_up_direction_weights) → AnimDatabaseFrameAttribute

Fits a transform from the given location and direction attributes

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_float_at_frame(frame_attribute, sequence_idx, frame_idx) → float or None

Sample the given FrameAttribute at the provide Sequence and Frame as a float. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_value (float):

Return type:

float or None

classmethod frame_attribute_float_average(float_frame_attribute) → float

Computes the average of a float frame attribute

Parameters:

float_frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_average_float (float):

Return type:

float

classmethod frame_attribute_float_min_and_max(float_frame_attribute) -> (out_min=float, out_max=float)

Computes the min and max of a float frame attribute

Parameters:

float_frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_min (float):

out_max (float):

Return type:

tuple

classmethod frame_attribute_float_to_angle_degrees(float_frame_attribute) → AnimDatabaseFrameAttribute

Converts a float frame attribute to an angle frame attribute in degrees

Parameters:

float_frame_attribute (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_float_to_angle_radians(float_frame_attribute) → AnimDatabaseFrameAttribute

Converts a float frame attribute to an angle frame attribute in radians

Parameters:

float_frame_attribute (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_float_to_bool(float_frame_attribute) → AnimDatabaseFrameAttribute

Converts a float frame attribute to a bool frame attribute

Parameters:

float_frame_attribute (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_frame_ranges(frame_attribute) → AnimDatabaseFrameRanges

Gets the Frame Ranges associated with a given Frame Attribute

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameRanges

classmethod frame_attribute_frame_ranges_equal(a, b) → bool

Checks if the frame ranges associated with two frame attributes are equal

Parameters:
Return type:

bool

classmethod frame_attribute_frame_ranges_to_bool(active_frame_ranges, frame_ranges) → AnimDatabaseFrameAttribute

Converts frame ranges to a Bool frame attribute

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_from_rotation_vector(a) → AnimDatabaseFrameAttribute

Converts an angular velocity frame attribute into a rotation frame attribute.

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_gaussian_smoothed_root_transform(database, frame_ranges, root_location_projection_bone_name='spine_02', root_rotation_projection_bone_name='pelvis', root_rotation_bone_forward_direction=[0.000000, 1.000000, 0.000000], root_forward_direction=[0.000000, 1.000000, 0.000000], location_smoothing_amount=9.000000, rotation_smoothing_amount=15.000000) → AnimDatabaseFrameAttribute

Computes a root transform by projecting bones onto the ground plane and smoothing the resulting location and direction with a Gaussian filter.

Parameters:

  • database (AnimDatabase) – Database to use

  • frame_ranges (AnimDatabaseFrameRanges) – Ranges in the database to use

  • root_location_projection_bone_name (Name) – Name of the bone to project onto the ground plane and use as the root location

  • root_rotation_projection_bone_name (Name) – Name of the bone to project onto the ground plane and use as the root rotation

  • root_rotation_bone_forward_direction (Vector) – Local forward direction of the bone to use as the root rotation

  • root_forward_direction (Vector) – Local forward direction of the desired root transform

  • location_smoothing_amount (float) – Amount of smoothing to apply to the root location projection (in frames)

  • rotation_smoothing_amount (float) – Amount of smoothing to apply to the root rotation projection (in frames)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_greater_than_angle_degrees(angle_frame_attribute, threshold) → AnimDatabaseFrameAttribute

Compares if a angle frame attribute is greater than the given threshold in degrees and returns a bool frame attribute

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_greater_than_angle_radians(angle_frame_attribute, threshold) → AnimDatabaseFrameAttribute

Compares if a angle frame attribute is greater than the given threshold in radians and returns a bool frame attribute

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_greater_than_float(float_frame_attribute, threshold) → AnimDatabaseFrameAttribute

Compares if a float frame attribute is greater than the given threshold and returns a bool frame attribute

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_inertialization_matching_distance(location_frame_attribute, linear_velocity_frame_attribute, location, velocity, blend_time=0.200000, location_scale=100.000000, velocity_scale=200.000000, location_weight=1.000000, velocity_weight=1.000000) → AnimDatabaseFrameAttribute

Computes a float frame attribute representing the matching distance between some location and linear velocity frame attributes and a constant location and velocity. Computes this distance using a combination of the maximum velocity offset that would be produced by inertialization, and the integral of the offset displacement produced from inertialization.

In general this provides a “nicer” distance metric than just comparing locations and velocities independently because it accounts for the fact that some velocity offsets can actually better correct location offsets during inertialization.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_intersection(frame_attribute, frame_ranges) → AnimDatabaseFrameAttribute

Returns the intersection of a frame attribute and some range set.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_inverse_multiply(a, b) → AnimDatabaseFrameAttribute

Computes inv(A) x B for two frame attributes. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_invert(a) → AnimDatabaseFrameAttribute

Inverts a frame attribute. Assumes types can be inverted. For float attributes this computes 1/A

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_length(a) → AnimDatabaseFrameAttribute

Computes the vector length of a frame attribute. Assumes type has a meaningful length

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_less_than_angle_degrees(angle_frame_attribute, threshold) → AnimDatabaseFrameAttribute

Compares if a angle frame attribute is less than the given threshold in degrees and returns a bool frame attribute

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_less_than_angle_radians(angle_frame_attribute, threshold) → AnimDatabaseFrameAttribute

Compares if a angle frame attribute is less than the given threshold in radians and returns a bool frame attribute

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_less_than_float(float_frame_attribute, threshold) → AnimDatabaseFrameAttribute

Compares if a float frame attribute is less than the given threshold and returns a bool frame attribute

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_linear_velocities_at_frame(frame_attributes, sequence_idx, frame_idx) → Array[Vector] or None

Sample the given FrameAttributes at the provide Sequence and Frame as an array of linear velocities. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_linear_velocities (Array[Vector]):

Return type:

Array[Vector] or None

classmethod frame_attribute_linear_velocity_at_frame(frame_attribute, sequence_idx, frame_idx) → Vector or None

Sample the given FrameAttribute at the provide Sequence and Frame as a linear velocity. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_linear_velocity (Vector):

Return type:

Vector or None

classmethod frame_attribute_location_at_frame(frame_attribute, sequence_idx, frame_idx) → Vector or None

Sample the given FrameAttribute at the provide Sequence and Frame as a location. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_location (Vector):

Return type:

Vector or None

classmethod frame_attribute_location_average(location_frame_attribute) → Vector

Computes the average of a location frame attribute

Parameters:

location_frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_average_location (Vector):

Return type:

Vector

classmethod frame_attribute_location_distance_traveled(location_frame_attribute) -> (out_mean=float, out_std=float, out_min=float, out_max=float)

Computes the mean, std, min, and max distance traveled across each range in a location frame attribute

Parameters:

location_frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_mean (float):

out_std (float):

out_min (float):

out_max (float):

Return type:

tuple

classmethod frame_attribute_location_matching_distance(location_frame_attribute, location, scale=100.000000, weight=1.000000) → AnimDatabaseFrameAttribute

Computes a float frame attribute representing the matching distance between some location frame attribute and a constant location value.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_location_mean_and_std(location_frame_attribute) -> (out_mean=Vector, out_std=Vector)

Computes the mean and std of a location frame attribute

Parameters:

location_frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_mean (Vector):

out_std (Vector):

Return type:

tuple

classmethod frame_attribute_location_to_direction(location_frame_attribute) → AnimDatabaseFrameAttribute

Converts a location frame attribute to a direction frame attribute (normalizing the result)

Parameters:

location_frame_attribute (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_locations_at_frame(frame_attributes, sequence_idx, frame_idx) → Array[Vector] or None

Sample the given FrameAttributes at the provide Sequence and Frame as an array of locations. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_locations (Array[Vector]):

Return type:

Array[Vector] or None

classmethod frame_attribute_log(a) → AnimDatabaseFrameAttribute

Takes the log value of a frame attribute. Assumes operation is valid on the input type

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_max(a, b) → AnimDatabaseFrameAttribute

Computes the component-wise maximum of two frame attributes. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_max_float(a, b) → AnimDatabaseFrameAttribute

Computes the component-wise maximum of a frame attribute and a float value. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_min(a, b) → AnimDatabaseFrameAttribute

Computes the component-wise minimum of two frame attributes. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_min_float(a, b) → AnimDatabaseFrameAttribute

Computes the component-wise minimum of a frame attribute and a float value. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_multiply(a, b) → AnimDatabaseFrameAttribute

Multiplies two frame attributes. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_multiply_float(a, b) → AnimDatabaseFrameAttribute

Multiplies a frame attribute by a constant float value. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_multiply_inverse(a, b) → AnimDatabaseFrameAttribute

Computes A x inv(B) for two frame attributes. This is the same as division. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_multiply_quat(a, b) → AnimDatabaseFrameAttribute

Multiplies a frame attribute by a constant quat value. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_multiply_transform(a, b) → AnimDatabaseFrameAttribute

Multiplies a frame attribute by a constant transform value. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_multiply_vector(a, b) → AnimDatabaseFrameAttribute

Multiplies a frame attribute by a constant vector value. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_negate(a) → AnimDatabaseFrameAttribute

Negates a frame attribute. Assumes types can be negated

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_not(a) → AnimDatabaseFrameAttribute

Computes the logical not of a bool frame attribute

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_or(a, b) → AnimDatabaseFrameAttribute

Computes the logical or of two bool frame attributes

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_outlier_frame_ranges(database, frame_ranges, padding=60, threshold=10.000000, location_minimum_difference=5.000000, rotation_minimum_difference=5.000000, scale_minimum_difference=0.100000, linear_velocity_minimum_difference=10.000000, angular_velocity_minimum_difference=10.000000, scalar_velocity_minimum_difference=0.200000) → AnimDatabaseFrameRanges

Computes frame ranges across the given set of range CheckFrameRanges which may contain outliers or glitches in the character pose.

Parameters:

  • database (AnimDatabase) – Database to check for outliers in

  • frame_ranges (AnimDatabaseFrameRanges) – Ranges in the database to check for outliers

  • padding (int32) – Padding to apply to returned outlier ranges in frames

  • threshold (float) – Number of multiples of the standard deviation away from the mean to treat as an outlier

  • location_minimum_difference (float) – Minimum difference away from the mean (in cm) for bone locations to treat as outliers

  • rotation_minimum_difference (float) – Minimum difference away from the mean (in degrees) for bone rotations to treat as outliers

  • scale_minimum_difference (float) – Minimum difference away from the mean for bone scales to treat as outliers

  • linear_velocity_minimum_difference (float) – Minimum difference away from the mean (in cm/s) for bone linear velocities to treat as outliers

  • angular_velocity_minimum_difference (float) – Minimum difference away from the mean (in deg/s) for bone angular velocities to treat as outliers

  • scalar_velocity_minimum_difference (float) – Minimum difference away from the mean for bone scalar velocities to treat as outliers

Return type:

AnimDatabaseFrameRanges

classmethod frame_attribute_pitch(a) → AnimDatabaseFrameAttribute

Extracts the Pitch component of a rotation frame attribute.

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_product(frame_attributes) → AnimDatabaseFrameAttribute

Computes the product of multiple frame attributes. Assumes all are the same type

Parameters:

frame_attributes (Array[AnimDatabaseFrameAttribute])

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_project(a, projection=[1.000000, 1.000000, 0.000000]) → AnimDatabaseFrameAttribute

Projects a frame attribute with the given vector. Assumes type is compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_quat_divide(a, b) → AnimDatabaseFrameAttribute

Divides a frame attribute by a constant quat value. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_quat_multiply(a, b) → AnimDatabaseFrameAttribute

Multiplies a frame attribute by a constant quat value. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_quat_rotate(rotation, vector) → AnimDatabaseFrameAttribute

Rotates a vector frame attribute by the given rotation

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_quat_unrotate(rotation, vector) → AnimDatabaseFrameAttribute

Unrotates a vector frame attribute by the given rotation

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_repeat_first_in_range(frame_attribute) → AnimDatabaseFrameAttribute

Creates a frame attribute that repeats the first value in each range for the rest of the range

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_roll(a) → AnimDatabaseFrameAttribute

Extracts the Roll component of a rotation frame attribute.

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_rotate(rotation, vector) → AnimDatabaseFrameAttribute

Rotates a vector frame attribute by the given rotation frame attribute

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_rotate_and_add(vector, rotation, addition) → AnimDatabaseFrameAttribute

Rotates and Adds a vector frame attribute by the given addition and rotation frame attributes

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_rotate_direction(rotation, direction=[1.000000, 0.000000, 0.000000]) → AnimDatabaseFrameAttribute

Rotates the given constant direction by the rotation frame attribute

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_rotation_angle_traveled(rotation_frame_attribute) -> (out_mean=float, out_std=float, out_min=float, out_max=float)

Computes the mean, std, min, and max angle traveled (in degrees) across each range in a rotation frame attribute

Parameters:

rotation_frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_mean (float):

out_std (float):

out_min (float):

out_max (float):

Return type:

tuple

classmethod frame_attribute_rotation_at_frame(frame_attribute, sequence_idx, frame_idx) → Rotator or None

Sample the given FrameAttribute at the provide Sequence and Frame as a rotation. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_rotation (Rotator):

Return type:

Rotator or None

classmethod frame_attribute_rotation_between_direction(directions, direction=[1.000000, 0.000000, 0.000000]) → AnimDatabaseFrameAttribute

Compute the rotation between the given direction frame attribute and the constant direction provided

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_rotation_matching_distance(rotation_frame_attribute, rotation, weight=1.000000) → AnimDatabaseFrameAttribute

Computes a float frame attribute representing the matching distance between some rotation frame attribute and a constant rotation value.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_rotation_mean_and_std(rotation_frame_attribute) -> (out_mean=Rotator, out_std=Vector)

Computes the mean and std (represented as an angular velocity) of a rotation frame attribute

Parameters:

rotation_frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_mean (Rotator):

out_std (Vector):

Return type:

tuple

classmethod frame_attribute_sample_angle_degrees(frame_attribute, sequence_idx, sequence_time, frame_rate) → float or None

Sample the given FrameAttribute at the provide Sequence and Time as an angle in degrees. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_value (float):

Return type:

float or None

classmethod frame_attribute_sample_angle_radians(frame_attribute, sequence_idx, sequence_time, frame_rate) → float or None

Sample the given FrameAttribute at the provide Sequence and Time as an angle in radians. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_value (float):

Return type:

float or None

classmethod frame_attribute_sample_angular_velocity(frame_attribute, sequence_idx, sequence_time, frame_rate) → Vector or None

Sample the given FrameAttribute at the provide Sequence and Time as an angular velocity. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_angular_velocity (Vector):

Return type:

Vector or None

classmethod frame_attribute_sample_bool(frame_attribute, sequence_idx, sequence_time, frame_rate) → bool or None

Sample the given FrameAttribute at the provide Sequence and Time as a bool. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_bool (bool):

Return type:

bool or None

classmethod frame_attribute_sample_direction(frame_attribute, sequence_idx, sequence_time, frame_rate) → Vector or None

Sample the given FrameAttribute at the provide Sequence and Time as a direction. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_direction (Vector):

Return type:

Vector or None

classmethod frame_attribute_sample_directions(frame_attributes, sequence_idx, sequence_time, frame_rate) → Array[Vector] or None

Sample the given FrameAttributes at the provide Sequence and Time as an array of directions. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_directions (Array[Vector]):

Return type:

Array[Vector] or None

classmethod frame_attribute_sample_event(frame_attribute, sequence_idx, sequence_time, frame_rate) → (out_time_until_event_known=bool, out_time_until_event=float) or None

Sample the given FrameAttribute at the provide Sequence and Time as an event. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_time_until_event_known (bool):

out_time_until_event (float):

Return type:

tuple or None

classmethod frame_attribute_sample_float(frame_attribute, sequence_idx, sequence_time, frame_rate) → float or None

Sample the given FrameAttribute at the provide Sequence and Time as a float. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_value (float):

Return type:

float or None

classmethod frame_attribute_sample_float_range(frame_attribute, sequence_idx, start_time, end_time, num, frame_rate) → Array[float]

Sample the given FrameAttribute at the provide Sequence and Time Range as a float.

Parameters:
Returns:

out_values (Array[float]):

Return type:

Array[float]

classmethod frame_attribute_sample_linear_velocities(frame_attributes, sequence_idx, sequence_time, frame_rate) → Array[Vector] or None

Sample the given FrameAttributes at the provide Sequence and Time as an array of linear velocities. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_linear_velocities (Array[Vector]):

Return type:

Array[Vector] or None

classmethod frame_attribute_sample_linear_velocity(frame_attribute, sequence_idx, sequence_time, frame_rate) → Vector or None

Sample the given FrameAttribute at the provide Sequence and Time as a linear velocity. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_linear_velocity (Vector):

Return type:

Vector or None

classmethod frame_attribute_sample_location(frame_attribute, sequence_idx, sequence_time, frame_rate) → Vector or None

Sample the given FrameAttribute at the provide Sequence and Time as a location. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_location (Vector):

Return type:

Vector or None

classmethod frame_attribute_sample_locations(frame_attributes, sequence_idx, sequence_time, frame_rate) → Array[Vector] or None

Sample the given FrameAttributes at the provide Sequence and Time as an array of locations. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_locations (Array[Vector]):

Return type:

Array[Vector] or None

classmethod frame_attribute_sample_rotation(frame_attribute, sequence_idx, sequence_time, frame_rate) → Rotator or None

Sample the given FrameAttribute at the provide Sequence and Time as a rotation. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_rotation (Rotator):

Return type:

Rotator or None

classmethod frame_attribute_sample_scalar_velocity(frame_attribute, sequence_idx, sequence_time, frame_rate) → Vector or None

Sample the given FrameAttribute at the provide Sequence and Time as scalar velocity. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_scalar_velocity (Vector):

Return type:

Vector or None

classmethod frame_attribute_sample_scale(frame_attribute, sequence_idx, sequence_time, frame_rate) → Vector or None

Sample the given FrameAttribute at the provide Sequence and Time as a scale. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_scale (Vector):

Return type:

Vector or None

classmethod frame_attribute_sample_transform(frame_attribute, sequence_idx, sequence_time, frame_rate) → Transform or None

Sample the given FrameAttribute at the provide Sequence and Time as a transform. Returns false if sequence and time is not within Frame Attribute Ranges.

Parameters:
Returns:

out_transform (Transform):

Return type:

Transform or None

classmethod frame_attribute_sav_gol_smoothed_root_transform(database, frame_ranges, root_location_projection_bone_name='spine_02', root_rotation_projection_bone_name='pelvis', root_rotation_bone_forward_direction=[0.000000, 1.000000, 0.000000], root_forward_direction=[0.000000, 1.000000, 0.000000], location_sav_gol_frame_num=61, location_sav_gol_polynomial_degree=3, direction_sav_gol_frame_num=91, direction_sav_gol_polynomial_degree=3, gaussian_windowed=True) → AnimDatabaseFrameAttribute

Computes a root transform by projecting bones onto the ground plane and smoothing the resulting location and direction with a SavGol filter.

Parameters:

  • database (AnimDatabase) – Database to use

  • frame_ranges (AnimDatabaseFrameRanges) – Ranges in the database to use

  • root_location_projection_bone_name (Name) – Name of the bone to project onto the ground plane and use as the root location

  • root_rotation_projection_bone_name (Name) – Name of the bone to project onto the ground plane and use as the root rotation

  • root_rotation_bone_forward_direction (Vector) – Local forward direction of the bone to use as the root rotation

  • root_forward_direction (Vector) – Local forward direction of the desired root transform

  • location_sav_gol_frame_num (int32) – Number of frames over which to apply the location savgol filter

  • location_sav_gol_polynomial_degree (int32) – Degree of polynomial to use for the location savgol filter

  • direction_sav_gol_frame_num (int32) – Number of frames over which to apply the location direction filter

  • direction_sav_gol_polynomial_degree (int32) – Degree of polynomial to use for the direction savgol filter

  • gaussian_windowed (bool) – If to apply a gaussian weighted window to the savgol polynomial fitting

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_scalar_velocity_at_frame(frame_attribute, sequence_idx, frame_idx) → Vector or None

Sample the given FrameAttribute at the provide Sequence and Frame as scalar velocity. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_scalar_velocity (Vector):

Return type:

Vector or None

classmethod frame_attribute_scale_at_frame(frame_attribute, sequence_idx, frame_idx) → Vector or None

Sample the given FrameAttribute at the provide Sequence and Frame as a scale. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_scale (Vector):

Return type:

Vector or None

classmethod frame_attribute_scale_mean_and_std(scale_frame_attribute) -> (out_mean=Vector, out_log_std=Vector)

Computes the mean and log std of a scale frame attribute

Parameters:

scale_frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_mean (Vector):

out_log_std (Vector):

Return type:

tuple

classmethod frame_attribute_select(cond, true, false) → AnimDatabaseFrameAttribute

Selects between True and False based on the given condition bool frame attribute

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_sin(a) → AnimDatabaseFrameAttribute

Takes the sin value of a frame attribute. Assumes input is an Angle attribute.

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_subtract(a, b) → AnimDatabaseFrameAttribute

Subtracts two frame attributes. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_subtract_and_unrotate(vector, subtraction, rotation) → AnimDatabaseFrameAttribute

Subtracts and Unrotates a vector frame attribute by the given subtract and rotation frame attributes

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_subtract_angle_degrees(a, b) → AnimDatabaseFrameAttribute

Subtracts a constant angle value in degrees to an angle frame attribute.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_subtract_angle_radians(a, b) → AnimDatabaseFrameAttribute

Subtracts a constant angle value in radians to an angle frame attribute.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_subtract_float(a, b) → AnimDatabaseFrameAttribute

Subtracts a constant float value to a frame attribute. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_subtract_vector(a, b) → AnimDatabaseFrameAttribute

Subtracts a constant vector value to a frame attribute. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_sum(frame_attributes) → AnimDatabaseFrameAttribute

Computes the sum of multiple frame attributes. Assumes all are the same type

Parameters:

frame_attributes (Array[AnimDatabaseFrameAttribute])

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_to_angle_array_degrees(frame_attribute) → Array[float]

Converts a frame attribute to an array of floats in degrees

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_array (Array[float]):

Return type:

Array[float]

classmethod frame_attribute_to_angle_array_radians(frame_attribute) → Array[float]

Converts a frame attribute to an array of floats in radians

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_array (Array[float]):

Return type:

Array[float]

classmethod frame_attribute_to_bool_array(frame_attribute) → Array[bool]

Converts a frame attribute to an array of bools

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_array (Array[bool]):

Return type:

Array[bool]

classmethod frame_attribute_to_float_array(frame_attribute) → Array[float]

Converts a frame attribute to an array of floats

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_array (Array[float]):

Return type:

Array[float]

classmethod frame_attribute_to_quat_array(frame_attribute) → Array[Quat]

Converts a frame attribute to an array of quats

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_array (Array[Quat]):

Return type:

Array[Quat]

classmethod frame_attribute_to_rotation_vector(a) → AnimDatabaseFrameAttribute

Converts a rotation frame attribute into an angular velocity frame attribute.

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_to_rotator_array(frame_attribute) → Array[Rotator]

Converts a frame attribute to an array of rotators

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_array (Array[Rotator]):

Return type:

Array[Rotator]

classmethod frame_attribute_to_string(frame_attribute) → str

Converts a FrameAttribute object to a string.

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Return type:

str

classmethod frame_attribute_to_string_format(database, frame_attribute, cutoff=11) → str

Converts a FrameAttribute object to a string object in full.

Parameters:
Return type:

str

classmethod frame_attribute_to_transform_array(frame_attribute) → Array[Transform]

Converts a frame attribute to an array of transforms

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_array (Array[Transform]):

Return type:

Array[Transform]

classmethod frame_attribute_to_vector_array(frame_attribute) → Array[Vector]

Converts a frame attribute to an array of vectors

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_array (Array[Vector]):

Return type:

Array[Vector]

classmethod frame_attribute_total_frame_num(frame_attribute) → int32

Gets the total number of frames in a frame attribute

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Return type:

int32

classmethod frame_attribute_total_range_num(frame_attribute) → int32

Gets the total number of ranges in a frame attribute

Parameters:

frame_attribute (AnimDatabaseFrameAttribute)

Return type:

int32

classmethod frame_attribute_transform_apply(a, b) → AnimDatabaseFrameAttribute

Applies a constant transformation to a frame attribute. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_transform_at_frame(frame_attribute, sequence_idx, frame_idx) → Transform or None

Sample the given FrameAttribute at the provide Sequence and Frame as a transform. Returns false if sequence and frame is not within Frame Attribute Ranges.

Parameters:
Returns:

out_transform (Transform):

Return type:

Transform or None

classmethod frame_attribute_transform_divide(a, b) → AnimDatabaseFrameAttribute

Divides a frame attribute by a constant transform value. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_transform_location(transform) → AnimDatabaseFrameAttribute

Gets the Location part of a Transform frame attribute

Parameters:

transform (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_transform_multiply(a, b) → AnimDatabaseFrameAttribute

Multiplies a frame attribute by a constant transform value. Assumes types are compatible

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_transform_rotation(transform) → AnimDatabaseFrameAttribute

Gets the Rotation part of a Transform frame attribute

Parameters:

transform (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_transform_scale(transform) → AnimDatabaseFrameAttribute

Gets the Scale part of a Transform frame attribute

Parameters:

transform (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_unrotate(rotation, vector) → AnimDatabaseFrameAttribute

Unrotates a vector frame attribute by the given rotation frame attribute

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_unrotate_direction(rotation, direction=[1.000000, 0.000000, 0.000000]) → AnimDatabaseFrameAttribute

Unrotates the given constant direction by the rotation frame attribute

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_velocity_matching_distance(velocity_frame_attribute, velocity, scale=200.000000, weight=1.000000) → AnimDatabaseFrameAttribute

Computes a float frame attribute representing the matching distance between some velocity frame attribute and a constant velocity value.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_velocity_mean_and_std(velocity_frame_attribute) -> (out_mean=Vector, out_std=Vector)

Computes the mean and std of a velocity frame attribute

Parameters:

velocity_frame_attribute (AnimDatabaseFrameAttribute)

Returns:

out_mean (Vector):

out_std (Vector):

Return type:

tuple

classmethod frame_attribute_velocity_to_direction(velocity_frame_attribute) → AnimDatabaseFrameAttribute

Converts a velocity frame attribute to a direction frame attribute (normalizing the result)

Parameters:

velocity_frame_attribute (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_w(a) → AnimDatabaseFrameAttribute

Extracts the W component of a frame attribute. Assumes type is subscriptable

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_weighted_sum(frame_attributes, weights) → AnimDatabaseFrameAttribute

Computes the weighted sum of multiple frame attributes. Assumes all are the same type

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_x(a) → AnimDatabaseFrameAttribute

Extracts the X component of a frame attribute. Assumes type is subscriptable

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_y(a) → AnimDatabaseFrameAttribute

Extracts the Y component of a frame attribute. Assumes type is subscriptable

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_yaw(a) → AnimDatabaseFrameAttribute

Extracts the Yaw component of a rotation frame attribute.

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attribute_z(a) → AnimDatabaseFrameAttribute

Extracts the Z component of a frame attribute. Assumes type is subscriptable

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod frame_attributes_add(a, b) → Array[AnimDatabaseFrameAttribute]

Adds a frame attribute to multiple others. Assumes types are compatible

Parameters:
Returns:

out (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod frame_attributes_average_std(frame_ranges) → float

Computes the average of the std across all channels of multiple frame attributes

Parameters:

frame_ranges (Array[AnimDatabaseFrameAttribute])

Return type:

float

classmethod frame_attributes_divide(a, b) → Array[AnimDatabaseFrameAttribute]

Divides a frame attribute to multiple others. Assumes types are compatible

Parameters:
Returns:

out (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod frame_attributes_inverse_multiply(a, b) → Array[AnimDatabaseFrameAttribute]

Computes inv(A) x B for arrays of frame attributes. Assumes types are compatible

Parameters:
Returns:

out (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod frame_attributes_multiply(a, b) → Array[AnimDatabaseFrameAttribute]

Multiplies a frame attribute to multiple others. Assumes types are compatible

Parameters:
Returns:

out (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod frame_attributes_multiply_inverse(a, b) → Array[AnimDatabaseFrameAttribute]

Computes A x inv(B) for arrays of frame attributes. Assumes types are compatible

Parameters:
Returns:

out (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod frame_attributes_rotate(rotation, vectors) → Array[AnimDatabaseFrameAttribute]

Rotates multiple frame attributes by a rotation frame attribute. Assumes types are compatible

Parameters:
Returns:

out_vectors (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod frame_attributes_rotate_and_add(frame_attributes, rotation, addition) → Array[AnimDatabaseFrameAttribute]

Rotates and adds multiple frame attributes by rotation and addition frame attributes. Assumes types are compatible

Parameters:
Returns:

out (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod frame_attributes_subtract(a, b) → Array[AnimDatabaseFrameAttribute]

Subtracts a frame attribute to multiple others. Assumes types are compatible

Parameters:
Returns:

out (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod frame_attributes_subtract_and_unrotate(frame_attributes, subtraction, rotation) → Array[AnimDatabaseFrameAttribute]

Subtracts and unrotates multiple frame attributes by subtraction and rotation frame attributes. Assumes types are compatible

Parameters:
Returns:

out (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod frame_attributes_unrotate(rotation, vectors) → Array[AnimDatabaseFrameAttribute]

Unrotates multiple frame attributes by a rotation frame attribute. Assumes types are compatible

Parameters:
Returns:

out_vectors (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_angle_frame_attribute_from_constant_degrees(frame_ranges, value=0.000000) → AnimDatabaseFrameAttribute

Makes an angle frame attribute from the given ranges, filled with the provided value in degrees.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_angle_frame_attribute_from_constant_radians(frame_ranges, value=0.000000) → AnimDatabaseFrameAttribute

Makes an angle frame attribute from the given ranges, filled with the provided value in radians.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_angle_frame_attribute_from_float_degrees(a) → AnimDatabaseFrameAttribute

Makes an angle frame attribute from a float frame attribute with values in degrees

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod make_angle_frame_attribute_from_float_radians(a) → AnimDatabaseFrameAttribute

Makes an angle frame attribute from a float frame attribute with values in radians

Parameters:

a (AnimDatabaseFrameAttribute)

Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_angular_velocity_frame_attribute(database, frame_ranges, bone_index, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a angular velocity frame attribute from the global angular velocity of a bone

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_angular_velocity_frame_attribute_from_name(database, frame_ranges, bone_name, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a angular velocity frame attribute from the global angular velocity of a bone, provided by name

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_direction_at_nearest_frames_frame_attribute(database, frame_ranges, bone_index, frames, local_direction=[1.000000, 0.000000, 0.000000]) → AnimDatabaseFrameAttribute

Computes the global bone direction of a bone at the nearest frame in the set of Frames

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_direction_frame_attribute(database, frame_ranges, bone_index, local_direction=[1.000000, 0.000000, 0.000000], relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a direction frame attribute from the global direction of a bone

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_direction_frame_attribute_from_name(database, frame_ranges, bone_name, local_direction=[1.000000, 0.000000, 0.000000], relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a direction frame attribute from the global direction of a bone, provided by name

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_direction_frame_attributes(database, frame_ranges, bone_indices, local_direction=[1.000000, 0.000000, 0.000000], relative_time=0.000000) → Array[AnimDatabaseFrameAttribute]

Makes direction frame attributes from the global direction of bones

Parameters:
Returns:

out_direction_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_bone_global_direction_frame_attributes_from_names(database, frame_ranges, bone_names, local_direction=[1.000000, 0.000000, 0.000000], relative_time=0.000000) → Array[AnimDatabaseFrameAttribute]

Makes direction frame attributes from the global direction of bones, provided by name

Parameters:
Returns:

out_direction_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_bone_global_frame_attributes(database, frame_ranges, bone_location_indices, bone_rotation_indices, bone_scale_indices, bone_linear_velocity_indices, bone_angular_velocity_indices, bone_scalar_velocity_indices, relative_time=0.000000) -> (out_location_frame_attributes=Array[AnimDatabaseFrameAttribute], out_rotation_frame_attributes=Array[AnimDatabaseFrameAttribute], out_scale_frame_attributes=Array[AnimDatabaseFrameAttribute], out_linear_velocity_frame_attributes=Array[AnimDatabaseFrameAttribute], out_angular_velocity_frame_attributes=Array[AnimDatabaseFrameAttribute], out_scalar_velocity_frame_attributes=Array[AnimDatabaseFrameAttribute])

General function for computing bone attributes in the world space. Outputs various arrays of frame attributes based on the bone indices passed in. This is the most efficient way of computing multiple global bone attributes as it combines all required bone indices into one large array, evaluates the pose data in the animation sequences once extracting information for these bones, and then performs just the subset of forward kinematics required to extract the desired properties.

Given that evaluating the animation data for a whole animation database can be relatively slow it is encouraged to use this function wherever possible rather than the more convenient individual functions for computing bone attributes.

Parameters:
Returns:

out_location_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_rotation_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_scale_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_linear_velocity_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_angular_velocity_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_scalar_velocity_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

tuple

classmethod make_bone_global_linear_velocity_frame_attribute(database, frame_ranges, bone_index, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a linear velocity frame attribute from the global linear velocity of a bone

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_linear_velocity_frame_attribute_from_name(database, frame_ranges, bone_name, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a linear velocity frame attribute from the global linear velocity of a bone, provided by name

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_location_and_linear_velocity_frame_attribute(database, frame_ranges, bone_index, relative_time=0.000000) -> (out_location_frame_attribute=AnimDatabaseFrameAttribute, out_linear_velocity_frame_attribute=AnimDatabaseFrameAttribute)

Makes a location and linear velocity frame attribute from the global location and linear velocity of a bone

Parameters:
Returns:

out_location_frame_attribute (AnimDatabaseFrameAttribute):

out_linear_velocity_frame_attribute (AnimDatabaseFrameAttribute):

Return type:

tuple

classmethod make_bone_global_location_and_linear_velocity_frame_attribute_from_name(database, frame_ranges, bone_name, relative_time=0.000000) -> (out_location_frame_attribute=AnimDatabaseFrameAttribute, out_linear_velocity_frame_attribute=AnimDatabaseFrameAttribute)

Makes a location and linear velocity frame attribute from the global location and linear velocity of a bone, provided by name

Parameters:
Returns:

out_location_frame_attribute (AnimDatabaseFrameAttribute):

out_linear_velocity_frame_attribute (AnimDatabaseFrameAttribute):

Return type:

tuple

classmethod make_bone_global_location_at_nearest_frames_frame_attribute(database, frame_ranges, bone_index, frames) → AnimDatabaseFrameAttribute

Computes the global bone location of a bone at the nearest frame in the set of Frames

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_location_frame_attribute(database, frame_ranges, bone_index, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a location frame attribute from the global location of a bone

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_location_frame_attribute_from_name(database, frame_ranges, bone_name, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a location frame attribute from the global location of a bone, provided by name

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_location_frame_attributes(database, frame_ranges, bone_indices, relative_time=0.000000) → Array[AnimDatabaseFrameAttribute]

Makes location frame attributes from the global location of bones

Parameters:
Returns:

out_location_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_bone_global_location_frame_attributes_from_names(database, frame_ranges, bone_names, relative_time=0.000000) → Array[AnimDatabaseFrameAttribute]

Makes location frame attributes from the global location of bones, provided by name

Parameters:
Returns:

out_location_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_bone_global_rotation_frame_attribute(database, frame_ranges, bone_index, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a rotation frame attribute from the global rotation of a bone

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_rotation_frame_attribute_from_name(database, frame_ranges, bone_name, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a rotation frame attribute from the global rotation of a bone, provided by name

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_transform_frame_attribute(database, frame_ranges, bone_index, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a transform frame attribute from the global transform of a bone

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_transform_frame_attribute_from_name(database, frame_ranges, bone_name, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a transform frame attribute from the global transform of a bone, provided by name

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_global_transform_frame_attributes(database, frame_ranges, bone_indices, relative_time=0.000000) → Array[AnimDatabaseFrameAttribute]

General function for computing bone transforms in the world space. Outputs frame attributes based on the bone indices passed in. This is the most efficient way of computing multiple global bone transform attributes as it combines all required bone indices into one large array, evaluates the pose data in the animation sequences once extracting information for these bones, and then performs just the subset of forward kinematics required to extract the desired properties.

Given that evaluating the animation data for a whole animation database can be relatively slow it is encouraged to use this function wherever possible rather than the more convenient individual functions for computing bone transform attributes.

Parameters:
Returns:

out_transform_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_bone_global_transform_frame_attributes_from_names(database, frame_ranges, bone_names, relative_time=0.000000) → Array[AnimDatabaseFrameAttribute]

General function for computing bone transforms in the world space. Outputs frame attributes based on the bone names passed in. This is the most efficient way of computing multiple global bone transform attributes as it combines all required bone names into one large array, evaluates the pose data in the animation sequences once extracting information for these bones, and then performs just the subset of forward kinematics required to extract the desired properties.

Given that evaluating the animation data for a whole animation database can be relatively slow it is encouraged to use this function wherever possible rather than the more convenient individual functions for computing bone transform attributes.

Parameters:
Returns:

out_transform_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_bone_local_frame_attributes(database, frame_ranges, bone_location_indices, bone_rotation_indices, bone_scale_indices, bone_linear_velocity_indices, bone_angular_velocity_indices, bone_scalar_velocity_indices, relative_time=0.000000) -> (out_location_frame_attributes=Array[AnimDatabaseFrameAttribute], out_rotation_frame_attributes=Array[AnimDatabaseFrameAttribute], out_scale_frame_attributes=Array[AnimDatabaseFrameAttribute], out_linear_velocity_frame_attributes=Array[AnimDatabaseFrameAttribute], out_angular_velocity_frame_attributes=Array[AnimDatabaseFrameAttribute], out_scalar_velocity_frame_attributes=Array[AnimDatabaseFrameAttribute])

General function for computing bone attributes in the local space. Outputs various arrays of frame attributes based on the bone indices passed in. This is the most efficient way of computing multiple local bone attributes as it combines all required bone indices into one large array, evaluates the pose data in the animation sequences once extracting information for these bones.

Given that evaluating the animation data for a whole animation database can be relatively slow it is encouraged to use this function wherever possible rather than the more convenient individual functions for computing bone attributes.

Parameters:
Returns:

out_location_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_rotation_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_scale_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_linear_velocity_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_angular_velocity_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_scalar_velocity_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

tuple

classmethod make_bone_local_location_frame_attribute(database, frame_ranges, bone_index, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a location frame attribute from the local location of a bone

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_local_location_frame_attribute_from_name(database, frame_ranges, bone_name, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a location frame attribute from the local location of a bone, provided by name

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_local_rotation_frame_attribute(database, frame_ranges, bone_index, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a rotation frame attribute from the local rotation of a bone

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_local_rotation_frame_attribute_from_name(database, frame_ranges, bone_name, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a rotation frame attribute from the local rotation of a bone, provided by name

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_local_scale_frame_attribute(database, frame_ranges, bone_index, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a scale frame attribute from the local scale of a bone

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_local_scale_frame_attribute_from_name(database, frame_ranges, bone_name, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a scale frame attribute from the local scale of a bone, provided by name

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_local_transform_frame_attribute(database, frame_ranges, bone_index, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a location frame attribute from the local transform of a bone

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_local_transform_frame_attribute_from_name(database, frame_ranges, bone_name, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a location frame attribute from the local transform of a bone, provided by name

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bone_local_transform_frame_attributes(database, frame_ranges, bone_indices, relative_time=0.000000) → Array[AnimDatabaseFrameAttribute]

General function for computing bone transforms in the local space. Outputs frame attributes based on the bone indices passed in. This is the most efficient way of computing multiple local bone transform attributes as it combines all required bone indices into one large array, evaluates the pose data in the animation sequences once extracting information for these bones.

Given that evaluating the animation data for a whole animation database can be relatively slow it is encouraged to use this function wherever possible rather than the more convenient individual functions for computing bone transform attributes.

Parameters:
Returns:

out_transform_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_bone_local_transform_frame_attributes_from_names(database, frame_ranges, bone_names, relative_time=0.000000) → Array[AnimDatabaseFrameAttribute]

Make Bone Local Transform Frame Attributes from Names

Parameters:
Returns:

out_transform_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_bool_frame_attribute_from_active_ranges(active, frame_ranges) → AnimDatabaseFrameAttribute

Makes a bool frame attribute which is true where the frame is contained in given Active FrameRangeSet, and false elsewhere

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bool_frame_attribute_from_anim_notify_state(database, frame_ranges, notify_state) → AnimDatabaseFrameAttribute

Makes a bool frame attribute from the given ranges, which is true when the provided NotifyState is active, and false everywhere else

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bool_frame_attribute_from_constant(active, frame_ranges) → AnimDatabaseFrameAttribute

Make a bool frame range attribute from the given ranges and constant value

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bool_frame_attribute_from_curve_active(database, frame_ranges, curve_name) → AnimDatabaseFrameAttribute

Makes a bool frame attribute from the given ranges, which is true when the provided curve is present in the data, and false everywhere else

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bool_frame_attribute_from_false(frame_ranges) → AnimDatabaseFrameAttribute

Make a bool frame range attribute from the given ranges with all frames set to false

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

AnimDatabaseFrameAttribute

classmethod make_bool_frame_attribute_from_mirrored(database, frame_ranges) → AnimDatabaseFrameAttribute

Makes a bool frame attribute which is true where the frame is mirrored, and false elsewhere

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bool_frame_attribute_from_not_mirrored(database, frame_ranges) → AnimDatabaseFrameAttribute

Makes a bool frame attribute which is true where the frame is NOT mirrored, and false elsewhere

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_bool_frame_attribute_from_true(frame_ranges) → AnimDatabaseFrameAttribute

Make a bool frame range attribute from the given ranges with all frames set to true

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

AnimDatabaseFrameAttribute

classmethod make_bool_frame_attributes_from_active_ranges(actives, frame_ranges) → Array[AnimDatabaseFrameAttribute]

Makes multiple bool frame attributes which are true where the frame is contained in given Active FrameRangeSets, and false elsewhere

Parameters:
Returns:

out_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_bool_frame_attributes_from_curves_active(database, frame_ranges, curve_names) → Array[AnimDatabaseFrameAttribute]

Makes a set of bool frame attributes from the given ranges, which are true when the provided curves are present in the data and false everywhere else

Parameters:
Returns:

out_bool_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_direction_frame_attribute(x, y, z) → AnimDatabaseFrameAttribute

Makes a direction frame attribute from X, Y and Z attributes.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_direction_frame_attribute_from_constant(frame_ranges, direction=[1.000000, 0.000000, 0.000000]) → AnimDatabaseFrameAttribute

Makes a direction frame attribute from the given ranges, filled with the provided value.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_empty_frame_attribute() → AnimDatabaseFrameAttribute

Make an empty Frame Attribute

Return type:

AnimDatabaseFrameAttribute

classmethod make_event_frame_attribute(event_frames, frame_ranges, frame_rate) → AnimDatabaseFrameAttribute

Makes an event frame attribute from the given ranges, at the times of the given frames

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_event_frame_attribute_at_range_ends(event_frame_ranges, frame_ranges, frame_rate) → AnimDatabaseFrameAttribute

Makes an event frame attribute from the given ranges, at the end times of the given EventFrameRanges

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_event_frame_attribute_at_range_starts(event_frame_ranges, frame_ranges, frame_rate) → AnimDatabaseFrameAttribute

Makes an event frame attribute from the given ranges, at the start times of the given EventFrameRanges

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_event_frame_attribute_from_anim_notify(database, frame_ranges, notify) → AnimDatabaseFrameAttribute

Makes an event frame attribute from the given ranges, at the times of the given anim notifies

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_event_frame_attribute_from_anim_notify_state_ends(database, frame_ranges, notify_state) → AnimDatabaseFrameAttribute

Makes an event frame attribute from the given ranges, at the times of the given anim notify state ends

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_event_frame_attribute_from_anim_notify_state_starts(database, frame_ranges, notify_state) → AnimDatabaseFrameAttribute

Makes an event frame attribute from the given ranges, at the times of the given anim notify state starts

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_event_frame_attribute_from_anim_notify_union(database, frame_ranges, notifies) → AnimDatabaseFrameAttribute

Makes an event frame attribute from the given ranges, at the times of the given anim notifies

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_float_frame_attribute_from_constant(frame_ranges, value=0.000000) → AnimDatabaseFrameAttribute

Makes a float frame attribute from the given ranges, filled with the provided value.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_float_frame_attribute_from_curve(database, frame_ranges, curve_name) → AnimDatabaseFrameAttribute

Makes a float frame attribute from the given ranges, using the given curve name. For when the curve is not present in the animations a default value of 0 will be used.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_float_frame_attribute_from_curve_when_active(database, frame_ranges, curve_name) → AnimDatabaseFrameAttribute

Makes a float frame attribute using the given curve name. For when the curve is not present in the database the attribute will be inactive.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_float_frame_attribute_from_nearest_frame_sequence_times(frame_ranges, frames, frame_rate) → AnimDatabaseFrameAttribute

Makes a float frame attribute where the value of the attribute is given by the sequence time of the nearest frame in the Frames frames set. If the range does not contain a frame from Frames, then the time is 0.0

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_float_frame_attribute_from_one(frame_ranges) → AnimDatabaseFrameAttribute

Makes a float frame attribute from the given ranges, filled with one.

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

AnimDatabaseFrameAttribute

classmethod make_float_frame_attribute_from_range_times(frame_ranges, frame_rate) → AnimDatabaseFrameAttribute

Makes a float frame attribute where the value of the attribute is given by the time since the start of the range for each frame in each range in the set.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_float_frame_attribute_from_sequence_times(frame_ranges, frame_rate) → AnimDatabaseFrameAttribute

Makes a float frame attribute where the value of the attribute is given by the sequence time of each frame in each range in the set.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_float_frame_attribute_from_uniform_random(frame_ranges, state, min=0.000000, max=1.000000) -> (AnimDatabaseFrameAttribute, state=int32)

Makes a float frame attribute from a uniform distribution.

Parameters:
Returns:

state (int32):

Return type:

int32

classmethod make_float_frame_attribute_from_zero(frame_ranges) → AnimDatabaseFrameAttribute

Makes a float frame attribute from the given ranges, filled with zero.

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

AnimDatabaseFrameAttribute

classmethod make_float_frame_attributes_from_curves(database, frame_ranges, curve_names) → Array[AnimDatabaseFrameAttribute]

Makes multiple float frame attributes from the given ranges and curve names. For when the curve is not present in the animations a default value of 0 will be used.

Parameters:
Returns:

out_float_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_float_frame_attributes_from_curves_when_active(database, frame_ranges, curve_names) → Array[AnimDatabaseFrameAttribute]

Makes multiple float frame attributes from the given ranges and curve names. For when the curve is not present in the animations the attribute will be inactive.

Parameters:
Returns:

out_float_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_frame_attribute_from_class(database, frame_ranges, class_) → AnimDatabaseFrameAttribute

Make a Frame Attribute using the given UAnimDatabaseFrameAttributeFunction

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_frame_attribute_from_function(database, frame_ranges, function) → AnimDatabaseFrameAttribute

Make a Frame Attribute using the given UAnimDatabaseFrameAttributeFunction

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_frame_attributes_from_classes(database, frame_ranges, classes) → Array[AnimDatabaseFrameAttribute]

Make Frame Attributes using the given array of UAnimDatabaseFrameAttributeFunctions

Parameters:
Returns:

out_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_frame_attributes_from_classes_map(database, frame_ranges, classes) → Map[Name, AnimDatabaseFrameAttribute]

Make Frame Attributes using the given map of UAnimDatabaseFrameAttributeFunctions

Parameters:
Returns:

out_frame_attributes (Map[Name, AnimDatabaseFrameAttribute]):

Return type:

Map[Name, AnimDatabaseFrameAttribute]

classmethod make_frame_attributes_from_curves(database, frame_ranges, curve_names) -> (out_float_curve_value_frame_attributes=Array[AnimDatabaseFrameAttribute], out_float_curve_velocity_frame_attributes=Array[AnimDatabaseFrameAttribute], out_bool_curve_active_frame_attributes=Array[AnimDatabaseFrameAttribute])

Makes frame attributes for curve values, curve velocities, and if a curve is active from a set of given curves

Parameters:
Returns:

out_float_curve_value_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_float_curve_velocity_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_bool_curve_active_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

tuple

classmethod make_frame_attributes_from_functions(database, frame_ranges, functions) → Array[AnimDatabaseFrameAttribute]

Makes Frame Attributes using the given UAnimDatabaseFrameAttributeFunctions

Parameters:
Returns:

out_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_global_direction_between_bones_frame_attribute(database, frame_ranges, bone_index_from, bone_index_to) → AnimDatabaseFrameAttribute

Makes a direction frame attribute from the global vector between bones

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_global_direction_between_bones_frame_attribute_from_names(database, frame_ranges, bone_name_from, bone_name_to) → AnimDatabaseFrameAttribute

Makes a direction frame attribute from the global vector between bones, provided by name

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_location_frame_attribute(x, y, z) → AnimDatabaseFrameAttribute

Makes a location frame attribute from X, Y and Z attributes.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_location_frame_attribute_from_constant(frame_ranges, location=[0.000000, 0.000000, 0.000000]) → AnimDatabaseFrameAttribute

Makes a location frame attribute from the given ranges, filled with the provided value.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_location_trajectory_frame_attribute(database, frame_ranges, sample_num=4, future_time=1.000000, past_time=0.000000) → Array[AnimDatabaseFrameAttribute]

Makes an array of location frame attributes for the root at the given sample times into the future

Parameters:
Returns:

out_location_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

Array[AnimDatabaseFrameAttribute]

classmethod make_look_at_trajectory_frame_attribute(database, frame_ranges, look_at_bone_index, sample_num=4, future_time=1.000000, past_time=0.000000, local_direction=[0.000000, 1.000000, 0.000000], direction_smoothing_amount=15.000000) -> (out_location_frame_attributes=Array[AnimDatabaseFrameAttribute], out_direction_frame_attributes=Array[AnimDatabaseFrameAttribute])

Makes an array of location and direction frame attributes for the root location and look-at-direction of the provided bone at the given sample times into the future

Parameters:
Returns:

out_location_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_direction_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

tuple

classmethod make_null_frame_attribute(frame_ranges) → AnimDatabaseFrameAttribute

Make a null Frame Attribute for the given ranges

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

AnimDatabaseFrameAttribute

classmethod make_pose_frame_attribute(database, frame_ranges, bone_indices, relative_time=0.000000) -> (out_location_frame_attributes=Array[AnimDatabaseFrameAttribute], out_linear_velocity_frame_attributes=Array[AnimDatabaseFrameAttribute])

Makes arrays of frame attributes for a pose from the provided bone indices

Parameters:
Returns:

out_location_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_linear_velocity_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

tuple

classmethod make_random_bool_frame_attribute(state, frame_ranges) -> (AnimDatabaseFrameAttribute, state=int32)

Makes a bool frame attribute for the given ranges where each truth value is randomly sampled

Parameters:
Returns:

state (int32):

Return type:

int32

classmethod make_random_bool_frame_attributes(state, frame_ranges, frame_attribute_num) -> (out_frame_attributes=Array[AnimDatabaseFrameAttribute], state=int32)

Makes multiple random bool frame attributes from the given range set

Parameters:
Returns:

out_frame_attributes (Array[AnimDatabaseFrameAttribute]):

state (int32):

Return type:

tuple

classmethod make_root_angular_velocity_frame_attribute(database, frame_ranges, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a angular velocity frame attribute from the root angular velocity of the character at the given frame ranges

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_root_direction_at_range_end_frame_attribute(database, frame_ranges, forward_vector=[0.000000, 1.000000, 0.000000]) → AnimDatabaseFrameAttribute

Makes a direction frame attribute from the character root direction at the end of the range for every range in the given frame ranges

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_root_direction_at_range_start_frame_attribute(database, frame_ranges, forward_vector=[0.000000, 1.000000, 0.000000]) → AnimDatabaseFrameAttribute

Makes a direction frame attribute from the character root direction at the start of the range for every range in the given frame ranges

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_root_direction_frame_attribute(database, frame_ranges, relative_time=0.000000, forward_vector=[0.000000, 1.000000, 0.000000]) → AnimDatabaseFrameAttribute

Makes a direction frame attribute from the root direction of the character at the given frame ranges

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_root_linear_velocity_frame_attribute(database, frame_ranges, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a linear velocity frame attribute from the root linear velocity of the character at the given frame ranges

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_root_local_look_at_trajectory_frame_attribute_and_scale(database, frame_ranges, look_at_bone_index, sample_num=4, future_time=1.000000, past_time=0.000000, local_direction=[0.000000, 1.000000, 0.000000], direction_smoothing_amount=15.000000) -> (out_location_frame_attributes=Array[AnimDatabaseFrameAttribute], out_direction_frame_attributes=Array[AnimDatabaseFrameAttribute], out_location_scale=float)

Makes look-at trajectory frame attributes transformed local to the character’s root location and rotation. Computes the overall scale of locations - which is useful for scaling distance costs for use with matching.

Parameters:
Returns:

out_location_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_direction_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_location_scale (float):

Return type:

tuple

classmethod make_root_local_pose_frame_attribute_and_scale(database, frame_ranges, bone_indices) -> (out_location_frame_attributes=Array[AnimDatabaseFrameAttribute], out_linear_velocity_frame_attributes=Array[AnimDatabaseFrameAttribute], out_location_scale=float, out_linear_velocity_scale=float)

Makes arrays of frame attributes for a pose from the provided bone indices, transformed to be local to the root location and rotation, and then computes the overall scale of the locations and velocities.

Parameters:
Returns:

out_location_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_linear_velocity_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_location_scale (float):

out_linear_velocity_scale (float):

Return type:

tuple

classmethod make_root_local_trajectory_frame_attribute_and_scale(database, frame_ranges, sample_num=4, future_time=1.000000, past_time=0.000000, forward_vector=[0.000000, 1.000000, 0.000000]) -> (out_location_frame_attributes=Array[AnimDatabaseFrameAttribute], out_direction_frame_attributes=Array[AnimDatabaseFrameAttribute], out_location_scale=float)

Makes trajectory frame attributes transformed local to the character’s root location and rotation. Computes the overall scale of locations - which is useful for scaling distance costs for use with matching.

Parameters:
Returns:

out_location_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_direction_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_location_scale (float):

Return type:

tuple

classmethod make_root_location_and_direction_at_range_end_frame_attribute(database, frame_ranges, forward_vector=[0.000000, 1.000000, 0.000000]) -> (out_location_frame_attribute=AnimDatabaseFrameAttribute, out_direction_frame_attribute=AnimDatabaseFrameAttribute)

Makes a location and direction frame attribute from the character root location and direction at the end of the range for every range in the given frame ranges

Parameters:
Returns:

out_location_frame_attribute (AnimDatabaseFrameAttribute):

out_direction_frame_attribute (AnimDatabaseFrameAttribute):

Return type:

tuple

classmethod make_root_location_and_direction_frame_attribute(database, frame_ranges, relative_time=0.000000, forward_vector=[0.000000, 1.000000, 0.000000]) -> (out_root_location_frame_attribute=AnimDatabaseFrameAttribute, out_root_direction_frame_attribute=AnimDatabaseFrameAttribute)

Makes a location and direction frame attribute from the root location and direction of the character at the given frame ranges

Parameters:
Returns:

out_root_location_frame_attribute (AnimDatabaseFrameAttribute):

out_root_direction_frame_attribute (AnimDatabaseFrameAttribute):

Return type:

tuple

classmethod make_root_location_and_rotation_frame_attribute(database, frame_ranges, relative_time=0.000000) -> (out_root_location_frame_attribute=AnimDatabaseFrameAttribute, out_root_rotation_frame_attribute=AnimDatabaseFrameAttribute)

Makes a location and rotation frame attribute from the root location and rotation of the character at the given frame ranges

Parameters:
Returns:

out_root_location_frame_attribute (AnimDatabaseFrameAttribute):

out_root_rotation_frame_attribute (AnimDatabaseFrameAttribute):

Return type:

tuple

classmethod make_root_location_at_range_end_frame_attribute(database, frame_ranges) → AnimDatabaseFrameAttribute

Makes a location frame attribute from the character root location at the end of the range for every range in the given frame ranges

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_root_location_at_range_start_frame_attribute(database, frame_ranges) → AnimDatabaseFrameAttribute

Makes a location frame attribute from the character root location at the start of the range for every range in the given frame ranges

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_root_location_frame_attribute(database, frame_ranges, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a location frame attribute from the root location of the character at the given frame ranges

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_root_rotation_frame_attribute(database, frame_ranges, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a rotation frame attribute from the root rotation of the character at the given frame ranges

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_root_transform_at_sequence_start_frame_attribute(database, frame_ranges) → AnimDatabaseFrameAttribute

Makes a transform frame attribute from the root transform of the character at the start of each sequence

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_root_transform_frame_attribute(database, frame_ranges, relative_time=0.000000) → AnimDatabaseFrameAttribute

Makes a transform frame attribute from the root transform of the character at the given frame ranges

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_rotation_frame_attribute(pitch, yaw, roll) → AnimDatabaseFrameAttribute

Makes a rotation frame attribute from Yaw, Pitch and Roll.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_rotation_frame_attribute_from_basis_directions(forward_direction, right_direction, up_direction) → AnimDatabaseFrameAttribute

Makes a rotation frame attribute from a set of basis directions.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_rotation_frame_attribute_from_constant(frame_ranges, rotation=[0.000000, 0.000000, 0.000000]) → AnimDatabaseFrameAttribute

Makes a rotation frame attribute from the given ranges, filled with the provided value.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_rotation_frame_attribute_from_constant_quat(frame_ranges, rotation) → AnimDatabaseFrameAttribute

Makes a rotation frame attribute from the given ranges, filled with the provided value.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_scale_frame_attribute(x, y, z) → AnimDatabaseFrameAttribute

Makes a scale frame attribute from X, Y and Z attributes.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_scale_frame_attribute_from_constant(frame_ranges, scale=[1.000000, 1.000000, 1.000000]) → AnimDatabaseFrameAttribute

Makes a scale frame attribute from the given ranges, filled with the provided value.

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_trajectory_frame_attribute(database, frame_ranges, sample_num=4, future_time=1.000000, past_time=0.000000, forward_vector=[0.000000, 1.000000, 0.000000]) -> (out_location_frame_attributes=Array[AnimDatabaseFrameAttribute], out_direction_frame_attributes=Array[AnimDatabaseFrameAttribute])

Makes an array of location and direction frame attributes for the root at the given sample times into the future

Parameters:
Returns:

out_location_frame_attributes (Array[AnimDatabaseFrameAttribute]):

out_direction_frame_attributes (Array[AnimDatabaseFrameAttribute]):

Return type:

tuple

classmethod make_transform_frame_attribute(location, rotation, scale) → AnimDatabaseFrameAttribute

Makes a transform frame attribute from the given Location, Rotation, and Scale frame attributes

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_transform_frame_attribute_from_constant(frame_ranges, transform=[[0.000000, 0.000000, 0.000000], [-0.000000, 0.000000, 0.000000], [1.000000, 1.000000, 1.000000]]) → AnimDatabaseFrameAttribute

Makes a transform frame attribute from the given frame ranges filled with a constant value

Parameters:
Return type:

AnimDatabaseFrameAttribute

classmethod make_transform_frame_attribute_from_identity(frame_ranges) → AnimDatabaseFrameAttribute

Makes a transform frame attribute from the given frame ranges filled with the identity transform

Parameters:

frame_ranges (AnimDatabaseFrameRanges)

Return type:

AnimDatabaseFrameAttribute

classmethod make_transform_frame_attribute_no_scale(location, rotation) → AnimDatabaseFrameAttribute

Makes a transform frame attribute from the given Location and Rotation frame attributes

Parameters:
Return type:

AnimDatabaseFrameAttribute