Quantum 3 3.1.0

Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
Quantum.Physics3D.CharacterJoint3D Struct Reference

A Joint3D that attaches a Physics Body to an anchor around which it can rotate. The connected anchor can be a world-space position or another entity with at least a transform component. The rotation can happen freely or, optionally, with limiting angles and/or a motor torque. More...

Public Member Functions

readonly override int GetHashCode ()
 Overrides the hash code generation of this type. More...
 

Static Public Member Functions

static void Serialize (void *ptr, FrameSerializer serializer)
 Serializes a CharacterJoint3D into a FrameSerializer. More...
 

Public Attributes

FPVector3 Anchor
 The anchor offset, in the local space of the joint entity transform. This is the point considered for the joint constraints and where the joint forces are applied. More...
 
FPVector3 ConnectedAnchor
 If the joint has a ConnectedEntity, this represents the anchor offset relative to it, in local space. Else, this is the position in world space considered as target anchor. More...
 
EntityRef ConnectedEntity
 A target entity that this joint might be connected to. If set to EntityRef.None, the ConnectedAnchor represents the target anchor position in world space. The connected entity must have at least a Transform3D component. If it also has a non-kinematic PhysicsBody3D, joint forces are also computed and applied to it. More...
 

Static Public Attributes

const int SIZE = OFFSET_QUAT + FPQuaternionRawInt.SIZE * 2
 The size of the struct in bytes. More...
 

Detailed Description

A Joint3D that attaches a Physics Body to an anchor around which it can rotate. The connected anchor can be a world-space position or another entity with at least a transform component. The rotation can happen freely or, optionally, with limiting angles and/or a motor torque.

Member Function Documentation

◆ Serialize()

static void Quantum.Physics3D.CharacterJoint3D.Serialize ( void *  ptr,
FrameSerializer  serializer 
)
inlinestatic

Serializes a CharacterJoint3D into a FrameSerializer.

Parameters
ptrThe pointer to the CharacterJoint3D.
serializerThe FrameSerializer instance into which the struct will be serialized.

◆ GetHashCode()

readonly override int Quantum.Physics3D.CharacterJoint3D.GetHashCode ( )
inline

Overrides the hash code generation of this type.

Returns
A hash code of the current state of this instance.

Member Data Documentation

◆ SIZE

const int Quantum.Physics3D.CharacterJoint3D.SIZE = OFFSET_QUAT + FPQuaternionRawInt.SIZE * 2
static

The size of the struct in bytes.

◆ ConnectedEntity

EntityRef Quantum.Physics3D.CharacterJoint3D.ConnectedEntity

A target entity that this joint might be connected to. If set to EntityRef.None, the ConnectedAnchor represents the target anchor position in world space. The connected entity must have at least a Transform3D component. If it also has a non-kinematic PhysicsBody3D, joint forces are also computed and applied to it.

◆ Anchor

FPVector3 Quantum.Physics3D.CharacterJoint3D.Anchor

The anchor offset, in the local space of the joint entity transform. This is the point considered for the joint constraints and where the joint forces are applied.

◆ ConnectedAnchor

FPVector3 Quantum.Physics3D.CharacterJoint3D.ConnectedAnchor

If the joint has a ConnectedEntity, this represents the anchor offset relative to it, in local space. Else, this is the position in world space considered as target anchor.