PVDBinding.h

// This code contains NVIDIA Confidential Information and is disclosed to you
// under a form of NVIDIA software license agreement provided separately to you.
//
// Notice
// NVIDIA Corporation and its licensors retain all intellectual property and
// proprietary rights in and to this software and 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.
//
// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
//
// Information and code furnished is believed to be accurate and reliable.
// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2008-2014 NVIDIA Corporation. All rights reserved.

#ifndef PVDBINDING_H
#define PVDBINDING_H

#include "foundation/Px.h"
#include "physxvisualdebuggersdk/PvdConnectionFlags.h"
#include "NxApexDefs.h"


#define DEFAULT_PVD_BINDING_PORT 5425
#define DEFAULT_PVD_BINDING_TIMEOUT_MS 100

#define APEX_PVD_NAMESPACE "Apex"


namespace NxParameterized
{
    class Interface;
    class Definition;
    class Handle;
}

namespace physx 
{
    class PxProfileZoneManager;

    namespace debugger 
    {
        namespace comm 
        {
            class PvdConnectionManager;
            class PvdConnection;
            class PvdDataStream;
        }
        namespace renderer
        {
            class PvdImmediateRenderer;
        }
    }
}

namespace PVD
{
    struct PvdAction
    {
        enum Enum
        {
            UPDATE,

            DESTROY
        };
    };



    class PvdBinding
    {
    protected:
        virtual ~PvdBinding(){}
    public:
        virtual physx::debugger::comm::PvdConnectionManager& getConnectionManager() = 0;

        virtual physx::PxProfileZoneManager& getProfileManager() = 0;

        virtual bool isConnected() = 0;

        virtual physx::debugger::TConnectionFlagsType getConnectionType() = 0;

        virtual void disconnect() = 0;

        virtual void beginFrame( void* inInstanceId ) = 0;

        virtual void endFrame( void* inInstanceId ) = 0;
        
        virtual void release() = 0;
        virtual void connect( const char* inHost
                            , int inPort = DEFAULT_PVD_BINDING_PORT
                            , unsigned int inTimeoutInMilliseconds = DEFAULT_PVD_BINDING_TIMEOUT_MS
                            //If we are using the debug connection type, we tunnel through the
                            //older debugger.  Else we don't and connect directly to pvd without
                            //using the older debugger.
                            , physx::debugger::TConnectionFlagsType inConnectionType = physx::debugger::defaultConnectionFlags() ) = 0;

        virtual physx::debugger::comm::PvdDataStream* getDataStream() = 0;

        virtual physx::debugger::renderer::PvdImmediateRenderer* getRenderer() = 0;

        virtual void initPvdClasses() = 0;

        virtual void initPvdInstances() = 0;

        virtual void initPvdClasses(const NxParameterized::Definition& paramsHandle, const char* pvdClassName) = 0;

        virtual void updatePvd(const void* pvdInstance, NxParameterized::Interface& params, PvdAction::Enum pvdAction = PvdAction::UPDATE) = 0;
        
        virtual void lock() = 0;

        virtual void unlock() = 0;

        static PvdBinding* create( physx::debugger::comm::PvdConnectionManager& inConnectionManager, physx::PxProfileZoneManager& inProfileManager );

        static PvdBinding* create( bool inRecordMemoryEvents );
    };

}



#endif // PVDBINDING_H