Struct gdnative::api::DampedSpringJoint2D

pub struct DampedSpringJoint2D { /* fields omitted */ }

core class DampedSpringJoint2D inherits Joint2D (unsafe).

Official documentation

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

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

DampedSpringJoint2D is a reference-only type. Persistent references can only exist in the unsafe Ref<DampedSpringJoint2D> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

DampedSpringJoint2D inherits methods from:

• Joint2D
• Node2D
• CanvasItem
• Node
• 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 DampedSpringJoint2D

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

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn damping(&self) -> f64

The spring joint's damping ratio. A value between [code]0[/code] and [code]1[/code]. When the two bodies move into different directions the system tries to align them to the spring axis again. A high [code]damping[/code] value forces the attached bodies to align faster.

pub fn length(&self) -> f64

The spring joint's maximum length. The two attached bodies cannot stretch it past this value.

pub fn rest_length(&self) -> f64

When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length.

pub fn stiffness(&self) -> f64

The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length.

pub fn set_damping(&self, damping: f64)

The spring joint's damping ratio. A value between [code]0[/code] and [code]1[/code]. When the two bodies move into different directions the system tries to align them to the spring axis again. A high [code]damping[/code] value forces the attached bodies to align faster.

pub fn set_length(&self, length: f64)

The spring joint's maximum length. The two attached bodies cannot stretch it past this value.

pub fn set_rest_length(&self, rest_length: f64)

When the bodies attached to the spring joint move they stretch or squash it. The joint always tries to resize towards this length.

pub fn set_stiffness(&self, stiffness: f64)

The higher the value, the less the bodies attached to the joint will deform it. The joint applies an opposing force to the bodies, the product of the stiffness multiplied by the size difference from its resting length.

Methods from Deref<Target = Joint2D>

pub fn bias(&self) -> f64

When [member node_a] and [member node_b] move in different directions the [code]bias[/code] controls how fast the joint pulls them back to their original position. The lower the [code]bias[/code] the more the two bodies can pull on the joint.

pub fn exclude_nodes_from_collision(&self) -> bool

If [code]true[/code], [member node_a] and [member node_b] can not collide.

pub fn node_a(&self) -> NodePath

The first body attached to the joint. Must derive from [PhysicsBody2D].

pub fn node_b(&self) -> NodePath

The second body attached to the joint. Must derive from [PhysicsBody2D].

pub fn set_bias(&self, bias: f64)

When [member node_a] and [member node_b] move in different directions the [code]bias[/code] controls how fast the joint pulls them back to their original position. The lower the [code]bias[/code] the more the two bodies can pull on the joint.

pub fn set_exclude_nodes_from_collision(&self, enable: bool)

If [code]true[/code], [member node_a] and [member node_b] can not collide.

pub fn set_node_a(&self, node: impl Into<NodePath>)

The first body attached to the joint. Must derive from [PhysicsBody2D].

pub fn set_node_b(&self, node: impl Into<NodePath>)

The second body attached to the joint. Must derive from [PhysicsBody2D].

Trait Implementations

impl Debug for DampedSpringJoint2D

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

Formats the value using the given formatter.

impl Deref for DampedSpringJoint2D

type Target = Joint2D

The resulting type after dereferencing.

fn deref(&self) -> &Joint2D

Dereferences the value.

impl DerefMut for DampedSpringJoint2D

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

Mutably dereferences the value.

impl GodotObject for DampedSpringJoint2D

type RefKind = ManuallyManaged

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 DampedSpringJoint2D

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

impl QueueFree for DampedSpringJoint2D

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for DampedSpringJoint2D

impl SubClass<Joint2D> for DampedSpringJoint2D

impl SubClass<Node> for DampedSpringJoint2D

impl SubClass<Node2D> for DampedSpringJoint2D

impl SubClass<Object> for DampedSpringJoint2D