unreal.AnimGenBehavior

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

Bases: Object

A Behavior represents a specific control structure that can be used to control a character (for example - a trajectory to follow, a target point to move towards).

To define a behavior it is required to inherit from this class and to provide the “SpecifyControl”, and “MakeControlSets” functions. The “DrawDebugControl” function may also be provided to do debug drawing in the training viewport.

C++ Source:

  • Plugin: AnimGen

  • Module: AnimGen

  • File: AnimGenBehavior.h

draw_debug_control(drawer, canvas_drawer, control_object, control_object_element, pose_state, database, auto_encoder, character_idx, sequence_idx, sequence_time, range_start, range_length, identifier_color) → None

Draw debug the current frame in the training data

Parameters:
make_control_sets(control_object, database, frame_ranges) -> (out_control_sets=Array[AnimGenControlSet], control_object=AnimGenControlObject)

Make the control sets used for training from the given database and frame ranges in the database

Parameters:
Returns:

out_control_sets (Array[AnimGenControlSet]):

control_object (AnimGenControlObject):

Return type:

tuple

specify_control(control_schema) -> (AnimGenControlSchemaElement, control_schema=AnimGenControlSchema)

Specify the control structure used by this behavior.

Parameters:

control_schema (AnimGenControlSchema)

Returns:

control_schema (AnimGenControlSchema):

Return type:

AnimGenControlSchema