Skip to content

class_animation

Jump to bottom Edit New page
reduz edited this page Feb 23, 2014 · 10 revisions

Animation

Inherits: resource\ Category: Core\

Brief Description

Contains data used to animate everything in the engine.

Member Functions

Numeric Constants

  • 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.

Description

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.

Member Function Description

== add_track ==

  • 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. == remove_track ==
  • void #remove_track( int idx ) \ Remove a track by specifying the track index. == get_track_count ==
  • int #get_track_count(****) const \ Return the amount of tracks in the animation. == track_get_type ==
  • int #track_get_type( int idx ) const \ Get the type of a track. == track_get_path ==
  • NodePath #track_get_path( int idx ) const \ Get the path of a track. for more information on the path format, see #track_set_path == 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" == track_move_up ==
  • void #track_move_up( int idx ) \ Move a track up. == track_move_down ==
  • void #track_move_down( int idx ) \ Nove a track down. == transform_track_insert_key ==
  • int #transform_track_insert_key( int idx, real time, Vector3 loc, Quat rot, Vector3 scale ) \ Insert a transform key for a transform track. == track_insert_key ==
  • void #track_insert_key( int idx, real time, var key, real transition=1 ) \ Insert a generic key in a given track. == track_remove_key ==
  • void #track_remove_key( int idx, int key_idx ) \ Remove a key by index in a given track. == track_remove_key_at_pos ==
  • void #track_remove_key_at_pos( int idx, real pos ) \ Remove a key by position (seconds) in a given track. == track_set_key_value ==
  • void #track_set_key_value( int idx, int key, var value ) \ Set the value of an existing key. == track_set_key_transition ==
  • 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"). == track_get_key_transition ==
  • 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"). == track_get_key_count ==
  • int #track_get_key_count( int idx ) const \ Return the amount of keys in a given track. == track_get_key_value ==
  • void #track_get_key_value( int idx, int key_idx ) const \ Return the value of a given key in a given track. == track_get_key_time ==
  • real #track_get_key_time( int idx, int key_idx ) const \ Return the time at which the key is located. == track_find_key ==
  • 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. == track_set_interpolation_type ==
  • void #track_set_interpolation_type( int idx, int interpolation ) \ Set the interpolation type of a given track, from the INTERPOLATION_* enum. == track_get_interpolation_type ==
  • int #track_get_interpolation_type( int idx ) const \ Return the interpolation type of a given track, from the INTERPOLATION_* enum. == transform_track_interpolate ==
  • 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). == value_track_set_continuous ==
  • void #value_track_set_continuous( int idx, bool continuous ) \ Enable or disable interpolation for a whole track. By default tracks are interpolated. == value_track_is_continuous ==
  • bool #value_track_is_continuous( int idx ) const \ Return wether interpolation is enabled or disabled for a whole track. By default tracks are interpolated. == value_track_get_key_indices ==
  • 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. == method_track_get_key_indices ==
  • 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. == method_track_get_name ==
  • String #method_track_get_name( int idx, int key_idx ) const \ Return the method name of a method track. == method_track_get_params ==
  • 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. == set_length ==
  • 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. == get_length ==
  • real #get_length(****) const \ Return the total length of the animation (in seconds). == set_loop ==
  • 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. == has_loop ==
  • bool #has_loop(****) const \ Return wether the animation has the loop flag set. == clear ==
  • void #clear(****) \ Clear the animation (clear all tracks and reset all).
Add a custom footer
Add a custom sidebar
Clone this wiki locally