VRAY/VRAY_Procedural.h File Reference

#include "VRAY_API.h"
#include <SYS/SYS_Types.h>
#include <UT/UT_Matrix4.h>
#include <UT/UT_String.h>

Go to the source code of this file.

Classes
class	VRAY_ProceduralArg
	Parameter definition for arguments to VRAY_Procedural. More...
class	VRAY_Procedural
	Procedural primitive for mantra (VRAY). More...
Functions
SYS_VISIBILITY_EXPORT VRAY_Procedural *	allocProcedural (const char *name)
	Mantra procedural primitives.
SYS_VISIBILITY_EXPORT const VRAY_ProceduralArg *	getProceduralArgs (const char *n)
	Dynamic load entry point to query arguments for a procedural.

---

Function Documentation

SYS_VISIBILITY_EXPORT VRAY_Procedural* allocProcedural

(

const char *

name

)

Mantra procedural primitives.

When a procedural is defined as a dynamic object, the allocProcedural() function is called to build a new instance of the procedural. The name passed in will be the name defined by the table entry. This can be used for: a) Error checking -- you can verify that you're name is what you expect. However, this isn't manditory. b) To have more than one procedural defined per C++ class. Using the name, you can create procedurals of different types.

The argument list for the procedural is specified by a list of arguments. The getProceduralArgs() method should return a pointer to an array of VRAY_ProceduralArg's. The list should be terminated by an entry with default arguments (i.e. null pointers). For example: Arguments can then be queried using the argValue() methods in the procedural Dynamic load entry point to create an instance

Examples:

VRAY/VRAY_DemoBox.C, VRAY/VRAY_DemoFile.C, VRAY/VRAY_DemoMountain.C, VRAY/VRAY_DemoSprite.C, VRAY/VRAY_DemoStamp.C, and VRAY/VRAY_DemoVolumeSphere.C.

Definition at line 43 of file VRAY_DemoBox.C.

SYS_VISIBILITY_EXPORT const VRAY_ProceduralArg* getProceduralArgs

(

const char *

n

)

Dynamic load entry point to query arguments for a procedural.

Examples:

VRAY/VRAY_DemoBox.C, VRAY/VRAY_DemoFile.C, VRAY/VRAY_DemoMountain.C, VRAY/VRAY_DemoSprite.C, VRAY/VRAY_DemoStamp.C, and VRAY/VRAY_DemoVolumeSphere.C.

Definition at line 49 of file VRAY_DemoBox.C.