RAY_ProceduralFactory::ProcDefinition Class Reference

Class to create a procedural. More...

#include <RAY_ProceduralFactory.h>

Inheritance diagram for RAY_ProceduralFactory::ProcDefinition:

Public Member Functions
	ProcDefinition (const UT_StringHolder &name)
virtual	~ProcDefinition ()
const UT_StringHolder &	name () const
	Name of the procedural. More...
const UT_StringHolder &	dsoname () const
	Query which DSO file was used to define this procedural. More...
void	setDSOName (const UT_StringHolder &dso)
virtual RAY_Procedural *	create () const =0
	Create a procedural, and pass ownership of the instance to mantra. More...
virtual const RAY_ProceduralArg *	arguments () const =0
	Provide a const reference to the arguments for the procedural. More...
VPRM_Stack &	stack () const
UT_Lock &	lock () const

Detailed Description

Class to create a procedural.

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 34 of file RAY_ProceduralFactory.h.

Constructor & Destructor Documentation

RAY_ProceduralFactory::ProcDefinition::ProcDefinition

(

const UT_StringHolder &

name

)

virtual RAY_ProceduralFactory::ProcDefinition::~ProcDefinition ( )

virtual

Member Function Documentation

virtual const RAY_ProceduralArg* RAY_ProceduralFactory::ProcDefinition::arguments ( ) const

pure virtual

Provide a const reference to the arguments for the procedural.

Implemented in ProcDef, ProcDef, ProcDef, ProcDef, ProcDef, ProcDef, and ProcDef.

virtual RAY_Procedural* RAY_ProceduralFactory::ProcDefinition::create ( ) const

pure virtual

Create a procedural, and pass ownership of the instance to mantra.

Implemented in ProcDef, ProcDef, ProcDef, ProcDef, ProcDef, ProcDef, and ProcDef.

const UT_StringHolder& RAY_ProceduralFactory::ProcDefinition::dsoname ( ) const

inline

Query which DSO file was used to define this procedural.

Definition at line 44 of file RAY_ProceduralFactory.h.

UT_Lock& RAY_ProceduralFactory::ProcDefinition::lock ( ) const

inline

Access to internals

Definition at line 60 of file RAY_ProceduralFactory.h.

const UT_StringHolder& RAY_ProceduralFactory::ProcDefinition::name ( void  ) const

inline

Name of the procedural.

Definition at line 41 of file RAY_ProceduralFactory.h.

void RAY_ProceduralFactory::ProcDefinition::setDSOName ( const UT_StringHolder &  dso )

inline

Set the DSO file. This is only required for old-school procedural definitions.

Definition at line 48 of file RAY_ProceduralFactory.h.

VPRM_Stack& RAY_ProceduralFactory::ProcDefinition::stack ( ) const

inline

Access to internals

Definition at line 59 of file RAY_ProceduralFactory.h.

---

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

• RAY/RAY_ProceduralFactory.h