[−][src]Struct gdnative::api::SliderJoint
core class SliderJoint
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.
SliderJoint
is a reference-only type. Persistent references can
only exist in the unsafe Ref<SliderJoint>
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
SliderJoint 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 SliderJoint
[src]
Constants
pub const PARAM_ANGULAR_LIMIT_DAMPING: i64
[src]
pub const PARAM_ANGULAR_LIMIT_LOWER: i64
[src]
pub const PARAM_ANGULAR_LIMIT_RESTITUTION: i64
[src]
pub const PARAM_ANGULAR_LIMIT_SOFTNESS: i64
[src]
pub const PARAM_ANGULAR_LIMIT_UPPER: i64
[src]
pub const PARAM_ANGULAR_MOTION_DAMPING: i64
[src]
pub const PARAM_ANGULAR_MOTION_RESTITUTION: i64
[src]
pub const PARAM_ANGULAR_MOTION_SOFTNESS: i64
[src]
pub const PARAM_ANGULAR_ORTHOGONAL_DAMPING: i64
[src]
pub const PARAM_ANGULAR_ORTHOGONAL_RESTITUTION: i64
[src]
pub const PARAM_ANGULAR_ORTHOGONAL_SOFTNESS: i64
[src]
pub const PARAM_LINEAR_LIMIT_DAMPING: i64
[src]
pub const PARAM_LINEAR_LIMIT_LOWER: i64
[src]
pub const PARAM_LINEAR_LIMIT_RESTITUTION: i64
[src]
pub const PARAM_LINEAR_LIMIT_SOFTNESS: i64
[src]
pub const PARAM_LINEAR_LIMIT_UPPER: i64
[src]
pub const PARAM_LINEAR_MOTION_DAMPING: i64
[src]
pub const PARAM_LINEAR_MOTION_RESTITUTION: i64
[src]
pub const PARAM_LINEAR_MOTION_SOFTNESS: i64
[src]
pub const PARAM_LINEAR_ORTHOGONAL_DAMPING: i64
[src]
pub const PARAM_LINEAR_ORTHOGONAL_RESTITUTION: i64
[src]
pub const PARAM_LINEAR_ORTHOGONAL_SOFTNESS: i64
[src]
pub const PARAM_MAX: i64
[src]
impl SliderJoint
[src]
pub fn new() -> Ref<SliderJoint, 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 param(&self, param: i64) -> f64
[src]
A factor applied to the movement across axes orthogonal to the slider.
pub fn set_param(&self, param: i64, value: f64)
[src]
A factor applied to the movement across axes orthogonal to the slider.
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 SliderJoint
[src]
impl Deref for SliderJoint
[src]
impl DerefMut for SliderJoint
[src]
impl GodotObject for SliderJoint
[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 SliderJoint
[src]
fn construct() -> Ref<SliderJoint, Unique>
[src]
impl QueueFree for SliderJoint
[src]
unsafe fn godot_queue_free(obj: *mut c_void)
[src]
impl SubClass<Joint> for SliderJoint
[src]
impl SubClass<Node> for SliderJoint
[src]
impl SubClass<Object> for SliderJoint
[src]
impl SubClass<Spatial> for SliderJoint
[src]
Auto Trait Implementations
impl RefUnwindSafe for SliderJoint
impl !Send for SliderJoint
impl !Sync for SliderJoint
impl Unpin for SliderJoint
impl UnwindSafe for SliderJoint
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>,