Open 3D Engine PhysX Gem 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.
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
PhysX::PrismaticJointComponent Class Reference

#include <PrismaticJointComponent.h>

Inherits PhysX::JointComponent, and JointRequestBus::Handler.

Public Member Functions

 AZ_COMPONENT (PrismaticJointComponent, "{9B34CA1B-C063-4D42-A15B-CE6CD7C828DC}", JointComponent)
 
 PrismaticJointComponent (const JointComponentConfiguration &configuration, const JointGenericProperties &genericProperties, const JointLimitProperties &limitProperties, const JointMotorProperties &motorProperties)
 
- Public Member Functions inherited from PhysX::JointComponent
 AZ_COMPONENT (JointComponent, "{B01FD1D2-1D91-438D-874A-BF5EB7E919A8}")
 
 JointComponent (const JointComponentConfiguration &configuration, const JointGenericProperties &genericProperties)
 
 JointComponent (const JointComponentConfiguration &configuration, const JointGenericProperties &genericProperties, const JointLimitProperties &limitProperties)
 
 JointComponent (const JointComponentConfiguration &configuration, const JointGenericProperties &genericProperties, const JointLimitProperties &limitProperties, const JointMotorProperties &motorProperties)
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 
- Static Public Member Functions inherited from PhysX::JointComponent
static void Reflect (AZ::ReflectContext *context)
 

Protected Member Functions

void InitNativeJoint () override
 
void DeinitNativeJoint () override
 
float GetPosition () const override
 
float GetVelocity () const override
 
AZ::Transform GetTransform () const override
 
void SetVelocity (float velocity) override
 
void SetMaximumForce (float force) override
 
AZStd::pair< float, float > GetLimits () const override
 
- Protected Member Functions inherited from PhysX::JointComponent
void Activate () override
 
void Deactivate () override
 
void OnPhysicsEnabled (const AZ::EntityId &entityId) override
 
void OnPhysicsDisabled (const AZ::EntityId &entityId) override
 
void CreateNativeJoint ()
 
void DestroyNativeJoint ()
 
void OnTick (float deltaTime, AZ::ScriptTimePoint time) override
 
AZ::Transform GetJointLocalPose (const physx::PxRigidActor *actor, const AZ::Transform &jointPose)
 
AZ::Transform GetJointTransform (AZ::EntityId entityId, const JointComponentConfiguration &jointConfig)
 
void ObtainLeadFollowerInfo (LeadFollowerInfo &leadFollowerInfo)
 
void WarnInvalidJointSetup (AZ::EntityId entityId, const AZStd::string &message)
 Issues warnings for invalid scenarios when initializing a joint from entity IDs.
 
void PrintJointSetupMessage (AZ::EntityId entityId, const AZStd::string &message)
 Issues info messages for potentially invalid scenarios when initializing a joint from entity IDs.
 

Additional Inherited Members

- Protected Attributes inherited from PhysX::JointComponent
JointComponentConfiguration m_configuration
 
JointGenericProperties m_genericProperties
 
JointLimitProperties m_limits
 
JointMotorProperties m_motor
 
AzPhysics::JointHandle m_jointHandle = AzPhysics::InvalidJointHandle
 
AzPhysics::SceneHandle m_jointSceneOwner = AzPhysics::InvalidSceneHandle
 
AZStd::unordered_map< AZ::EntityId, bool > m_rigidBodyEntityMap
 

Detailed Description

Provides runtime support for prismatic joints. Prismatic joints allow no rotation, but allow sliding along a direction aligned with the x-axis of both bodies' joint frames.

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