Open 3D Engine AzFramework API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzPhysics::Joint Struct Referenceabstract

Base class for all Joints in Physics. More...

#include <PhysicsJoint.h>

Public Member Functions

 AZ_RTTI (AzPhysics::Joint, "{1EEC9382-3434-4866-9B18-E93F151A6F59}")
 
template<typename T >
void SetUserData (T *userData)
 
void * GetUserData ()
 
virtual AZ::Crc32 GetNativeType () const =0
 
virtual void * GetNativePointer () const =0
 
virtual AzPhysics::SimulatedBodyHandle GetParentBodyHandle () const =0
 
virtual AzPhysics::SimulatedBodyHandle GetChildBodyHandle () const =0
 
virtual void SetParentBody (AzPhysics::SimulatedBodyHandle parentBody)=0
 
virtual void SetChildBody (AzPhysics::SimulatedBodyHandle childBody)=0
 
virtual void GenerateJointLimitVisualizationData ([[maybe_unused]] float scale, [[maybe_unused]] AZ::u32 angularSubdivisions, [[maybe_unused]] AZ::u32 radialSubdivisions, [[maybe_unused]] AZStd::vector< AZ::Vector3 > &vertexBufferOut, [[maybe_unused]] AZStd::vector< AZ::u32 > &indexBufferOut, [[maybe_unused]] AZStd::vector< AZ::Vector3 > &lineBufferOut, [[maybe_unused]] AZStd::vector< bool > &lineValidityBufferOut)
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

 AZ_CLASS_ALLOCATOR_DECL
 
SceneHandle m_sceneOwner = AzPhysics::InvalidSceneHandle
 The current Scene the joint is contained.
 
JointHandle m_jointHandle = AzPhysics::InvalidJointHandle
 The handle to this joint.
 

Detailed Description

Base class for all Joints in Physics.

Member Function Documentation

◆ GetUserData()

void* AzPhysics::Joint::GetUserData ( )
inline

Helper functions for getting the set user data.

Returns
Will return a void* to the user data set.

◆ SetUserData()

template<typename T >
void AzPhysics::Joint::SetUserData ( T *  userData)
inline

Helper functions for setting user data.

Parameters
userDataCan be a pointer to any type as internally will be cast to a void*. Object lifetime not managed by the Joint.

The documentation for this struct was generated from the following file: