PhysX SDK 3.2 API Reference: PxVisualDebugger Class Reference

PhysX SDK 3.2 API

PxVisualDebugger Class Reference
[Pvd]

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

#include <PxVisualDebugger.h>

List of all members.


Public Member Functions

virtual void disconnect ()=0
virtual void checkConnection ()=0
virtual
physx::debugger::comm::PvdConnection * 
getPvdConnectionFactory ()=0
virtual
physx::debugger::comm::PvdDataStream * 
getPvdConnection (const PxScene &scene)=0
virtual void setVisualizeConstraints (bool inViz)=0
virtual bool isVisualizingConstraints ()=0
virtual void setVisualDebuggerFlag (PxVisualDebuggerFlags::Enum flag, bool value)=0
virtual PxU32 getVisualDebuggerFlags ()=0
virtual void updateCamera (const char *name, const PxVec3 &origin, const PxVec3 &up, const PxVec3 &target)=0

Protected Member Functions

virtual ~PxVisualDebugger ()

Detailed Description

Class to communicate with the PhysX Visual Debugger.

Constructor & Destructor Documentation

virtual PxVisualDebugger::~PxVisualDebugger (  )  [inline, protected, virtual]


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::PvdDataStream* PxVisualDebugger::getPvdConnection ( const PxScene scene  )  [pure virtual]

Parameters:
scene The scene of which the PVD connection should be returned. returns the PVD connection of a given scene. returns NULL if no connection is present.

virtual physx::debugger::comm::PvdConnection* PxVisualDebugger::getPvdConnectionFactory (  )  [pure virtual]

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

virtual PxU32 PxVisualDebugger::getVisualDebuggerFlags (  )  [pure virtual]

Retrieves the PVD flags. See PxVisualDebuggerFlags.

virtual bool PxVisualDebugger::isVisualizingConstraints (  )  [pure virtual]

/return True when constraint viz info is sent to PVD.

virtual void PxVisualDebugger::setVisualDebuggerFlag ( PxVisualDebuggerFlags::Enum  flag,
bool  value 
) [pure virtual]

Sets the PVD flags. See PxVisualDebuggerFlags. /param flag Flag to set. /param value value the flag gets set to.

virtual void PxVisualDebugger::setVisualizeConstraints ( bool  inViz  )  [pure virtual]

Controls if joint visualization info is sent to pvd. /param inViz true if visualizations info is sent to PVD.

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.
target The target vector of the camera. returns true if operation was successful.


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



Copyright © 2008-2012 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com