Struct gdnative::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 an unsafe pointer, and all of its methods are unsafe.

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 DampedSpringJoint2D::free.

Class hierarchy

DampedSpringJoint2D inherits methods from:

• Joint2D
• Node2D
• CanvasItem
• Node
• Object

Methods

impl DampedSpringJoint2D

pub fn new() -> DampedSpringJoint2D

Constructor.

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 DampedSpringJoint2D::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn get_damping(&self) -> f64

pub unsafe fn get_length(&self) -> f64

pub unsafe fn get_rest_length(&self) -> f64

pub unsafe fn get_stiffness(&self) -> f64

pub unsafe fn set_damping(&mut self, damping: f64)

pub unsafe fn set_length(&mut self, length: f64)

pub unsafe fn set_rest_length(&mut self, rest_length: f64)

pub unsafe fn set_stiffness(&mut self, stiffness: f64)

pub unsafe fn to_joint_2d(&self) -> Joint2D

Up-cast.

pub unsafe fn to_node_2d(&self) -> Node2D

Up-cast.

pub unsafe fn to_canvas_item(&self) -> CanvasItem

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Methods from Deref<Target = Joint2D>

pub unsafe fn get_bias(&self) -> f64

pub unsafe fn get_exclude_nodes_from_collision(&self) -> bool

pub unsafe fn get_node_a(&self) -> NodePath

pub unsafe fn get_node_b(&self) -> NodePath

pub unsafe fn set_bias(&mut self, bias: f64)

pub unsafe fn set_exclude_nodes_from_collision(&mut self, enable: bool)

pub unsafe fn set_node_a(&mut self, node: NodePath)

pub unsafe fn set_node_b(&mut self, node: NodePath)

pub unsafe fn to_node_2d(&self) -> Node2D

Up-cast.

pub unsafe fn to_canvas_item(&self) -> CanvasItem

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Trait Implementations

impl Clone for DampedSpringJoint2D

fn clone(&self) -> DampedSpringJoint2D

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for DampedSpringJoint2D

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 Free for DampedSpringJoint2D

unsafe fn godot_free(self)

impl FromVariant for DampedSpringJoint2D

fn from_variant(
    variant: &Variant
) -> Result<DampedSpringJoint2D, FromVariantError>

impl GodotObject for DampedSpringJoint2D

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> DampedSpringJoint2D

unsafe fn from_return_position_sys(obj: *mut c_void) -> DampedSpringJoint2D

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for DampedSpringJoint2D

fn construct() -> DampedSpringJoint2D

impl QueueFree for DampedSpringJoint2D

unsafe fn godot_queue_free(&mut self)

impl ToVariant for DampedSpringJoint2D

fn to_variant(&self) -> Variant