Module.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 MODULE_H
#define MODULE_H

#include "ApexInterface.h"
#include "ApexSDK.h"
#include "foundation/PxSimpleTypes.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

class RenderableIterator;

struct RenderLockMode
{
    enum Enum
    {
        NO_RENDER_LOCK                  = 0,

        PER_ACTOR_RENDER_LOCK           = 1,

        PER_MODULE_SCENE_RENDER_LOCK    = 2,
    };
};

template <typename T>
struct Range
{
    Range() {};
    Range(T inMin, T inMax) : minimum(inMin), maximum(inMax) {};

    bool operator== (const Range& r) const
    {
        return minimum == r.minimum && maximum == r.maximum;
    }

    T minimum;
    T maximum;
};



class Module : public ApexInterface
{
public:
    virtual void init(::NvParameterized::Interface& desc) = 0;

    virtual const char* getName() const = 0;

    virtual AuthObjTypeID getModuleID() const = 0;

    virtual ::NvParameterized::Interface* getDefaultModuleDesc()
    {
        return NULL;
    }

    virtual RenderableIterator* createRenderableIterator(const Scene&) = 0;

    virtual bool setRenderLockMode(RenderLockMode::Enum, Scene&) { return false; }

    virtual RenderLockMode::Enum getRenderLockMode(const Scene&) const { return RenderLockMode::NO_RENDER_LOCK; }

    virtual bool lockModuleSceneRenderLock(Scene&) { return false; }

    virtual bool unlockModuleSceneRenderLock(Scene&) { return false; }
};

PX_POP_PACK

}
} // end namespace nvidia::apex

#endif // MODULE_H