PxVisualDebugger.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2015, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  


#ifndef PX_VISUALDEBUGGER_H
#define PX_VISUALDEBUGGER_H


#ifdef PX_SUPPORT_VISUAL_DEBUGGER
#define PX_SUPPORT_VISUAL_DEBUGGER 1
#include "foundation/PxSimpleTypes.h"
#include "foundation/PxVec3.h"
#else
#define PX_SUPPORT_VISUAL_DEBUGGER 0
#endif

#include "foundation/PxTransform.h"
#include "foundation/PxErrors.h"
#include "foundation/PxFlags.h"

#ifndef PX_DOXYGEN
namespace physx { namespace debugger { namespace comm {
#endif
    class PvdDataStream;
    class PvdConnection;
#ifndef PX_DOXYGEN
}}}
#endif

#ifndef PX_DOXYGEN
namespace physx
{
#endif

class PxScene;

struct PxVisualDebuggerFlag
{
    enum Enum
    {
        eTRANSMIT_CONTACTS      = (1 << 0), 
        eTRANSMIT_SCENEQUERIES  = (1 << 1), 
        eTRANSMIT_CONSTRAINTS   = (1 << 2)  
    };
};

typedef PxFlags<PxVisualDebuggerFlag::Enum, PxU8> PxVisualDebuggerFlags;
PX_FLAGS_OPERATORS(PxVisualDebuggerFlag::Enum, PxU8)



class PxVisualDebugger
{
public:

    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 )  { setVisualDebuggerFlag(PxVisualDebuggerFlag::eTRANSMIT_CONSTRAINTS, inViz); }
    PX_DEPRECATED bool PX_INLINE isVisualizingConstraints() { return (getVisualDebuggerFlags() & PxVisualDebuggerFlag::eTRANSMIT_CONSTRAINTS) != 0;}

    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;

protected:
    virtual ~PxVisualDebugger() {}
};

#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif // PX_VISUALDEBUGGER_H