-
Notifications
You must be signed in to change notification settings - Fork 0
class_animation
reduz edited this page Feb 23, 2014
·
10 revisions
Inherits: Resource\n\n
Contains data used to animate everything in the engine.
- int add_track ( int type, int at_pos=-1 )
- void remove_track ( int idx )
- int get_track_count ( ) const
- int track_get_type ( int idx ) const
- NodePath track_get_path ( int idx ) const
- void track_set_path ( int idx, NodePath path )
- int find_track ( NodePath path ) const
- void track_move_up ( int idx )
- void track_move_down ( int idx )
- int transform_track_insert_key ( int idx, real time, Vector3 loc, Quat rot, Vector3 scale )
- void track_insert_key ( int idx, real time, var key, real transition=1 )
- void track_remove_key ( int idx, int key_idx )
- void track_remove_key_at_pos ( int idx, real pos )
- void track_set_key_value ( int idx, int key, var value )
- void track_set_key_transition ( int idx, int key_idx, real transition )
- real track_get_key_transition ( int idx, int key_idx ) const
- int track_get_key_count ( int idx ) const
- void track_get_key_value ( int idx, int key_idx ) const
- real track_get_key_time ( int idx, int key_idx ) const
- int track_find_key ( int idx, real time, bool exact=false ) const
- void track_set_interpolation_type ( int idx, int interpolation )
- int track_get_interpolation_type ( int idx ) const
- Array transform_track_interpolate ( int idx, real time_sec ) const
- void value_track_set_continuous ( int idx, bool continuous )
- bool value_track_is_continuous ( int idx ) const
- IntArray value_track_get_key_indices ( int idx, real time_sec, real delta ) const
- IntArray method_track_get_key_indices ( int idx, real time_sec, real delta ) const
- String method_track_get_name ( int idx, int key_idx ) const
- Array method_track_get_params ( int idx, int key_idx ) const
- void set_length ( real time_sec )
- real get_length ( ) const
- void set_loop ( bool enabled )
- bool has_loop ( ) const
- void set_step ( real size_sec )
- real get_step ( ) const
- void clear ( )
- TYPE_VALUE = 0 - Value tracks set values in node properties, but only those which can be Interpolated.
- TYPE_TRANSFORM = 1 - Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are Interpolated.
- TYPE_METHOD = 2 - Method tracks call functions with given arguments per key.
- INTERPOLATION_NEAREST = 0 - No interpolation (nearest value).
- INTERPOLATION_LINEAR = 1 - Linear interpolation.
- INTERPOLATION_CUBIC = 2 - Cubic interpolation.
An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track. \ Animations are just data containers, and must be added to odes such as an animationplayer or animationtreeplayer to be played back.
- int add_track ( int type, int at_pos=-1 ) \ Add a track to the Animation. The track type must be specified as any of the values in te TYPE_* enumeration.
- void remove_track ( int idx ) \ Remove a track by specifying the track index.
- int get_track_count ( ) const \ Return the amount of tracks in the animation.
- int track_get_type ( int idx ) const \ Get the type of a track.
- NodePath track_get_path ( int idx ) const \ Get the path of a track. for more information on the path format, see #track_set_path
- void track_set_path ( int idx, NodePath path ) \ Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local"
- void track_move_up ( int idx ) \ Move a track up.
- void track_move_down ( int idx ) \ Nove a track down.
- int transform_track_insert_key ( int idx, real time, Vector3 loc, Quat rot, Vector3 scale ) \ Insert a transform key for a transform track.
- void track_insert_key ( int idx, real time, var key, real transition=1 ) \ Insert a generic key in a given track.
- void track_remove_key ( int idx, int key_idx ) \ Remove a key by index in a given track.
- void track_remove_key_at_pos ( int idx, real pos ) \ Remove a key by position (seconds) in a given track.
- void track_set_key_value ( int idx, int key, var value ) \ Set the value of an existing key.
- void track_set_key_transition ( int idx, int key_idx, real transition ) \ Set the transition curve (easing) for a specific key (see built-in math function "ease").
- real track_get_key_transition ( int idx, int key_idx ) const \ Return the transition curve (easing) for a specific key (see built-in math function "ease").
- int track_get_key_count ( int idx ) const \ Return the amount of keys in a given track.
- void track_get_key_value ( int idx, int key_idx ) const \ Return the value of a given key in a given track.
- real track_get_key_time ( int idx, int key_idx ) const \ Return the time at which the key is located.
- int track_find_key ( int idx, real time, bool exact=false ) const \ Find the key index by time in a given track. Optionally, only find it if the exact time is given.
- void track_set_interpolation_type ( int idx, int interpolation ) \ Set the interpolation type of a given track, from the INTERPOLATION_* enum.
- int track_get_interpolation_type ( int idx ) const \ Return the interpolation type of a given track, from the INTERPOLATION_* enum.
- Array transform_track_interpolate ( int idx, real time_sec ) const \ Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (vector3), rotation (quat) and scale (vector3).
- void value_track_set_continuous ( int idx, bool continuous ) \ Enable or disable interpolation for a whole track. By default tracks are interpolated.
- bool value_track_is_continuous ( int idx ) const \ Return wether interpolation is enabled or disabled for a whole track. By default tracks are interpolated.
- IntArray value_track_get_key_indices ( int idx, real time_sec, real delta ) const \ Return all the key indices of a value track, given a position and delta time.
- IntArray method_track_get_key_indices ( int idx, real time_sec, real delta ) const \ Return all the key indices of a method track, given a position and delta time.
- String method_track_get_name ( int idx, int key_idx ) const \ Return the method name of a method track.
- Array method_track_get_params ( int idx, int key_idx ) const \ Return the arguments values to be called on a method track for a given key in a given track.
- void set_length ( real time_sec ) \ Set the total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
- real get_length ( ) const \ Return the total length of the animation (in seconds).
- void set_loop ( bool enabled ) \ Set a flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
- void clear ( ) \ Clear the animation (clear all tracks and reset all).