PxVisualDebugger Class Reference

Class to communicate with the PhysX Visual Debugger. More...

#include <PxVisualDebugger.h>

Public Member Functions
virtual void	disconnect ()=0
virtual void	checkConnection ()=0
virtual physx::debugger::comm::PvdConnection *	getPvdConnection ()=0
virtual physx::debugger::comm::PvdDataStream *	getPvdDataStream (const PxScene &scene)=0
PX_DEPRECATED void PX_INLINE	setVisualizeConstraints (bool inViz)
PX_DEPRECATED bool PX_INLINE	isVisualizingConstraints ()
virtual void	setVisualDebuggerFlag (PxVisualDebuggerFlag::Enum flag, bool value)=0
virtual void	setVisualDebuggerFlags (PxVisualDebuggerFlags flags)=0
virtual PxU32	getVisualDebuggerFlags ()=0
virtual void	updateCamera (const char *name, const PxVec3 &origin, const PxVec3 &up, const PxVec3 &target)=0
virtual void	sendErrorMessage (PxErrorCode::Enum code, const char *message, const char *file, PxU32 line)=0
	send an error message to pvd. More...

Protected Member Functions
virtual	~PxVisualDebugger ()

Detailed Description

Class to communicate with the PhysX Visual Debugger.

Constructor & Destructor Documentation

virtual PxVisualDebugger::~PxVisualDebugger ( )

inlineprotectedvirtual

Member Function Documentation

virtual void PxVisualDebugger::checkConnection ( )

pure virtual

Checks if the connect state is paused. If it is, then this method will not return until the connection state changes or pvd disconnects.

virtual void PxVisualDebugger::disconnect ( )

pure virtual

Disconnects the SDK from the PhysX Visual Debugger application. If we are still connected, this will kill the entire debugger connection.

virtual physx::debugger::comm::PvdConnection* PxVisualDebugger::getPvdConnection ( )

pure virtual

returns the PVD connection that was passed to the SDK. returns NULL if no connection is present.

virtual physx::debugger::comm::PvdDataStream* PxVisualDebugger::getPvdDataStream ( const PxScene &  scene )

pure virtual

Parameters

scene

The scene of which the PVD data stream should be returned. returns the PVD data stream of a given scene. returns NULL if no data stream is present.

virtual PxU32 PxVisualDebugger::getVisualDebuggerFlags ( )

pure virtual

Retrieves the PVD flags. See PxVisualDebuggerFlags.

PX_DEPRECATED bool PX_INLINE PxVisualDebugger::isVisualizingConstraints ( )

inline

Deprecated:

Returns

True when constraint viz info is sent to PVD.

References PxVisualDebuggerFlag::eTRANSMIT_CONSTRAINTS.

virtual void PxVisualDebugger::sendErrorMessage ( PxErrorCode::Enum  code, const char *  message, const char *  file, PxU32  line  )

pure virtual

send an error message to pvd.

Parameters

code	Error code, see PxErrorCode
message	Message to display.
file	File error occured in.
line	Line number error occured on.

virtual void PxVisualDebugger::setVisualDebuggerFlag ( PxVisualDebuggerFlag::Enum  flag, bool  value  )

pure virtual

Sets the PVD flag. See PxVisualDebuggerFlags.

Parameters

flag	Flag to set.
value	value the flag gets set to.

virtual void PxVisualDebugger::setVisualDebuggerFlags ( PxVisualDebuggerFlags  flags )

pure virtual

Sets the PVD flags. See PxVisualDebuggerFlags.

Parameters

flags

Flags to set.

PX_DEPRECATED void PX_INLINE PxVisualDebugger::setVisualizeConstraints ( bool  inViz )

inline

Deprecated:

Controls if joint visualization info is sent to pvd.

Parameters

inViz

true if visualizations info is sent to PVD.

References PxVisualDebuggerFlag::eTRANSMIT_CONSTRAINTS.

virtual void PxVisualDebugger::updateCamera ( const char *  name, const PxVec3 &  origin, const PxVec3 &  up, const PxVec3 &  target  )

pure virtual

Updates the pose of a PVD camera.

Parameters

name	Name of camera to update.
origin	The origin of the camera.
up	The up vector of the camera. It should be the up vector of the game camera for PVD to update the view that matches the game. The default up vector is the world up vector for a fixed PVD camera view.
target	The target vector of the camera.

---

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

• PxVisualDebugger.h