Open 3D Engine PhysX Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
PhysX::Debug::DebugDisplayData Struct Reference

Contains various options for debug display of PhysX features. More...

#include <PhysXDebugConfiguration.h>

Public Types

enum class  GlobalCollisionDebugState { AlwaysOn , AlwaysOff , Manual }
 Enable Global Collision Debug Draw. More...
 
enum class  GlobalCollisionDebugColorMode { MaterialColor , ErrorColor }
 Color scheme for debug collision. More...
 
enum class  JointLeadColor {
  Aquamarine , AliceBlue , CadetBlue , Coral ,
  Green , DarkGreen , ForestGreen , Honeydew
}
 Colors for joint lead.
 
enum class  JointFollowerColor {
  Yellow , Chocolate , HotPink , Lavender ,
  Magenta , LightYellow , Maroon , Red
}
 Colors for joint follower.
 

Public Member Functions

 AZ_TYPE_INFO (DebugDisplayData, "{E9F1C386-3726-45B8-8DA5-BF7135B3ACD0}")
 
AZ::Color GetJointLeadColor () const
 
AZ::Color GetJointFollowerColor () const
 
bool operator== (const DebugDisplayData &other) const
 
bool operator!= (const DebugDisplayData &other) const
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Public Attributes

float m_centerOfMassDebugSize = 0.1f
 Center of Mass Debug Draw Circle Size.
 
AZ::Color m_centerOfMassDebugColor = AZ::Color((AZ::u8)255, (AZ::u8)0, (AZ::u8)0, (AZ::u8)255)
 Center of Mass Debug Draw Circle Color.
 
GlobalCollisionDebugState m_globalCollisionDebugDraw = GlobalCollisionDebugState::Manual
 
GlobalCollisionDebugColorMode m_globalCollisionDebugDrawColorMode = GlobalCollisionDebugColorMode::MaterialColor
 
bool m_showJointHierarchy = true
 Flag to switch on/off the display of joints' lead-follower connections in the viewport.
 
JointLeadColor m_jointHierarchyLeadColor = JointLeadColor::Aquamarine
 Color of the lead half of a lead-follower joint connection line.
 
JointFollowerColor m_jointHierarchyFollowerColor = JointFollowerColor::Magenta
 Color of the follower half of a lead-follower joint connection line.
 
float m_jointHierarchyDistanceThreshold = 1.0f
 Minimum distance required to draw from follower to joint. Distances shorter than this threshold will result in the line drawn from the joint to the lead.
 
ColliderProximityVisualization m_colliderProximityVisualization
 

Detailed Description

Contains various options for debug display of PhysX features.

Member Enumeration Documentation

◆ GlobalCollisionDebugColorMode

Color scheme for debug collision.

Enumerator
MaterialColor 

Use debug color specified in the material.

ErrorColor 

Show default color and flashing red for colliders with errors.

◆ GlobalCollisionDebugState

Enable Global Collision Debug Draw.

Enumerator
AlwaysOn 

Collision draw debug all entities.

AlwaysOff 

Collision debug draw disabled.

Manual 

Set up in the entity.


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