HDK_Sample::VRAY_DemoVolumeSphere Class Reference

Example of a custom volume primitive. More...

#include <VRAY_DemoVolumeSphere.h>

Inheritance diagram for HDK_Sample::VRAY_DemoVolumeSphere:

List of all members.

Public Member Functions
	VRAY_DemoVolumeSphere ()
virtual	~VRAY_DemoVolumeSphere ()
virtual const char *	getClassName ()
virtual bool	hasVolume ()
	For volume primitives, return true.
virtual int	initialize (const UT_BoundingBox *box)
virtual void	getBoundingBox (UT_BoundingBox &box)
	The bounding box is the "object space" bounds of the procedural.
virtual void	render ()

---

Detailed Description

Example of a custom volume primitive.

Examples:

VRAY/VRAY_DemoVolumeSphere.C.

Definition at line 39 of file VRAY_DemoVolumeSphere.h.

---

Constructor & Destructor Documentation

VRAY_DemoVolumeSphere::VRAY_DemoVolumeSphere

(

)

Examples:

VRAY/VRAY_DemoVolumeSphere.C, and VRAY/VRAY_DemoVolumeSphere.h.

Definition at line 140 of file VRAY_DemoVolumeSphere.C.

VRAY_DemoVolumeSphere::~VRAY_DemoVolumeSphere

(

)

[virtual]

Examples:

VRAY/VRAY_DemoVolumeSphere.C, and VRAY/VRAY_DemoVolumeSphere.h.

Definition at line 144 of file VRAY_DemoVolumeSphere.C.

---

Member Function Documentation

void VRAY_DemoVolumeSphere::getBoundingBox

(

UT_BoundingBox &

box

)

[virtual]

The bounding box is the "object space" bounds of the procedural.

Implements VRAY_Procedural.

Examples:

VRAY/VRAY_DemoVolumeSphere.C, and VRAY/VRAY_DemoVolumeSphere.h.

Definition at line 159 of file VRAY_DemoVolumeSphere.C.

virtual const char* HDK_Sample::VRAY_DemoVolumeSphere::getClassName

(

)

[inline, virtual]

The class name is used in diagnostic messages. It can simply be the name of the class, or alternatively, you can choose a unique name for each procedural instance.

Implements VRAY_Procedural.

Examples:

VRAY/VRAY_DemoVolumeSphere.h.

Definition at line 44 of file VRAY_DemoVolumeSphere.h.

virtual bool HDK_Sample::VRAY_DemoVolumeSphere::hasVolume

(

)

[inline, virtual]

For volume primitives, return true.

Examples:

VRAY/VRAY_DemoVolumeSphere.h.

Definition at line 47 of file VRAY_DemoVolumeSphere.h.

int VRAY_DemoVolumeSphere::initialize

(

const UT_BoundingBox *

box

)

[virtual]

The initialize method is called when the procedural is created. Returning zero (failure) will abort the rendering of this procedural.

The bounding box passed in is the user defined bounding box. If the user didn't specify a bounding box, then the box will be NULL.

Implements VRAY_Procedural.

Examples:

VRAY/VRAY_DemoVolumeSphere.C, and VRAY/VRAY_DemoVolumeSphere.h.

Definition at line 149 of file VRAY_DemoVolumeSphere.C.

void VRAY_DemoVolumeSphere::render

(

)

[virtual]

The render method is called when the procedural is required to either generate geometry or split into more procedurals. The level of detail passed in represents the rough screen space projection of the procedural's bounding box. The value is roughly the number of pixels that the bounding box occupies (modified by the LEVEL OF DETAIL rate).

For example, if a box occupies 10 horizontal pixels and 20 vertical pixels, the lod passed in will be roughly 20 (the maximum bounds occupied in screen space). If the object surrounds the camera, the lod will be clamped at a large number.

Note:

The render method may be called more than once during a render to regenerate the geometry.

Implements VRAY_Procedural.

Examples:

VRAY/VRAY_DemoVolumeSphere.C, and VRAY/VRAY_DemoVolumeSphere.h.

Definition at line 165 of file VRAY_DemoVolumeSphere.C.

---

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

• samples/VRAY/VRAY_DemoVolumeSphere.h
• samples/VRAY/VRAY_DemoVolumeSphere.C