[−][src]Struct gdnative::api::Generic6DOFJoint
core class Generic6DOFJoint
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.
Generic6DOFJoint
is a reference-only type. Persistent references can
only exist in the unsafe Ref<Generic6DOFJoint>
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
Generic6DOFJoint inherits methods from:
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 Generic6DOFJoint
[src]
Constants
pub const FLAG_ENABLE_ANGULAR_LIMIT: i64
[src]
pub const FLAG_ENABLE_ANGULAR_SPRING: i64
[src]
pub const FLAG_ENABLE_LINEAR_LIMIT: i64
[src]
pub const FLAG_ENABLE_LINEAR_MOTOR: i64
[src]
pub const FLAG_ENABLE_LINEAR_SPRING: i64
[src]
pub const FLAG_ENABLE_MOTOR: i64
[src]
pub const FLAG_MAX: i64
[src]
pub const PARAM_ANGULAR_DAMPING: i64
[src]
pub const PARAM_ANGULAR_ERP: i64
[src]
pub const PARAM_ANGULAR_FORCE_LIMIT: i64
[src]
pub const PARAM_ANGULAR_LIMIT_SOFTNESS: i64
[src]
pub const PARAM_ANGULAR_LOWER_LIMIT: i64
[src]
pub const PARAM_ANGULAR_MOTOR_FORCE_LIMIT: i64
[src]
pub const PARAM_ANGULAR_MOTOR_TARGET_VELOCITY: i64
[src]
pub const PARAM_ANGULAR_RESTITUTION: i64
[src]
pub const PARAM_ANGULAR_SPRING_DAMPING: i64
[src]
pub const PARAM_ANGULAR_SPRING_EQUILIBRIUM_POINT: i64
[src]
pub const PARAM_ANGULAR_SPRING_STIFFNESS: i64
[src]
pub const PARAM_ANGULAR_UPPER_LIMIT: i64
[src]
pub const PARAM_LINEAR_DAMPING: i64
[src]
pub const PARAM_LINEAR_LIMIT_SOFTNESS: i64
[src]
pub const PARAM_LINEAR_LOWER_LIMIT: i64
[src]
pub const PARAM_LINEAR_MOTOR_FORCE_LIMIT: i64
[src]
pub const PARAM_LINEAR_MOTOR_TARGET_VELOCITY: i64
[src]
pub const PARAM_LINEAR_RESTITUTION: i64
[src]
pub const PARAM_LINEAR_SPRING_DAMPING: i64
[src]
pub const PARAM_LINEAR_SPRING_EQUILIBRIUM_POINT: i64
[src]
pub const PARAM_LINEAR_SPRING_STIFFNESS: i64
[src]
pub const PARAM_LINEAR_UPPER_LIMIT: i64
[src]
pub const PARAM_MAX: i64
[src]
impl Generic6DOFJoint
[src]
pub fn new() -> Ref<Generic6DOFJoint, Unique>
[src]
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_x(&self, flag: i64) -> bool
[src]
If [code]true[/code], then there is a linear motor on the X axis. It will attempt to reach the target velocity while staying within the force limits.
pub fn flag_y(&self, flag: i64) -> bool
[src]
If [code]true[/code], then there is a linear motor on the Y axis. It will attempt to reach the target velocity while staying within the force limits.
pub fn flag_z(&self, flag: i64) -> bool
[src]
If [code]true[/code], then there is a linear motor on the Z axis. It will attempt to reach the target velocity while staying within the force limits.
pub fn param_x(&self, param: i64) -> f64
[src]
The speed that the linear motor will attempt to reach on the X axis.
pub fn param_y(&self, param: i64) -> f64
[src]
The speed that the linear motor will attempt to reach on the Y axis.
pub fn param_z(&self, param: i64) -> f64
[src]
The speed that the linear motor will attempt to reach on the Z axis.
pub fn precision(&self) -> i64
[src]
pub fn set_flag_x(&self, flag: i64, value: bool)
[src]
If [code]true[/code], then there is a linear motor on the X axis. It will attempt to reach the target velocity while staying within the force limits.
pub fn set_flag_y(&self, flag: i64, value: bool)
[src]
If [code]true[/code], then there is a linear motor on the Y axis. It will attempt to reach the target velocity while staying within the force limits.
pub fn set_flag_z(&self, flag: i64, value: bool)
[src]
If [code]true[/code], then there is a linear motor on the Z axis. It will attempt to reach the target velocity while staying within the force limits.
pub fn set_param_x(&self, param: i64, value: f64)
[src]
The speed that the linear motor will attempt to reach on the X axis.
pub fn set_param_y(&self, param: i64, value: f64)
[src]
The speed that the linear motor will attempt to reach on the Y axis.
pub fn set_param_z(&self, param: i64, value: f64)
[src]
The speed that the linear motor will attempt to reach on the Z axis.
pub fn set_precision(&self, precision: i64)
[src]
Methods from Deref<Target = Joint>
pub fn exclude_nodes_from_collision(&self) -> bool
[src]
If [code]true[/code], the two bodies of the nodes are not able to collide with each other.
pub fn node_a(&self) -> NodePath
[src]
The node attached to the first side (A) of the joint.
pub fn node_b(&self) -> NodePath
[src]
The node attached to the second side (B) of the joint.
pub fn solver_priority(&self) -> i64
[src]
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)
[src]
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>)
[src]
The node attached to the first side (A) of the joint.
pub fn set_node_b(&self, node: impl Into<NodePath>)
[src]
The node attached to the second side (B) of the joint.
pub fn set_solver_priority(&self, priority: i64)
[src]
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 Generic6DOFJoint
[src]
impl Deref for Generic6DOFJoint
[src]
impl DerefMut for Generic6DOFJoint
[src]
impl GodotObject for Generic6DOFJoint
[src]
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. Read more
fn class_name() -> &'static str
[src]
fn null() -> Null<Self>
[src]
fn new() -> Ref<Self, Unique> where
Self: Instanciable,
[src]
Self: Instanciable,
fn cast<T>(&self) -> Option<&T> where
T: GodotObject + SubClass<Self>,
[src]
T: GodotObject + SubClass<Self>,
fn upcast<T>(&self) -> &T where
Self: SubClass<T>,
T: GodotObject,
[src]
Self: SubClass<T>,
T: GodotObject,
unsafe fn assume_shared(&self) -> Ref<Self, Shared>
[src]
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
[src]
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_unique(&self) -> Ref<Self, Unique>
[src]
impl Instanciable for Generic6DOFJoint
[src]
fn construct() -> Ref<Generic6DOFJoint, Unique>
[src]
impl QueueFree for Generic6DOFJoint
[src]
unsafe fn godot_queue_free(obj: *mut c_void)
[src]
impl SubClass<Joint> for Generic6DOFJoint
[src]
impl SubClass<Node> for Generic6DOFJoint
[src]
impl SubClass<Object> for Generic6DOFJoint
[src]
impl SubClass<Spatial> for Generic6DOFJoint
[src]
Auto Trait Implementations
impl RefUnwindSafe for Generic6DOFJoint
impl !Send for Generic6DOFJoint
impl !Sync for Generic6DOFJoint
impl Unpin for Generic6DOFJoint
impl UnwindSafe for Generic6DOFJoint
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> SubClass<T> for T where
T: GodotObject,
[src]
T: GodotObject,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,