HUSD_RenderProduct Class Reference

#include <HUSD_RenderSettings.h>

Inheritance diagram for HUSD_RenderProduct:

Public Member Functions
	HUSD_RenderProduct ()
virtual	~HUSD_RenderProduct ()
virtual UT_UniquePtr < HUSD_RenderVar >	newRenderVar () const
	Allocate a new render variable for this product. More...
virtual UT_StringHolder	defaultFilename () const
	Provide a default filename. More...
HUSD_RenderSettingsContext::storeProperty	writer ()
	Create a "writer" to store settings in this objects settings. More...
void	copySetting (const HUSD_RenderSettings &settings, const char *token)
void	addRenderVars (const UT_Array< const HUSD_RenderVar * > &vars)
	Clone from a list of render vars. More...
bool	isRaster () const
	Test if the render product is a raster product. More...
void	addMetaData (IMG_FileParms &fparms) const
	Add meta data to the IMG_FileParms. More...
bool	lookup (const char *token, int64 &val) const
bool	lookup (const char *token, fpreal64 &val) const
bool	lookup (const char *token, UT_Vector2i &val) const
bool	lookup (const char *token, UT_StringHolder &val) const
exint	size () const
const HUSD_RenderVar *	renderVar (exint i) const
UT_StringHolder	productType () const
UT_StringHolder	productName (int frame=0) const
UT_StringHolder	outputName () const
UT_StringHolder	fullOutputName () const
void	dump () const
void	dump (UT_JSONWriter &w) const

Protected Member Functions
const UT_StringHolder &	filename () const
const UT_StringHolder &	partname () const
Protected Member Functions inherited from UT_NonCopyableNS::UT_NonCopyable
	UT_NonCopyable ()=default
	~UT_NonCopyable ()=default
	UT_NonCopyable (const UT_NonCopyable &)=delete
UT_NonCopyable &	operator= (const UT_NonCopyable &)=delete

Detailed Description

Definition at line 256 of file HUSD_RenderSettings.h.

Constructor & Destructor Documentation

HUSD_RenderProduct::HUSD_RenderProduct

(

)

virtual HUSD_RenderProduct::~HUSD_RenderProduct ( )

virtual

Member Function Documentation

void HUSD_RenderProduct::addMetaData

(

IMG_FileParms &

fparms

)

const

Add meta data to the IMG_FileParms.

void HUSD_RenderProduct::addRenderVars

(

const UT_Array< const HUSD_RenderVar * > &

vars

)

Clone from a list of render vars.

void HUSD_RenderProduct::copySetting	(	const HUSD_RenderSettings &	settings,
		const char *	token
	)

Copy a property from the render settings to this render product This is typically used during initialization (before the USD product settings are applied).

virtual UT_StringHolder HUSD_RenderProduct::defaultFilename ( ) const

inlinevirtual

Provide a default filename.

Definition at line 267 of file HUSD_RenderSettings.h.

void HUSD_RenderProduct::dump

(

)

const

For debugging

void HUSD_RenderProduct::dump

(

UT_JSONWriter &

w

)

const

For debugging

const UT_StringHolder& HUSD_RenderProduct::filename ( ) const

protected

UT_StringHolder HUSD_RenderProduct::fullOutputName

(

)

const

Query methods

bool HUSD_RenderProduct::isRaster

(

)

const

Test if the render product is a raster product.

bool HUSD_RenderProduct::lookup	(	const char *	token,
		int64 &	val
	)		const

Query settings on the underlying render settings map

bool HUSD_RenderProduct::lookup	(	const char *	token,
		fpreal64 &	val
	)		const

Query settings on the underlying render settings map

bool HUSD_RenderProduct::lookup	(	const char *	token,
		UT_Vector2i &	val
	)		const

Query settings on the underlying render settings map

bool HUSD_RenderProduct::lookup	(	const char *	token,
		UT_StringHolder &	val
	)		const

Query settings on the underlying render settings map

virtual UT_UniquePtr<HUSD_RenderVar> HUSD_RenderProduct::newRenderVar ( ) const

virtual

Allocate a new render variable for this product.

UT_StringHolder HUSD_RenderProduct::outputName

(

)

const

Query methods

const UT_StringHolder& HUSD_RenderProduct::partname ( ) const

protected

UT_StringHolder HUSD_RenderProduct::productName

(

int

frame = 0

)

const

Query methods

UT_StringHolder HUSD_RenderProduct::productType

(

)

const

Query methods

const HUSD_RenderVar* HUSD_RenderProduct::renderVar

(

exint

i

)

const

Access render vars

exint HUSD_RenderProduct::size

(

)

const

Access render vars

HUSD_RenderSettingsContext::storeProperty HUSD_RenderProduct::writer

(

)

Create a "writer" to store settings in this objects settings.

---

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

• HUSD/HUSD_RenderSettings.h