HDK_Sample::ROP_Dumper Class Reference

#include <ROP_Dumper.h>

Inheritance diagram for HDK_Sample::ROP_Dumper:

List of all members.

Public Member Functions
void	OUTPUT (UT_String &str, float t)
	A convenience method to evaluate our custom file parameter.
Static Public Member Functions
static OP_TemplatePair *	getTemplatePair ()
	Provides access to our parm templates.
static OP_VariablePair *	getVariablePair ()
	Provides access to our variables.
static OP_Node *	myConstructor (OP_Network *net, const char *name, OP_Operator *op)
	Creates an instance of this node.
Protected Member Functions
	ROP_Dumper (OP_Network *net, const char *name, OP_Operator *entry)
virtual	~ROP_Dumper ()
virtual int	startRender (int nframes, float s, float e)
virtual ROP_RENDER_CODE	renderFrame (float time, UT_Interrupt *boss)
virtual ROP_RENDER_CODE	endRender ()

---

Detailed Description

Definition at line 46 of file ROP_Dumper.h.

---

Constructor & Destructor Documentation

ROP_Dumper::ROP_Dumper	(	OP_Network *	net,
		const char *	name,
		OP_Operator *	entry
	)			[protected]

Examples:

ROP/ROP_Dumper.C, and ROP/ROP_Dumper.h.

Definition at line 100 of file ROP_Dumper.C.

ROP_Dumper::~ROP_Dumper

(

)

[protected, virtual]

Examples:

ROP/ROP_Dumper.h.

Definition at line 109 of file ROP_Dumper.C.

---

Member Function Documentation

ROP_RENDER_CODE ROP_Dumper::endRender

(

)

[protected, virtual]

Called after the rendering is done to perform any post-rendering steps required.

Returns:

Return a status code indicating whether to abort the render, continue, or retry.

Reimplemented from ROP_Node.

Examples:

ROP/ROP_Dumper.C, and ROP/ROP_Dumper.h.

Definition at line 161 of file ROP_Dumper.C.

OP_TemplatePair * ROP_Dumper::getTemplatePair

(

)

[static]

Provides access to our parm templates.

Examples:

ROP/ROP_Dumper.C, and ROP/ROP_Dumper.h.

Definition at line 72 of file ROP_Dumper.C.

OP_VariablePair * ROP_Dumper::getVariablePair

(

)

[static]

Provides access to our variables.

Examples:

ROP/ROP_Dumper.C, and ROP/ROP_Dumper.h.

Definition at line 86 of file ROP_Dumper.C.

OP_Node * ROP_Dumper::myConstructor	(	OP_Network *	net,
		const char *	name,
		OP_Operator *	op
	)			[static]

Creates an instance of this node.

Examples:

ROP/ROP_Dumper.C, and ROP/ROP_Dumper.h.

Definition at line 95 of file ROP_Dumper.C.

void HDK_Sample::ROP_Dumper::OUTPUT	(	UT_String &	str,
		float	t
	)			[inline]

A convenience method to evaluate our custom file parameter.

Examples:

ROP/ROP_Dumper.C, and ROP/ROP_Dumper.h.

Definition at line 85 of file ROP_Dumper.h.

ROP_RENDER_CODE ROP_Dumper::renderFrame	(	float	time,
		UT_Interrupt *	boss
	)			[protected, virtual]

Called once for every frame that is rendered.

Parameters:

	time	The time to render at.
	boss	Interrupt handler.

Returns:

Return a status code indicating whether to abort the render, continue, or retry the current frame.

Reimplemented from ROP_Node.

Examples:

ROP/ROP_Dumper.C, and ROP/ROP_Dumper.h.

Definition at line 139 of file ROP_Dumper.C.

int ROP_Dumper::startRender	(	int	nframes,
		float	s,
		float	e
	)			[protected, virtual]

Called at the beginning of rendering to perform any intialization necessary.

Parameters:

	nframes	Number of frames being rendered.
	s	Start time, in seconds.
	e	End time, in seconds.

Returns:

True of success, false on failure (aborts the render).

Reimplemented from ROP_Node.

Examples:

ROP/ROP_Dumper.C, and ROP/ROP_Dumper.h.

Definition at line 118 of file ROP_Dumper.C.

---

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

• samples/ROP/ROP_Dumper.h
• samples/ROP/ROP_Dumper.C