HDK_Sample::VRAY_DemoFile Class Reference
A procedural which does a deferred load of geometry from disk. More...
#include <VRAY_DemoFile.h>
Public Member Functions | |
| VRAY_DemoFile () | |
| virtual | ~VRAY_DemoFile () |
| virtual const char * | getClassName () |
| virtual int | initialize (const UT_BoundingBox *) |
| virtual void | getBoundingBox (UT_BoundingBox &box) |
| The bounding box is the "object space" bounds of the procedural. | |
| virtual void | render () |
Detailed Description
A procedural which does a deferred load of geometry from disk.- Examples:
Definition at line 39 of file VRAY_DemoFile.h.
Constructor & Destructor Documentation
| VRAY_DemoFile::VRAY_DemoFile | ( | ) |
| VRAY_DemoFile::~VRAY_DemoFile | ( | ) | [virtual] |
Member Function Documentation
| void VRAY_DemoFile::getBoundingBox | ( | UT_BoundingBox & | box | ) | [virtual] |
The bounding box is the "object space" bounds of the procedural.
Implements VRAY_Procedural.
- Examples:
- VRAY/VRAY_DemoFile.C, and VRAY/VRAY_DemoFile.h.
Definition at line 114 of file VRAY_DemoFile.C.
| const char * VRAY_DemoFile::getClassName | ( | ) | [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_DemoFile.C, and VRAY/VRAY_DemoFile.h.
Definition at line 66 of file VRAY_DemoFile.C.
| int VRAY_DemoFile::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_DemoFile.C, and VRAY/VRAY_DemoFile.h.
Definition at line 72 of file VRAY_DemoFile.C.
| void VRAY_DemoFile::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_DemoFile.C, and VRAY/VRAY_DemoFile.h.
Definition at line 120 of file VRAY_DemoFile.C.
The documentation for this class was generated from the following files:
- samples/VRAY/VRAY_DemoFile.h
- samples/VRAY/VRAY_DemoFile.C
