Struct gdnative_bindings::PinJoint

pub struct PinJoint { /* fields omitted */ }

core class PinJoint inherits Joint (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.

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

Class hierarchy

PinJoint inherits methods from:

• Joint
• Spatial
• Node
• Object

Methods

impl PinJoint

Constants

pub const PARAM_BIAS: i64

pub const PARAM_DAMPING: i64

pub const PARAM_IMPULSE_CLAMP: i64

impl PinJoint

pub fn new() -> Self

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn get_param(&self, param: i64) -> f64

pub unsafe fn set_param(&mut self, param: i64, value: f64)

pub unsafe fn to_joint(&self) -> Joint

Up-cast.

pub unsafe fn to_spatial(&self) -> Spatial

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: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Methods from Deref<Target = Joint>

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 get_solver_priority(&self) -> i64

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 set_solver_priority(&mut self, priority: i64)

pub unsafe fn to_spatial(&self) -> Spatial

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: GodotObject>(&self) -> Option<T>

Generic dynamic cast.

Trait Implementations

impl Clone for PinJoint

fn clone(&self) -> PinJoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PinJoint

impl Debug for PinJoint

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

Formats the value using the given formatter.

impl Deref for PinJoint

type Target = Joint

The resulting type after dereferencing.

fn deref(&self) -> &Joint

Dereferences the value.

impl DerefMut for PinJoint

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

Mutably dereferences the value.

impl Free for PinJoint

unsafe fn godot_free(self)

impl FromVariant for PinJoint

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

impl GodotObject for PinJoint

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

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

impl Instanciable for PinJoint

fn construct() -> Self

impl QueueFree for PinJoint

unsafe fn godot_queue_free(&mut self)

impl ToVariant for PinJoint

fn to_variant(&self) -> Variant