Open 3D Engine PhysX Gem API Reference 25.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
PhysX::ArticulationLinkConfiguration Struct Reference

Configuration used to Add Articulations to a Scene. More...

#include <ArticulationLinkConfiguration.h>

Inherits AzPhysics::SimulatedBodyConfiguration.

Inherited by PhysX::EditorArticulationLinkConfiguration.

Public Types

enum class  DisplaySetupState : AZ::u8 { Never = 0 , Selected , Always }
 

Public Member Functions

 AZ_RTTI (ArticulationLinkConfiguration, "{56268154-037A-4BB2-A7EE-E1E76B7D2F8E}", AzPhysics::SimulatedBodyConfiguration)
 
bool IsNotRootArticulation () const
 
bool HingePropertiesVisible () const
 
bool PrismaticPropertiesVisible () const
 
bool IsSingleDofJointType () const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

 AZ_CLASS_ALLOCATOR_DECL
 
bool m_isFixedBase = false
 
bool m_selfCollide = false
 
AZ::Vector3 m_centerOfMassOffset = AZ::Vector3::CreateZero()
 
float m_mass = 1.0f
 
float m_linearDamping = 0.05f
 
float m_angularDamping = 0.15f
 
float m_sleepMinEnergy = 0.005f
 
float m_maxAngularVelocity = 100.0f
 
bool m_startAsleep = false
 
bool m_gravityEnabled = true
 
AZ::u8 m_solverPositionIterations = 4
 Higher values can improve stability at the cost of performance.
 
AZ::u8 m_solverVelocityIterations = 1
 Higher values can improve stability at the cost of performance.
 
ArticulationJointType m_articulationJointType = ArticulationJointType::Fix
 
bool m_fixJointLocation = false
 
bool m_isLimited = true
 Indicates if this joint has limits, e.g. maximum swing angles.
 
float m_linearLimitLower = -1.0f
 
float m_linearLimitUpper = 1.0f
 
float m_angularLimitPositive = 45.0f
 
float m_angularLimitNegative = -45.0f
 
float m_jointFriction = 0.f
 
AZ::Vector3 m_armature = AZ::Vector3::CreateZero()
 
ArticulationJointMotorProperties m_motorConfiguration
 
AZ::Vector3 m_localPosition = AZ::Vector3::CreateZero()
 
AZ::Vector3 m_localRotation
 Local rotation angles about X, Y, Z axes in degrees, relative to follower body.
 
bool m_autoCalculateLeadFrame = true
 
AZ::Vector3 m_leadLocalPosition = AZ::Vector3::CreateZero()
 
AZ::Vector3 m_LeadLocalRotation
 Local rotation angles about X, Y, Z axes in degrees, relative to lead body.
 
AZStd::vector< ArticulationSensorConfiguration > m_sensorConfigs
 
DisplaySetupState m_displayJointSetup = DisplaySetupState::Selected
 
bool m_isRootArticulation = false
 

Detailed Description

Configuration used to Add Articulations to a Scene.

Member Data Documentation

◆ m_LeadLocalRotation

AZ::Vector3 PhysX::ArticulationLinkConfiguration::m_LeadLocalRotation
Initial value:
=
AZ::Vector3::CreateZero()

Local rotation angles about X, Y, Z axes in degrees, relative to lead body.

◆ m_localRotation

AZ::Vector3 PhysX::ArticulationLinkConfiguration::m_localRotation
Initial value:
=
AZ::Vector3::CreateZero()

Local rotation angles about X, Y, Z axes in degrees, relative to follower body.

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