base class of all APEX modules More...
#include <Module.h>
Inheritance diagram for nvidia::apex::Module:
Public Member Functions | |
| virtual void | init (::NvParameterized::Interface &desc)=0 |
| Initialize the module. | |
| virtual const char * | getName () const =0 |
| Returns the name of the module. | |
| virtual AuthObjTypeID | getModuleID () const =0 |
| Returns the unique ID of the module. | |
| virtual ::NvParameterized::Interface * | getDefaultModuleDesc () |
| Returns the NvParameterized interface that contains module initialization parameters. | |
| virtual RenderableIterator * | createRenderableIterator (const Scene &)=0 |
| Allocate a renderable iterator. | |
| virtual bool | setRenderLockMode (RenderLockMode::Enum, Scene &) |
| Choose the locking mode for the module scene. See RenderLockMode. | |
| virtual RenderLockMode::Enum | getRenderLockMode (const Scene &) const |
| Returns the current render lock mode for the module scene. | |
| virtual bool | lockModuleSceneRenderLock (Scene &) |
| Sets a render lock for the module scene. Used when the SDK render lock mode is RenderLockMode::PER_MODULE_SCENE_RENDER_LOCK. See ApexSDK::setRenderLockMode(). | |
| virtual bool | unlockModuleSceneRenderLock (Scene &) |
| Releases the render lock for the module scene. See lockModuleSceneRenderLock(). | |
Detailed Description
base class of all APEX modules
It describes the LODParameters and weights defined by the module.
Member Function Documentation
| virtual RenderableIterator* nvidia::apex::Module::createRenderableIterator | ( | const Scene & | ) | [pure virtual] |
Allocate a renderable iterator.
Returns an Renderable iterator instance for the specified Scene. The iterator will return pointers to renderables in this scene that were generated by this module. This is the preferred method for rendering IOFX actors.
| virtual ::NvParameterized::Interface* nvidia::apex::Module::getDefaultModuleDesc | ( | ) | [inline] |
Returns the NvParameterized interface that contains module initialization parameters.
- Note:
- The module itself owns this object, so there's no need for the application to destroy it
| virtual void nvidia::apex::Module::init | ( | ::NvParameterized::Interface & | desc | ) | [pure virtual] |
Initialize the module.
- Parameters:
-
[in] desc use Module::getDefaultModuleDesc() to get the descriptor necessary for initializing the module
| virtual bool nvidia::apex::Module::lockModuleSceneRenderLock | ( | Scene & | ) | [inline, virtual] |
Sets a render lock for the module scene. Used when the SDK render lock mode is RenderLockMode::PER_MODULE_SCENE_RENDER_LOCK. See ApexSDK::setRenderLockMode().
Returns true iff successful.
| virtual bool nvidia::apex::Module::setRenderLockMode | ( | RenderLockMode::Enum | , |
| Scene & | |||
| ) | [inline, virtual] |
Choose the locking mode for the module scene. See RenderLockMode.
Returns true if successful.
| virtual bool nvidia::apex::Module::unlockModuleSceneRenderLock | ( | Scene & | ) | [inline, virtual] |
Releases the render lock for the module scene. See lockModuleSceneRenderLock().
Returns true iff successful.
The documentation for this class was generated from the following file:
