RenderDebugInterface.h

Go to the documentation of this file.

//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2018 NVIDIA Corporation. All rights reserved.



#ifndef RENDER_DEBUG_INTERFACE_H
#define RENDER_DEBUG_INTERFACE_H

#include "ApexDefs.h"
#include "RenderDebugTyped.h" // include the header file containing the base class
#include "ApexInterface.h"
#include "Renderable.h"

#if PX_PHYSICS_VERSION_MAJOR == 3
#include "common/PxRenderBuffer.h"
#endif

#define RENDER_DEBUG_IFACE(ptr) ((ptr)->getRenderDebugInterface())

namespace nvidia
{

namespace apex
{
class UserRenderer;
class UserRenderResourceManager;

PX_PUSH_PACK_DEFAULT

#if PX_PHYSICS_VERSION_MAJOR == 3

class PhysXRenderBuffer : public PxRenderBuffer
{
public:
    PhysXRenderBuffer()
    {
        clear();
    }

    virtual uint32_t getNbPoints() const 
    {
        return mNbPoints;
    }

    virtual const PxDebugPoint* getPoints() const
    {
        return mPoints;
    }

    virtual uint32_t getNbLines() const
    {
        return mNbLines;
    }

    virtual const PxDebugLine* getLines() const 
    {
        return mLines;
    }

    virtual uint32_t getNbTriangles() const 
    {
        return mNbTriangles;
    }

    virtual const PxDebugTriangle* getTriangles() const 
    {
        return mTriangles;
    }

    virtual uint32_t getNbTexts() const 
    {
        return mNbTexts;
    }

    virtual const PxDebugText* getTexts() const 
    {
        return mTexts;
    }

    virtual void append(const PxRenderBuffer& other)
    {
        PX_UNUSED(other);
        PX_ALWAYS_ASSERT(); // this method not implemented!
    }

    virtual void clear() 
    {
        mNbPoints = 0;
        mPoints = NULL;
        mNbLines = 0;
        mLines = NULL;
        mNbTriangles = 0;
        mTriangles = NULL;
        mNbTexts = 0;
        mTexts = NULL;
    }

    uint32_t        mNbPoints;
    PxDebugPoint    *mPoints;
    uint32_t        mNbLines;
    PxDebugLine     *mLines;
    uint32_t        mNbTriangles;
    PxDebugTriangle *mTriangles;
    uint32_t        mNbTexts;
    PxDebugText     *mTexts;
};
#endif

class RenderDebugInterface : public ApexInterface, public Renderable
{
public:
    virtual void    setUseDebugRenderable(bool state) = 0;


#if PX_PHYSICS_VERSION_MAJOR == 3

    virtual void    getRenderBuffer(PhysXRenderBuffer& renderable) = 0;

    virtual void    getRenderBufferScreenSpace(PhysXRenderBuffer& renderable) = 0;

    virtual void    addDebugRenderable(const physx::PxRenderBuffer& renderBuffer) = 0;

#endif //PX_PHYSICS_VERSION_MAJOR == 3

    virtual void release() = 0;

    virtual RENDER_DEBUG::RenderDebugTyped* getRenderDebugInterface() = 0;
    
protected:

    virtual ~RenderDebugInterface(void) { };

};

PX_POP_PACK

}
} // end namespace nvidia::apex

#endif // RENDER_DEBUG_INTERFACE_H