HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
RAY_ProceduralFactory Class Reference

#include <RAY_ProceduralFactory.h>

Classes

class  ProcDefinition
 Class to create a procedural. More...
 

Public Member Functions

 RAY_ProceduralFactory ()
 
 ~RAY_ProceduralFactory ()
 
void initialize ()
 Initialize procedurals. More...
 
bool insert (ProcDefinition *def, bool replace_existing=true)
 
const ProcDefinitionfind (const UT_StringRef &name) const
 Look up a procedural by name. More...
 
void getList (UT_Array< const ProcDefinition * > &list) const
 Extract a list of procedural definitions. More...
 
size_t size () const
 Return number of procedurals. More...
 

Detailed Description

The procedural factory is used to store the definitions of all the procedurals in mantra. The factory is passed to the registerProcedural() method on plugins.

Examples:
RAY/RAY_DemoBox.C, RAY/RAY_DemoFile.C, RAY/RAY_DemoGT.C, RAY/RAY_DemoMountain.C, RAY/RAY_DemoSprite.C, RAY/RAY_DemoStamp.C, and RAY/RAY_DemoVolumeSphere.C.

Definition at line 27 of file RAY_ProceduralFactory.h.

Constructor & Destructor Documentation

RAY_ProceduralFactory::RAY_ProceduralFactory ( )
RAY_ProceduralFactory::~RAY_ProceduralFactory ( )

Member Function Documentation

const ProcDefinition* RAY_ProceduralFactory::find ( const UT_StringRef name) const

Look up a procedural by name.

void RAY_ProceduralFactory::getList ( UT_Array< const ProcDefinition * > &  list) const

Extract a list of procedural definitions.

void RAY_ProceduralFactory::initialize ( )

Initialize procedurals.

bool RAY_ProceduralFactory::insert ( ProcDefinition def,
bool  replace_existing = true 
)

Add a new procedural to the factory. The factory takes ownership of the definition. Returns whether the procedural was stored.

Setting HOUDINI_DSO_ERROR to 2 or greater will cause the procedurals to be printed out as they get added to mantra.

Examples:
RAY/RAY_DemoBox.C, RAY/RAY_DemoFile.C, RAY/RAY_DemoGT.C, RAY/RAY_DemoMountain.C, RAY/RAY_DemoSprite.C, RAY/RAY_DemoStamp.C, and RAY/RAY_DemoVolumeSphere.C.
size_t RAY_ProceduralFactory::size ( void  ) const
inline

Return number of procedurals.

Definition at line 87 of file RAY_ProceduralFactory.h.


The documentation for this class was generated from the following file: