SpringJoint

Struct SpringJoint 

Source
pub struct SpringJoint {
Show 18 fields pub m_Anchor: Vector3f, pub m_BreakForce: f32, pub m_BreakTorque: f32, pub m_ConnectedBody: PPtr, pub m_Damper: f32, pub m_GameObject: PPtr, pub m_MaxDistance: f32, pub m_MinDistance: f32, pub m_Spring: f32, pub m_AutoConfigureConnectedAnchor: Option<bool>, pub m_ConnectedAnchor: Option<Vector3f>, pub m_ConnectedArticulationBody: Option<PPtr>, pub m_ConnectedMassScale: Option<f32>, pub m_EnableCollision: Option<bool>, pub m_EnablePreprocessing: Option<bool>, pub m_Enabled: Option<bool>, pub m_MassScale: Option<f32>, pub m_Tolerance: Option<f32>,
}
Expand description

SpringJoint is a class of the Unity engine since version 3.4.0. Exert from Unity’s scripting documentation: The spring joint ties together 2 rigid bodies, spring forces will be automatically applied to keep the object at the given distance. The Spring attempts to maintain the distance it has when it starts out.

So if your joint’s start at a rest position where the two rigidbodies are far apart, then the joint will attempt to maintain that distance.

The minDistance and maxDistance properties add on top of this implicit distance.

Fields§

§m_Anchor: Vector3f

The Position of the anchor around which the joints motion is constrained.

§m_BreakForce: f32

The force that needs to be applied for this joint to break.

§m_BreakTorque: f32

The torque that needs to be applied for this joint to break. To be able to break, a joint must be Locked or Limited on the axis of rotation where the torque is being applied. This means that some joints cannot break, such as an unconstrained Configurable Joint.

§m_ConnectedBody: PPtr

A reference to another rigidbody this joint connects to. PPtr<Rigidbody>: (3.4.0 - 2022.3.2f1)

§m_Damper: f32

The damper force used to dampen the spring force.

§m_GameObject: PPtr

The game object this component is attached to. A component is always attached to a game object. PPtr<GameObject>: (3.4.0 - 2022.3.2f1)

§m_MaxDistance: f32

The maximum distance between the bodies relative to their initial distance.

§m_MinDistance: f32

The minimum distance between the bodies relative to their initial distance.

§m_Spring: f32

The spring force used to keep the two objects together.

§m_AutoConfigureConnectedAnchor: Option<bool>

Should the connectedAnchor be calculated automatically? bool: (4.3.0 - 2022.3.2f1)

§m_ConnectedAnchor: Option<Vector3f>

Position of the anchor relative to the connected Rigidbody. Vector3f: (4.3.0 - 2022.3.2f1)

§m_ConnectedArticulationBody: Option<PPtr>

A reference to an articulation body this joint connects to. PPtr<ArticulationBody>: (2020.2.0b1 - 2022.3.2f1)

§m_ConnectedMassScale: Option<f32>

The scale to apply to the inverse mass and inertia tensor of the connected body prior to solving the constraints. f32: (2017.1.0b2 - 2022.3.2f1)

§m_EnableCollision: Option<bool>

Enable collision between bodies connected with the joint. bool: (4.5.0 - 2022.3.2f1)

§m_EnablePreprocessing: Option<bool>

Toggle preprocessing for this joint. bool: (5.0.0f4 - 2022.3.2f1)

§m_Enabled: Option<bool>

bool: (2017.1.0b2 - 2017.1.0b5)

§m_MassScale: Option<f32>

The scale to apply to the inverse mass and inertia tensor of the body prior to solving the constraints. f32: (2017.1.0b2 - 2022.3.2f1)

§m_Tolerance: Option<f32>

The maximum allowed error between the current spring length and the length defined by minDistance and maxDistance. f32: (5.2.3f1 - 2022.3.2f1)

Trait Implementations§

Source§

impl Debug for SpringJoint

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for SpringJoint

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for SpringJoint

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,