Struct gdnative::api::Animation

pub struct Animation { /* fields omitted */ }

core class Animation inherits Resource (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

Animation inherits methods from:

• Resource
• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl Animation

Constants

pub const INTERPOLATION_CUBIC: i64

pub const INTERPOLATION_LINEAR: i64

pub const INTERPOLATION_NEAREST: i64

pub const TYPE_ANIMATION: i64

pub const TYPE_AUDIO: i64

pub const TYPE_BEZIER: i64

pub const TYPE_METHOD: i64

pub const TYPE_TRANSFORM: i64

pub const TYPE_VALUE: i64

pub const UPDATE_CAPTURE: i64

pub const UPDATE_CONTINUOUS: i64

pub const UPDATE_DISCRETE: i64

pub const UPDATE_TRIGGER: i64

impl Animation

pub fn new() -> Ref<Animation, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn add_track(&self, _type: i64, at_position: i64) -> i64

Adds a track to the Animation.

Default Arguments

• at_position - -1

pub fn animation_track_get_key_animation(
    &self,
    track_idx: i64,
    key_idx: i64
) -> GodotString

Returns the animation name at the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Animation Track.

pub fn animation_track_insert_key(
    &self,
    track_idx: i64,
    time: f64,
    animation: impl Into<GodotString>
) -> i64

Inserts a key with value [code]animation[/code] at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of an Animation Track.

pub fn animation_track_set_key_animation(
    &self,
    track_idx: i64,
    key_idx: i64,
    animation: impl Into<GodotString>
)

Sets the key identified by [code]key_idx[/code] to value [code]animation[/code]. The [code]track_idx[/code] must be the index of an Animation Track.

pub fn audio_track_get_key_end_offset(
    &self,
    track_idx: i64,
    key_idx: i64
) -> f64

Returns the end offset of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track.
				End offset is the number of seconds cut off at the ending of the audio stream.

pub fn audio_track_get_key_start_offset(
    &self,
    track_idx: i64,
    key_idx: i64
) -> f64

Returns the start offset of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track.
				Start offset is the number of seconds cut off at the beginning of the audio stream.

pub fn audio_track_get_key_stream(
    &self,
    track_idx: i64,
    key_idx: i64
) -> Option<Ref<Resource, Shared>>

Returns the audio stream of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track.

pub fn audio_track_insert_key(
    &self,
    track_idx: i64,
    time: f64,
    stream: impl AsArg<Resource>,
    start_offset: f64,
    end_offset: f64
) -> i64

Inserts an Audio Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of an Audio Track.
				[code]stream[/code] is the [AudioStream] resource to play. [code]start_offset[/code] is the number of seconds cut off at the beginning of the audio stream, while [code]end_offset[/code] is at the ending.

Default Arguments

• start_offset - 0
• end_offset - 0

pub fn audio_track_set_key_end_offset(
    &self,
    track_idx: i64,
    key_idx: i64,
    offset: f64
)

Sets the end offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track.

pub fn audio_track_set_key_start_offset(
    &self,
    track_idx: i64,
    key_idx: i64,
    offset: f64
)

Sets the start offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track.

pub fn audio_track_set_key_stream(
    &self,
    track_idx: i64,
    key_idx: i64,
    stream: impl AsArg<Resource>
)

Sets the stream of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track.

pub fn bezier_track_get_key_in_handle(
    &self,
    track_idx: i64,
    key_idx: i64
) -> Vector2D<f32, UnknownUnit>

Returns the in handle of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track.

pub fn bezier_track_get_key_out_handle(
    &self,
    track_idx: i64,
    key_idx: i64
) -> Vector2D<f32, UnknownUnit>

Returns the out handle of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track.

pub fn bezier_track_get_key_value(&self, track_idx: i64, key_idx: i64) -> f64

Returns the value of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track.

pub fn bezier_track_insert_key(
    &self,
    track_idx: i64,
    time: f64,
    value: f64,
    in_handle: Vector2D<f32, UnknownUnit>,
    out_handle: Vector2D<f32, UnknownUnit>
) -> i64

Inserts a Bezier Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of a Bezier Track.
				[code]in_handle[/code] is the left-side weight of the added Bezier curve point, [code]out_handle[/code] is the right-side one, while [code]value[/code] is the actual value at this point.

Default Arguments

• in_handle - Vector2( 0, 0 )
• out_handle - Vector2( 0, 0 )

pub fn bezier_track_interpolate(&self, track_idx: i64, time: f64) -> f64

Returns the interpolated value at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of a Bezier Track.

pub fn bezier_track_set_key_in_handle(
    &self,
    track_idx: i64,
    key_idx: i64,
    in_handle: Vector2D<f32, UnknownUnit>
)

Sets the in handle of the key identified by [code]key_idx[/code] to value [code]in_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track.

pub fn bezier_track_set_key_out_handle(
    &self,
    track_idx: i64,
    key_idx: i64,
    out_handle: Vector2D<f32, UnknownUnit>
)

Sets the out handle of the key identified by [code]key_idx[/code] to value [code]out_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track.

pub fn bezier_track_set_key_value(
    &self,
    track_idx: i64,
    key_idx: i64,
    value: f64
)

Sets the value of the key identified by [code]key_idx[/code] to the given value. The [code]track_idx[/code] must be the index of a Bezier Track.

pub fn clear(&self)

Clear the animation (clear all tracks and reset all).

pub fn copy_track(&self, track_idx: i64, to_animation: impl AsArg<Animation>)

Adds a new track that is a copy of the given track from [code]to_animation[/code].

pub fn find_track(&self, path: impl Into<NodePath>) -> i64

Returns the index of the specified track. If the track is not found, return -1.

pub fn length(&self) -> f64

The total length of the animation (in seconds).
			[b]Note:[/b] Length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.

pub fn step(&self) -> f64

The animation step value.

pub fn get_track_count(&self) -> i64

Returns the amount of tracks in the animation.

pub fn has_loop(&self) -> bool

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.

pub fn method_track_get_key_indices(
    &self,
    track_idx: i64,
    time_sec: f64,
    delta: f64
) -> TypedArray<i32>

Returns all the key indices of a method track, given a position and delta time.

pub fn method_track_get_name(&self, track_idx: i64, key_idx: i64) -> GodotString

Returns the method name of a method track.

pub fn method_track_get_params(
    &self,
    track_idx: i64,
    key_idx: i64
) -> VariantArray<Shared>

Returns the arguments values to be called on a method track for a given key in a given track.

pub fn remove_track(&self, track_idx: i64)

Removes a track by specifying the track index.

pub fn set_length(&self, time_sec: f64)

The total length of the animation (in seconds).
			[b]Note:[/b] Length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.

pub fn set_loop(&self, enabled: bool)

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.

pub fn set_step(&self, size_sec: f64)

The animation step value.

pub fn track_find_key(&self, track_idx: i64, time: f64, exact: bool) -> i64

Finds the key index by time in a given track. Optionally, only find it if the exact time is given.

Default Arguments

• exact - false

pub fn track_get_interpolation_loop_wrap(&self, track_idx: i64) -> bool

Returns [code]true[/code] if the track at [code]idx[/code] wraps the interpolation loop. New tracks wrap the interpolation loop by default.

pub fn track_get_interpolation_type(&self, track_idx: i64) -> InterpolationType

Returns the interpolation type of a given track.

pub fn track_get_key_count(&self, track_idx: i64) -> i64

Returns the amount of keys in a given track.

pub fn track_get_key_time(&self, track_idx: i64, key_idx: i64) -> f64

Returns the time at which the key is located.

pub fn track_get_key_transition(&self, track_idx: i64, key_idx: i64) -> f64

Returns the transition curve (easing) for a specific key (see the built-in math function [method @GDScript.ease]).

pub fn track_get_key_value(&self, track_idx: i64, key_idx: i64) -> Variant

Returns the value of a given key in a given track.

pub fn track_get_path(&self, track_idx: i64) -> NodePath

Gets the path of a track. For more information on the path format, see [method track_set_path].

pub fn track_get_type(&self, track_idx: i64) -> TrackType

Gets the type of a track.

pub fn track_insert_key(
    &self,
    track_idx: i64,
    time: f64,
    key: impl OwnedToVariant,
    transition: f64
)

Insert a generic key in a given track.

Default Arguments

• transition - 1

pub fn track_is_enabled(&self, track_idx: i64) -> bool

Returns [code]true[/code] if the track at index [code]idx[/code] is enabled.

pub fn track_is_imported(&self, track_idx: i64) -> bool

Returns [code]true[/code] if the given track is imported. Else, return [code]false[/code].

pub fn track_move_down(&self, track_idx: i64)

Moves a track down.

pub fn track_move_to(&self, track_idx: i64, to_idx: i64)

Changes the index position of track [code]idx[/code] to the one defined in [code]to_idx[/code].

pub fn track_move_up(&self, track_idx: i64)

Moves a track up.

pub fn track_remove_key(&self, track_idx: i64, key_idx: i64)

Removes a key by index in a given track.

pub fn track_remove_key_at_position(&self, track_idx: i64, position: f64)

Removes a key by position (seconds) in a given track.

pub fn track_set_enabled(&self, track_idx: i64, enabled: bool)

Enables/disables the given track. Tracks are enabled by default.

pub fn track_set_imported(&self, track_idx: i64, imported: bool)

Sets the given track as imported or not.

pub fn track_set_interpolation_loop_wrap(
    &self,
    track_idx: i64,
    interpolation: bool
)

If [code]true[/code], the track at [code]idx[/code] wraps the interpolation loop.

pub fn track_set_interpolation_type(&self, track_idx: i64, interpolation: i64)

Sets the interpolation type of a given track.

pub fn track_set_key_time(&self, track_idx: i64, key_idx: i64, time: f64)

Sets the time of an existing key.

pub fn track_set_key_transition(
    &self,
    track_idx: i64,
    key_idx: i64,
    transition: f64
)

Sets the transition curve (easing) for a specific key (see the built-in math function [method @GDScript.ease]).

pub fn track_set_key_value(
    &self,
    track_idx: i64,
    key: i64,
    value: impl OwnedToVariant
)

Sets the value of an existing key.

pub fn track_set_path(&self, track_idx: i64, path: impl Into<NodePath>)

Sets 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 [code]":"[/code].
				For example, [code]"character/skeleton:ankle"[/code] or [code]"character/mesh:transform/local"[/code].

pub fn track_swap(&self, track_idx: i64, with_idx: i64)

Swaps the track [code]idx[/code]'s index position with the track [code]with_idx[/code].

pub fn transform_track_insert_key(
    &self,
    track_idx: i64,
    time: f64,
    location: Vector3D<f32, UnknownUnit>,
    rotation: Rotation3D<f32, UnknownUnit, UnknownUnit>,
    scale: Vector3D<f32, UnknownUnit>
) -> i64

Insert a transform key for a transform track.

pub fn transform_track_interpolate(
    &self,
    track_idx: i64,
    time_sec: f64
) -> VariantArray<Shared>

Returns 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]).

pub fn value_track_get_key_indices(
    &self,
    track_idx: i64,
    time_sec: f64,
    delta: f64
) -> TypedArray<i32>

Returns all the key indices of a value track, given a position and delta time.

pub fn value_track_get_update_mode(&self, track_idx: i64) -> UpdateMode

Returns the update mode of a value track.

pub fn value_track_set_update_mode(&self, track_idx: i64, mode: i64)

Sets the update mode (see [enum UpdateMode]) of a value track.

Methods from Deref<Target = Resource>

pub fn duplicate(&self, subresources: bool) -> Option<Ref<Resource, Shared>>

Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing [code]true[/code] to the [code]subresources[/code] argument which will copy the subresources.
				[b]Note:[/b] If [code]subresources[/code] is [code]true[/code], this method will only perform a shallow copy. Nested resources within subresources will not be duplicated and will still be shared.

Default Arguments

• subresources - false

pub fn get_local_scene(&self) -> Option<Ref<Node, Shared>>

If [member resource_local_to_scene] is enabled and the resource was loaded from a [PackedScene] instantiation, returns the local scene where this resource's unique copy is in use. Otherwise, returns [code]null[/code].

pub fn name(&self) -> GodotString

The name of the resource. This is an optional identifier.

pub fn path(&self) -> GodotString

The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index.

pub fn get_rid(&self) -> Rid

Returns the RID of the resource (or an empty RID). Many resources (such as [Texture], [Mesh], etc) are high-level abstractions of resources stored in a server, so this function will return the original RID.

pub fn is_local_to_scene(&self) -> bool

If [code]true[/code], the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.

pub fn set_local_to_scene(&self, enable: bool)

If [code]true[/code], the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.

pub fn set_name(&self, name: impl Into<GodotString>)

The name of the resource. This is an optional identifier.

pub fn set_path(&self, path: impl Into<GodotString>)

The path to the resource. In case it has its own file, it will return its filepath. If it's tied to the scene, it will return the scene's path, followed by the resource's index.

pub fn setup_local_to_scene(&self)

This method is called when a resource with [member resource_local_to_scene] enabled is loaded from a [PackedScene] instantiation. Its behavior can be customized by overriding [method _setup_local_to_scene] from script.
				For most resources, this method performs no base logic. [ViewportTexture] performs custom logic to properly set the proxy texture and flags in the local viewport.

pub fn take_over_path(&self, path: impl Into<GodotString>)

Sets the path of the resource, potentially overriding an existing cache entry for this path. This differs from setting [member resource_path], as the latter would error out if another resource was already cached for the given path.

Trait Implementations

impl Debug for Animation

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for Animation

type Target = Resource

The resulting type after dereferencing.

fn deref(&self) -> &Resource

Dereferences the value.

impl DerefMut for Animation

fn deref_mut(&mut self) -> &mut Resource

Mutably dereferences the value.

impl GodotObject for Animation

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for Animation

fn construct() -> Ref<Animation, Unique>

impl SubClass<Object> for Animation

impl SubClass<Reference> for Animation

impl SubClass<Resource> for Animation