PxPvd Class Reference
[Pvd]

PxPvd is the top-level class for the PVD framework, and the main customer interface for PVD configuration.It is a singleton class, instantiated and owned by the application. More...

#include <PxPvd.h>

Inheritance diagram for PxPvd:

[legend]

Collaboration diagram for PxPvd:

[legend]

List of all members.

Public Member Functions
virtual bool	connect (PxPvdTransport &transport, PxPvdInstrumentationFlags flags)=0
virtual void	disconnect ()=0
virtual bool	isConnected (bool useCachedStatus=true)=0
virtual PxPvdTransport *	getTransport ()=0
virtual PxPvdInstrumentationFlags	getInstrumentationFlags ()=0
virtual void	release ()=0
	Releases the pvd instance.
Protected Member Functions
virtual	~PxPvd ()

---

Detailed Description

PxPvd is the top-level class for the PVD framework, and the main customer interface for PVD configuration.It is a singleton class, instantiated and owned by the application.

---

Constructor & Destructor Documentation

virtual PxPvd::~PxPvd

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual bool PxPvd::connect	(	PxPvdTransport &	transport,
		PxPvdInstrumentationFlags	flags
	)			[pure virtual]

Connects the SDK to the PhysX Visual Debugger application.

Parameters:

	transport	transport for pvd captured data.
	flags	Flags to set. return True if success

virtual void PxPvd::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 PxPvdInstrumentationFlags PxPvd::getInstrumentationFlags

(

)

[pure virtual]

Retrieves the PVD flags. See PxPvdInstrumentationFlags.

virtual PxPvdTransport* PxPvd::getTransport

(

)

[pure virtual]

returns the PVD data transport returns NULL if no transport is present.

virtual bool PxPvd::isConnected

(

bool

useCachedStatus = true

)

[pure virtual]

Return if connection to PVD is created.

Parameters:

useCachedStatus

1> When useCachedStaus is false, isConnected() checks the lowlevel network status. This can be slow because it needs to lock the lowlevel network stream. If isConnected() is called frequently, the expense of locking can be significant. 2> When useCachedStatus is true, isConnected() checks the highlevel cached status with atomic access. It is faster than locking, but the status may be different from the lowlevel network with latency of up to one frame. The reason for this is that the cached status is changed inside socket listener, which is not called immediately when the lowlevel connection status changes.

virtual void PxPvd::release

(

)

[pure virtual]

Releases the pvd instance.

---

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

• PxPvd.h