PhysX::Debug::PhysXDebugInterface Class Reference

Interface for interacting with the PhysX Debug options. More...

#include <PhysXDebugInterface.h>

Public Member Functions
	AZ_TYPE_INFO (PhysXDebugInterface, "{3468284B-0183-4B4A-A844-49BFCE1E7795}")
	AZ_DISABLE_COPY_MOVE (PhysXDebugInterface)
virtual void	Initialize (const DebugConfiguration &config)=0
virtual void	UpdateDebugConfiguration (const DebugConfiguration &config)=0
virtual const DebugConfiguration &	GetDebugConfiguration () const =0
	Get the current debug configuration.
virtual const PvdConfiguration &	GetPhysXPvdConfiguration () const =0
	Get the Configuration options to use when connecting / interacting with the PhysX Visual Debugger (PVD)
virtual const DebugDisplayData &	GetDebugDisplayData () const =0
	Get the debug display configuration of PhysX.
virtual void	UpdateColliderProximityVisualization (const ColliderProximityVisualization &data)=0
virtual bool	ConnectToPvd ()=0
	Open a connection to the PhysX Visual Debugger (PVD) using the configured settings.
virtual void	DisconnectFromPvd ()=0
	Close a connection to the PhysX Visual Debugger (PVD).
void	RegisterColliderProximityVisualizationChangedEvent (ColliderProximityVisualizationChangedEvent::Handler &handler)
void	RegisterPvdConfigurationChangedEvent (PvdConfigurationChangedEvent::Handler &handler)
void	RegisterDebugDisplayDataChangedEvent (DebugDisplayDataChangedEvent::Handler &handler)

Protected Attributes
ColliderProximityVisualizationChangedEvent	m_colliderProximityVisualizationChangedEvent
PvdConfigurationChangedEvent	m_pvdConfigurationChangedEvent
DebugDisplayDataChangedEvent	m_debugDisplayDataChangedEvent

Detailed Description

Interface for interacting with the PhysX Debug options.

Member Function Documentation

Initialize()

virtual void PhysX::Debug::PhysXDebugInterface::Initialize ( const DebugConfiguration &  config )

pure virtual

Initialize the system.

Parameters

config

The configuration to use.

RegisterColliderProximityVisualizationChangedEvent()

void PhysX::Debug::PhysXDebugInterface::RegisterColliderProximityVisualizationChangedEvent ( ColliderProximityVisualizationChangedEvent::Handler &  handler )

inline

Register to receive an event when the Collider Proximity Visulization data changes.

Parameters

handler

The handler to receive the event.

RegisterDebugDisplayDataChangedEvent()

void PhysX::Debug::PhysXDebugInterface::RegisterDebugDisplayDataChangedEvent ( DebugDisplayDataChangedEvent::Handler &  handler )

inline

Register to receive an event when the debug display data changes.

Parameters

handler

The handler to receive the event.

RegisterPvdConfigurationChangedEvent()

void PhysX::Debug::PhysXDebugInterface::RegisterPvdConfigurationChangedEvent ( PvdConfigurationChangedEvent::Handler &  handler )

inline

Register to receive an event when the PhysX Visual Debugger (PVD) configuration changes.

Parameters

handler

The handler to receive the event.

UpdateColliderProximityVisualization()

virtual void PhysX::Debug::PhysXDebugInterface::UpdateColliderProximityVisualization ( const ColliderProximityVisualization &  data )

pure virtual

Configure the visualization of colliders based on proximity from a camera.

Parameters

enabled	to activate collider visualization by proximity or not.
cameraPosition	current position of the camera.
radius	radius around the camera position to visualize colliders.

UpdateDebugConfiguration()

virtual void PhysX::Debug::PhysXDebugInterface::UpdateDebugConfiguration ( const DebugConfiguration &  config )

pure virtual

Update the current debug configuration

Parameters

config

The configuration to use.

---

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

• Gems/PhysX/Code/Include/PhysX/Debug/PhysXDebugInterface.h