Struct gdnative::api::Curve

pub struct Curve { /* fields omitted */ }

core class Curve 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

Curve 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 Curve

Constants

pub const TANGENT_FREE: i64

pub const TANGENT_LINEAR: i64

pub const TANGENT_MODE_COUNT: i64

impl Curve

pub fn new() -> Ref<Curve, 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_point(
    &self,
    position: Vector2D<f32, UnknownUnit>,
    left_tangent: f64,
    right_tangent: f64,
    left_mode: i64,
    right_mode: i64
) -> i64

Adds a point to the curve. For each side, if the [code]*_mode[/code] is [constant TANGENT_LINEAR], the [code]*_tangent[/code] angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the [code]*_tangent[/code] angle if [code]*_mode[/code] is set to [constant TANGENT_FREE].

Default Arguments

• left_tangent - 0
• right_tangent - 0
• left_mode - 0
• right_mode - 0

pub fn bake(&self)

Recomputes the baked cache of points for the curve.

pub fn clean_dupes(&self)

Removes points that are closer than [code]CMP_EPSILON[/code] (0.00001) units to their neighbor on the curve.

pub fn clear_points(&self)

Removes all points from the curve.

pub fn bake_resolution(&self) -> i64

The number of points to include in the baked (i.e. cached) curve data.

pub fn max_value(&self) -> f64

The maximum value the curve can reach.

pub fn min_value(&self) -> f64

The minimum value the curve can reach.

pub fn get_point_count(&self) -> i64

Returns the number of points describing the curve.

pub fn get_point_left_mode(&self, index: i64) -> TangentMode

Returns the left [enum TangentMode] for the point at [code]index[/code].

pub fn get_point_left_tangent(&self, index: i64) -> f64

Returns the left tangent angle (in degrees) for the point at [code]index[/code].

pub fn get_point_position(&self, index: i64) -> Vector2D<f32, UnknownUnit>

Returns the curve coordinates for the point at [code]index[/code].

pub fn get_point_right_mode(&self, index: i64) -> TangentMode

Returns the right [enum TangentMode] for the point at [code]index[/code].

pub fn get_point_right_tangent(&self, index: i64) -> f64

Returns the right tangent angle (in degrees) for the point at [code]index[/code].

pub fn interpolate(&self, offset: f64) -> f64

Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve.

pub fn interpolate_baked(&self, offset: f64) -> f64

Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve using the baked cache. Bakes the curve's points if not already baked.

pub fn remove_point(&self, index: i64)

Removes the point at [code]index[/code] from the curve.

pub fn set_bake_resolution(&self, resolution: i64)

The number of points to include in the baked (i.e. cached) curve data.

pub fn set_max_value(&self, max: f64)

The maximum value the curve can reach.

pub fn set_min_value(&self, min: f64)

The minimum value the curve can reach.

pub fn set_point_left_mode(&self, index: i64, mode: i64)

Sets the left [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code].

pub fn set_point_left_tangent(&self, index: i64, tangent: f64)

Sets the left tangent angle for the point at [code]index[/code] to [code]tangent[/code].

pub fn set_point_offset(&self, index: i64, offset: f64) -> i64

Sets the offset from [code]0.5[/code].

pub fn set_point_right_mode(&self, index: i64, mode: i64)

Sets the right [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code].

pub fn set_point_right_tangent(&self, index: i64, tangent: f64)

Sets the right tangent angle for the point at [code]index[/code] to [code]tangent[/code].

pub fn set_point_value(&self, index: i64, y: f64)

Assigns the vertical position [code]y[/code] to the point at [code]index[/code].

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 Curve

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

Formats the value using the given formatter.

impl Deref for Curve

type Target = Resource

The resulting type after dereferencing.

fn deref(&self) -> &Resource

Dereferences the value.

impl DerefMut for Curve

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

Mutably dereferences the value.

impl GodotObject for Curve

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 Curve

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

impl SubClass<Object> for Curve

impl SubClass<Reference> for Curve

impl SubClass<Resource> for Curve