Struct Animation

pub struct Animation { /* private fields */ }

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.

Feature flag

This type is behind the gdnative crate’s animation feature flag.

Class hierarchy

Animation inherits methods from:

• Resource
• Reference
• Object

Implementations

impl Animation

pub fn new() -> Self

pub fn new_ref(&self) -> Self

Creates a new reference to the same reference-counted object.

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

pub fn remove_track(&mut self, idx: i64)

pub fn get_track_count(&self) -> i64

pub fn track_get_type(&self, idx: i64) -> AnimationTrackType

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

pub fn track_set_path(&mut self, idx: i64, path: NodePath)

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

pub fn track_move_up(&mut self, idx: i64)

pub fn track_move_down(&mut self, idx: i64)

pub fn track_swap(&mut self, idx: i64, with_idx: i64)

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

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

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

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

pub fn transform_track_insert_key( &mut self, idx: i64, time: f64, location: Vector3, rotation: Quat, scale: Vector3, ) -> i64

pub fn track_insert_key( &mut self, idx: i64, time: f64, key: Variant, transition: f64, )

pub fn track_remove_key(&mut self, idx: i64, key_idx: i64)

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

pub fn track_set_key_value(&mut self, idx: i64, key: i64, value: Variant)

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

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

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

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

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

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

pub fn track_set_interpolation_type(&mut self, idx: i64, interpolation: i64)

pub fn track_get_interpolation_type( &self, idx: i64, ) -> AnimationInterpolationType

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

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

pub fn transform_track_interpolate( &self, idx: i64, time_sec: f64, ) -> VariantArray

pub fn value_track_set_update_mode(&mut self, idx: i64, mode: i64)

pub fn value_track_get_update_mode(&self, idx: i64) -> AnimationUpdateMode

pub fn value_track_get_key_indices( &self, idx: i64, time_sec: f64, delta: f64, ) -> Int32Array

pub fn method_track_get_key_indices( &self, idx: i64, time_sec: f64, delta: f64, ) -> Int32Array

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

pub fn method_track_get_params(&self, idx: i64, key_idx: i64) -> VariantArray

pub fn bezier_track_insert_key( &mut self, track: i64, time: f64, value: f64, in_handle: Vector2, out_handle: Vector2, ) -> i64

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

pub fn bezier_track_set_key_in_handle( &mut self, idx: i64, key_idx: i64, in_handle: Vector2, )

pub fn bezier_track_set_key_out_handle( &mut self, idx: i64, key_idx: i64, out_handle: Vector2, )

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

pub fn bezier_track_get_key_in_handle(&self, idx: i64, key_idx: i64) -> Vector2

pub fn bezier_track_get_key_out_handle(&self, idx: i64, key_idx: i64) -> Vector2

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

pub fn audio_track_insert_key( &mut self, track: i64, time: f64, stream: Option<Resource>, start_offset: f64, end_offset: f64, ) -> i64

pub fn audio_track_set_key_stream( &mut self, idx: i64, key_idx: i64, stream: Option<Resource>, )

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

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

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

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

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

pub fn animation_track_insert_key( &mut self, track: i64, time: f64, animation: GodotString, ) -> i64

pub fn animation_track_set_key_animation( &mut self, idx: i64, key_idx: i64, animation: GodotString, )

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

pub fn set_length(&mut self, time_sec: f64)

pub fn get_length(&self) -> f64

pub fn set_loop(&mut self, enabled: bool)

pub fn has_loop(&self) -> bool

pub fn set_step(&mut self, size_sec: f64)

pub fn get_step(&self) -> f64

pub fn clear(&mut self)

pub fn copy_track(&mut self, track: i64, to_animation: Option<Animation>)

pub fn _setup_local_to_scene(&mut self)

Inherited from Resource.

pub fn set_path(&mut self, path: GodotString)

Inherited from Resource.

pub fn take_over_path(&mut self, path: GodotString)

Inherited from Resource.

pub fn get_path(&self) -> GodotString

Inherited from Resource.

pub fn set_name(&mut self, name: GodotString)

Inherited from Resource.

pub fn get_name(&self) -> GodotString

Inherited from Resource.

pub fn get_rid(&self) -> Rid

Inherited from Resource.

pub fn set_local_to_scene(&mut self, enable: bool)

Inherited from Resource.

pub fn is_local_to_scene(&self) -> bool

Inherited from Resource.

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

Inherited from Resource.

pub fn setup_local_to_scene(&mut self)

Inherited from Resource.

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

Inherited from Resource.

pub fn init_ref(&mut self) -> bool

Inherited from Reference.

pub fn _notification(&mut self, what: i64)

Inherited from Object.

pub fn _set(&mut self, property: GodotString, value: Variant) -> bool

Inherited from Object.

pub fn _get(&mut self, property: GodotString) -> Variant

Inherited from Object.

pub fn _get_property_list(&mut self) -> VariantArray

Inherited from Object.

pub fn _init(&mut self)

Inherited from Object.

pub fn get_class(&self) -> GodotString

Inherited from Object.

pub fn is_class(&self, _type: GodotString) -> bool

Inherited from Object.

pub fn set(&mut self, property: GodotString, value: Variant)

Inherited from Object.

pub fn get(&self, property: GodotString) -> Variant

Inherited from Object.

pub fn set_indexed(&mut self, property: NodePath, value: Variant)

Inherited from Object.

pub fn get_indexed(&self, property: NodePath) -> Variant

Inherited from Object.

pub fn get_property_list(&self) -> VariantArray

Inherited from Object.

pub fn get_method_list(&self) -> VariantArray

Inherited from Object.

pub fn notification(&mut self, what: i64, reversed: bool)

Inherited from Object.

pub fn get_instance_id(&self) -> i64

Inherited from Object.

pub fn set_script(&mut self, script: Option<Reference>)

Inherited from Object.

pub fn get_script(&self) -> Option<Reference>

Inherited from Object.

pub fn set_meta(&mut self, name: GodotString, value: Variant)

Inherited from Object.

pub fn get_meta(&self, name: GodotString) -> Variant

Inherited from Object.

pub fn has_meta(&self, name: GodotString) -> bool

Inherited from Object.

pub fn get_meta_list(&self) -> StringArray

Inherited from Object.

pub fn add_user_signal(&mut self, signal: GodotString, arguments: VariantArray)

Inherited from Object.

pub fn has_user_signal(&self, signal: GodotString) -> bool

Inherited from Object.

pub fn emit_signal( &mut self, signal: GodotString, varargs: &[Variant], ) -> Variant

Inherited from Object.

pub fn call(&mut self, method: GodotString, varargs: &[Variant]) -> Variant

Inherited from Object.

pub fn call_deferred( &mut self, method: GodotString, varargs: &[Variant], ) -> Variant

Inherited from Object.

pub fn callv(&mut self, method: GodotString, arg_array: VariantArray) -> Variant

Inherited from Object.

pub fn has_method(&self, method: GodotString) -> bool

Inherited from Object.

pub fn get_signal_list(&self) -> VariantArray

Inherited from Object.

pub fn get_signal_connection_list(&self, signal: GodotString) -> VariantArray

Inherited from Object.

pub fn get_incoming_connections(&self) -> VariantArray

Inherited from Object.

pub fn connect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, binds: VariantArray, flags: i64, ) -> GodotResult

Inherited from Object.

pub fn disconnect( &mut self, signal: GodotString, target: Option<Object>, method: GodotString, )

Inherited from Object.

pub fn is_connected( &self, signal: GodotString, target: Option<Object>, method: GodotString, ) -> bool

Inherited from Object.

pub fn set_block_signals(&mut self, enable: bool)

Inherited from Object.

pub fn is_blocking_signals(&self) -> bool

Inherited from Object.

pub fn property_list_changed_notify(&mut self)

Inherited from Object.

pub fn set_message_translation(&mut self, enable: bool)

Inherited from Object.

pub fn can_translate_messages(&self) -> bool

Inherited from Object.

pub fn tr(&self, message: GodotString) -> GodotString

Inherited from Object.

pub fn is_queued_for_deletion(&self) -> bool

Inherited from Object.

pub fn to_resource(&self) -> Resource

Up-cast.

pub fn to_reference(&self) -> Reference

Up-cast.

pub fn to_object(&self) -> Object

Up-cast.

pub fn cast<T: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Debug for Animation

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

Formats the value using the given formatter.

impl Drop for Animation

fn drop(&mut self)

Executes the destructor for this type.

impl GodotObject for Animation

fn class_name() -> &'static str

impl ToVariant for Animation

fn to_variant(&self) -> Variant

fn from_variant(variant: &Variant) -> Option<Self>