Struct gdnative::HingeJoint

pub struct HingeJoint { /* fields omitted */ }

core class HingeJoint 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.

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

Class hierarchy

HingeJoint inherits methods from:

• Joint
• Spatial
• Node
• Object

Implementations

impl HingeJoint

Constants

pub const FLAG_ENABLE_MOTOR: i64

pub const PARAM_MOTOR_TARGET_VELOCITY: i64

pub const FLAG_USE_LIMIT: i64

pub const PARAM_BIAS: i64

pub const PARAM_LIMIT_SOFTNESS: i64

pub const PARAM_MAX: i64

pub const FLAG_MAX: i64

pub const PARAM_LIMIT_RELAXATION: i64

pub const PARAM_LIMIT_UPPER: i64

pub const PARAM_MOTOR_MAX_IMPULSE: i64

pub const PARAM_LIMIT_LOWER: i64

pub const PARAM_LIMIT_BIAS: i64

impl HingeJoint

pub fn new() -> HingeJoint

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

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn _get_lower_limit(&self) -> f64

pub unsafe fn _get_upper_limit(&self) -> f64

pub unsafe fn _set_lower_limit(&mut self, lower_limit: f64)

pub unsafe fn _set_upper_limit(&mut self, upper_limit: f64)

pub unsafe fn get_flag(&self, flag: i64) -> bool

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

pub unsafe fn set_flag(&mut self, flag: i64, enabled: bool)

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

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

Generic dynamic cast.

Trait Implementations

impl Clone for HingeJoint

fn clone(&self) -> HingeJoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for HingeJoint

impl Debug for HingeJoint

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

Formats the value using the given formatter.

impl Deref for HingeJoint

type Target = Joint

The resulting type after dereferencing.

fn deref(&self) -> &Joint

Dereferences the value.

impl DerefMut for HingeJoint

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

Mutably dereferences the value.

impl Free for HingeJoint

unsafe fn godot_free(self)

impl FromVariant for HingeJoint

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

impl GodotObject for HingeJoint

fn class_name() -> &'static str

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

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

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

unsafe fn claim(&self) -> Self

Creates a wrapper around the same Godot object that has 'static lifetime.

impl Instanciable for HingeJoint

fn construct() -> HingeJoint

impl QueueFree for HingeJoint

unsafe fn godot_queue_free(&mut self)

impl ToVariant for HingeJoint

fn to_variant(&self) -> Variant