#include <HUSD_OutputProcessor.h>

Public Types
enum	HUSD_ShouldSave { SHOULD_SAVE_FALSE = 0, SHOULD_SAVE_TRUE = 1, SHOULD_SAVE_NO_OPINION = 2 }

Public Member Functions
virtual	~HUSD_OutputProcessor ()=default
	Standard virtual destructor for this abstract base class. More...

virtual void	beginSave (OP_Node config_node, const UT_Options &config_overrides, OP_Node lop_node, fpreal t, const UT_Options &stage_variables, UT_String &error)

virtual void	endSave (OP_Node config_node, const UT_Options &config_overrides, OP_Node lop_node, fpreal t, const UT_Options &stage_variables, const UT_StringArray &saved_paths, const UT_String &error_messages, UT_String &error)

virtual bool	processSavePath (const UT_StringRef &asset_path, const UT_StringRef &referencing_layer_path, bool asset_is_layer, UT_String &newpath, UT_String &error)

virtual bool	processReferencePath (const UT_StringRef &asset_path, const UT_StringRef &referencing_layer_path, bool asset_is_layer, UT_String &newpath, UT_String &error)

virtual bool	processReferenceExpression (const UT_StringRef &asset_expression, const UT_StringRef &referencing_layer_path, bool asset_is_layer, UT_String &newpath, UT_String &error)

virtual bool	processLayer (const UT_StringRef &identifier, const UT_StringRef &layersavepath, UT_String &error)

virtual HUSD_ShouldSave	shouldSave (const UT_StringRef &save_path, const UT_StringRef &identifier, UT_String &error)

virtual UT_StringHolder	displayName () const =0

virtual const PI_EditScriptedParms *	parameters () const =0

virtual bool	hidden () const

Detailed Description

Performs processing on a USD output path during a save operation.

Definition at line 35 of file HUSD_OutputProcessor.h.

Member Enumeration Documentation

enum HUSD_OutputProcessor::HUSD_ShouldSave

This enum describes the return value from the shouldSave method. This enum must be kept in sync with the values in outputprocessors.py, in the OutputProcessor class.

Enumerator
SHOULD_SAVE_FALSE
SHOULD_SAVE_TRUE
SHOULD_SAVE_NO_OPINION

Definition at line 41 of file HUSD_OutputProcessor.h.

Constructor & Destructor Documentation

virtual HUSD_OutputProcessor::~HUSD_OutputProcessor ( )

virtualdefault

Standard virtual destructor for this abstract base class.

Member Function Documentation

virtual void HUSD_OutputProcessor::beginSave	(	OP_Node *	config_node,
		const UT_Options &	config_overrides,
		OP_Node *	lop_node,
		fpreal	t,
		const UT_Options &	stage_variables,
		UT_String &	error
	)

inlinevirtual

Definition at line 50 of file HUSD_OutputProcessor.h.

virtual UT_StringHolder HUSD_OutputProcessor::displayName ( ) const

pure virtual

virtual void HUSD_OutputProcessor::endSave	(	OP_Node *	config_node,
		const UT_Options &	config_overrides,
		OP_Node *	lop_node,
		fpreal	t,
		const UT_Options &	stage_variables,
		const UT_StringArray &	saved_paths,
		const UT_String &	error_messages,
		UT_String &	error
	)

inlinevirtual

Definition at line 58 of file HUSD_OutputProcessor.h.

virtual bool HUSD_OutputProcessor::hidden ( ) const

inlinevirtual

Definition at line 103 of file HUSD_OutputProcessor.h.

virtual const PI_EditScriptedParms* HUSD_OutputProcessor::parameters ( ) const

pure virtual

virtual bool HUSD_OutputProcessor::processLayer	(	const UT_StringRef &	identifier,
		const UT_StringRef &	layersavepath,
		UT_String &	error
	)

inlinevirtual

Definition at line 90 of file HUSD_OutputProcessor.h.

virtual bool HUSD_OutputProcessor::processReferenceExpression	(	const UT_StringRef &	asset_expression,
		const UT_StringRef &	referencing_layer_path,
		bool	asset_is_layer,
		UT_String &	newpath,
		UT_String &	error
	)

inlinevirtual

Definition at line 82 of file HUSD_OutputProcessor.h.

virtual bool HUSD_OutputProcessor::processReferencePath	(	const UT_StringRef &	asset_path,
		const UT_StringRef &	referencing_layer_path,
		bool	asset_is_layer,
		UT_String &	newpath,
		UT_String &	error
	)

inlinevirtual

Definition at line 75 of file HUSD_OutputProcessor.h.

virtual bool HUSD_OutputProcessor::processSavePath	(	const UT_StringRef &	asset_path,
		const UT_StringRef &	referencing_layer_path,
		bool	asset_is_layer,
		UT_String &	newpath,
		UT_String &	error
	)

inlinevirtual

Definition at line 68 of file HUSD_OutputProcessor.h.

virtual HUSD_ShouldSave HUSD_OutputProcessor::shouldSave	(	const UT_StringRef &	save_path,
		const UT_StringRef &	identifier,
		UT_String &	error
	)

inlinevirtual

Definition at line 95 of file HUSD_OutputProcessor.h.

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

HUSD/HUSD_OutputProcessor.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation