Module.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2017, 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.
 */


#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