Struct gdnative::api::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 a reference-only type. Persistent references can only exist in the unsafe Ref<HingeJoint> 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

HingeJoint inherits methods from:

• Joint
• Spatial
• 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 HingeJoint

Constants

pub const FLAG_ENABLE_MOTOR: i64

pub const FLAG_MAX: i64

pub const FLAG_USE_LIMIT: i64

pub const PARAM_BIAS: i64

pub const PARAM_LIMIT_BIAS: i64

pub const PARAM_LIMIT_LOWER: i64

pub const PARAM_LIMIT_RELAXATION: i64

pub const PARAM_LIMIT_SOFTNESS: i64

pub const PARAM_LIMIT_UPPER: i64

pub const PARAM_MAX: i64

pub const PARAM_MOTOR_MAX_IMPULSE: i64

pub const PARAM_MOTOR_TARGET_VELOCITY: i64

impl HingeJoint

pub fn new() -> Ref<HingeJoint, 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 flag(&self, flag: i64) -> bool

When activated, a motor turns the hinge.

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

The speed with which the two bodies get pulled together when they move in different directions.

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

When activated, a motor turns the hinge.

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

The speed with which the two bodies get pulled together when they move in different directions.

Methods from Deref<Target = Joint>

pub fn exclude_nodes_from_collision(&self) -> bool

If [code]true[/code], the two bodies of the nodes are not able to collide with each other.

pub fn node_a(&self) -> NodePath

The node attached to the first side (A) of the joint.

pub fn node_b(&self) -> NodePath

The node attached to the second side (B) of the joint.

pub fn solver_priority(&self) -> i64

The priority used to define which solver is executed first for multiple joints. The lower the value, the higher the priority.

pub fn set_exclude_nodes_from_collision(&self, enable: bool)

If [code]true[/code], the two bodies of the nodes are not able to collide with each other.

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

The node attached to the first side (A) of the joint.

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

The node attached to the second side (B) of the joint.

pub fn set_solver_priority(&self, priority: i64)

The priority used to define which solver is executed first for multiple joints. The lower the value, the higher the priority.

Trait Implementations

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 GodotObject for HingeJoint

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 HingeJoint

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

impl QueueFree for HingeJoint

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<Joint> for HingeJoint

impl SubClass<Node> for HingeJoint

impl SubClass<Object> for HingeJoint

impl SubClass<Spatial> for HingeJoint