PhysX SDK 3.2 API Reference: PxVisualDebuggerExt Class Reference

PhysX SDK 3.2 API

PxVisualDebuggerExt Class Reference
[Extensions]

#include <PxVisualDebuggerExt.h>

List of all members.


Static Public Member Functions

static PVD::PvdConnection * createConnection (physx::debugger::comm::PvdConnectionManager *inMgr, const char *inHost, int inPort, unsigned int inTimeoutInMilliseconds, PxVisualDebuggerConnectionFlags inConnectionType=getDefaultConnectionFlags())
static PVD::PvdConnection * createConnection (physx::debugger::comm::PvdConnectionManager *inMgr, const char *filename, PxVisualDebuggerConnectionFlags inConnectionType=getDefaultConnectionFlags())
static PX_FORCE_INLINE
PxVisualDebuggerConnectionFlags 
getDefaultConnectionFlags ()
static PX_FORCE_INLINE
PxVisualDebuggerConnectionFlags 
getAllConnectionFlags ()

Detailed Description

class that contains all the data relevant for updating and visualizing extensions like joints in PVD

Member Function Documentation

static PVD::PvdConnection* PxVisualDebuggerExt::createConnection ( physx::debugger::comm::PvdConnectionManager *  inMgr,
const char *  filename,
PxVisualDebuggerConnectionFlags  inConnectionType = getDefaultConnectionFlags() 
) [static]

Connect to pvd, writing out the connection data to a file stream. You can then parse this data later with PVDUI.

Parameters:
inMgr The manager to use to host the connection.
filename The filename to write connection data.
inConnectionType The type information you want sent over the connection.

static PVD::PvdConnection* PxVisualDebuggerExt::createConnection ( physx::debugger::comm::PvdConnectionManager *  inMgr,
const char *  inHost,
int  inPort,
unsigned int  inTimeoutInMilliseconds,
PxVisualDebuggerConnectionFlags  inConnectionType = getDefaultConnectionFlags() 
) [static]

Connect to pvd using a network socket. This blocks for at most inTimeoutInMilliseconds before returning a new connection (or nothing). PVD needs to be started before this call is made.

Parameters:
inMgr The manager to use to host the connection.
inHost Host in x.x.x.x network notation
inPort Port to connect to. The default is 5425.
inTimeoutInMilliseconds How long to block waiting for a new connection
inConnectionType The type information you want sent over the connection.

static PX_FORCE_INLINE PxVisualDebuggerConnectionFlags PxVisualDebuggerExt::getAllConnectionFlags (  )  [inline, static]

get all connection flags

Returns:
all visual debugger connection flags: debug data, profiling and memory

References PxVisualDebuggerConnectionFlag::Debug, PxVisualDebuggerConnectionFlag::Memory, and PxVisualDebuggerConnectionFlag::Profile.

static PX_FORCE_INLINE PxVisualDebuggerConnectionFlags PxVisualDebuggerExt::getDefaultConnectionFlags (  )  [inline, static]

get the default connection flags

Returns:
the default connection flags: debug data and profiling

References PxVisualDebuggerConnectionFlag::Debug, and PxVisualDebuggerConnectionFlag::Profile.


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