#include <SOP_NodeVerb.h>

Public Member Functions
	CookParms (GU_DetailHandle &destgdh, const UT_Array< GU_ConstDetailHandle > &inputs, SOP_CookEngine cookengine, SOP_Node node, const SOP_NodeParms parms, SOP_NodeCache cache, UT_ErrorManager error, DEP_MicroNode *depnode)

virtual	~CookParms ()

GU_DetailHandle &	gdh () const
	The initial state of gdh depends on the cookMode() More...

SOP_Node *	getNode () const

template<typename T >
T *	getCookNode () const

fpreal	getCookTime () const

void	setCookTime (fpreal time)

SOP_Node *	getSrcNode () const
	The node that generated this verb, if any... More...

OP_Node *	getCwd () const
	The getCwd() should be used to evaluate relative paths. More...

bool	getManagesDataIDs () const

exint	nInputs () const

bool	hasInput (exint idx) const

const GU_Detail *	inputGeo (exint idx) const

GU_ConstDetailHandle	inputGeoHandle (exint idx) const

template<typename T >
const T &	parms () const

SOP_NodeCache *	cache () const

UT_ErrorManager *	error () const

DEP_MicroNode *	depnode () const

void	addExplicitInput (DEP_MicroNode &inp, bool check_dup)
	Methods to wire directly to the optional depnode. More...

void	addExplicitInput (DEP_MicroNode &inp)

UT_ErrorSeverity	addMessage (const char type, int code, const char msg=0, const UT_SourceLocation *loc=0) const
	Methods to add directly to any present error manager. More...

UT_ErrorSeverity	addWarning (const char type, int code, const char msg=0, const UT_SourceLocation *loc=0) const

UT_ErrorSeverity	addError (const char type, int code, const char msg=0, const UT_SourceLocation *loc=0) const

UT_ErrorSeverity	sopAddMessage (int code, const char msg=0, const UT_SourceLocation loc=0) const

UT_ErrorSeverity	sopAddWarning (int code, const char msg=0, const UT_SourceLocation loc=0) const

UT_ErrorSeverity	sopAddError (int code, const char msg=0, const UT_SourceLocation loc=0) const

void	select (GA_GroupType gtype=GA_GROUP_PRIMITIVE) const

void	select (GU_SelectionHandle selection, bool add_to_sel=false) const

void	select (const GA_Group &group, bool use_gtype=true, bool add_to_sel=false) const

void	select (const GEO_Primitive &prim, bool sel_prim=true, bool add_to_sel=false) const

void	selectPrimitive (GA_Offset primoff, bool prim_sel=true, bool add_to_sel=false) const

void	selectPoint (GA_Offset ptoff, bool point_sel=true, bool add_to_sel=false) const

void	selectFrom (const GEO_Primitive &prim, bool sel_prim=true, bool add_to_sel=false) const

void	selectPointsFrom (GA_Offset ptoff, bool point_sel=true, bool add_to_sel=false) const

void	select (const GA_Range &range, bool use_rtype=true, bool add_to_sel=false) const

void	selectInputGroup (const GA_Group *group, GA_GroupType grouptype) const

void	clearSelection () const

void	clearSelection (GA_GroupType gtype) const

bool	destroySelection () const

bool	selectionEnabled () const

bool	setupLocalVars () const
	Shims for local variables. More...

void	resetLocalVarRefs () const

void	setCurGdh (int index, const GU_DetailHandle &gdh) const

void	clearCurGdh (int index) const

void	setCurPoint (int index, GA_Offset off) const

void	clearCurPoint (int index) const

void	setCurVertex (int index, GA_Offset off) const

void	clearCurVertex (int index) const

void	setCurPrim (int index, GA_Offset off) const

void	clearCurPrim (int index) const

void	setCurVertexNum (int index, exint num) const

void	clearCurVertexNum (int index) const

void	setVariableOrder (int detail, int prim, int pt, int vtx) const

void	resetLocalVariableAccessed () const
	Tracks if any local variables were accessed by op functions. More...

bool	wasLocalVariableAccessed () const

Protected Member Functions
UT_StringHolder	formatError (const char *msg) const
	Prefix errors so we can get sensible results. More...

Protected Attributes
bool	myCookEngine

GU_DetailHandle &	myDestGdh

const UT_Array < GU_ConstDetailHandle > &	myInputs

SOP_Node *	myNode

const SOP_NodeParms *	myParms

SOP_NodeCache *	myCache

UT_ErrorManager *	myError

DEP_MicroNode *	myDepNode

fpreal	myCookTime

Detailed Description

Definition at line 462 of file SOP_NodeVerb.h.

Constructor & Destructor Documentation

SOP_NodeVerb::CookParms::CookParms	(	GU_DetailHandle &	destgdh,
		const UT_Array< GU_ConstDetailHandle > &	inputs,
		SOP_CookEngine	cookengine,
		SOP_Node *	node,
		const SOP_NodeParms *	parms,
		SOP_NodeCache *	cache,
		UT_ErrorManager *	error,
		DEP_MicroNode *	depnode
	)

inline

Definition at line 465 of file SOP_NodeVerb.h.

virtual SOP_NodeVerb::CookParms::~CookParms ( )

inlinevirtual

Definition at line 483 of file SOP_NodeVerb.h.

Member Function Documentation

UT_ErrorSeverity SOP_NodeVerb::CookParms::addError	(	const char *	type,
		int	code,
		const char *	msg = `0`,
		const UT_SourceLocation *	loc = `0`
	)		const

inline

Definition at line 568 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::addExplicitInput	(	DEP_MicroNode &	inp,
		bool	check_dup
	)

inline

Methods to wire directly to the optional depnode.

Definition at line 554 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::addExplicitInput ( DEP_MicroNode & inp )

inline

Definition at line 556 of file SOP_NodeVerb.h.

UT_ErrorSeverity SOP_NodeVerb::CookParms::addMessage	(	const char *	type,
		int	code,
		const char *	msg = `0`,
		const UT_SourceLocation *	loc = `0`
	)		const

inline

Methods to add directly to any present error manager.

Definition at line 560 of file SOP_NodeVerb.h.

UT_ErrorSeverity SOP_NodeVerb::CookParms::addWarning	(	const char *	type,
		int	code,
		const char *	msg = `0`,
		const UT_SourceLocation *	loc = `0`
	)		const

inline

Definition at line 564 of file SOP_NodeVerb.h.

SOP_NodeCache* SOP_NodeVerb::CookParms::cache ( ) const

inline

Cache may, or may not, persist between cooks. But it is guaranteed this is the only thread using the cache.

Definition at line 548 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::clearCurGdh ( int index ) const

inline

Definition at line 668 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::clearCurPoint ( int index ) const

inline

Definition at line 672 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::clearCurPrim ( int index ) const

inline

Definition at line 680 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::clearCurVertex ( int index ) const

inline

Definition at line 676 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::clearCurVertexNum ( int index ) const

inline

Definition at line 684 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::clearSelection ( ) const

inline

Definition at line 633 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::clearSelection ( GA_GroupType gtype ) const

inline

If the cook selection group is not of the given type, create an empty cook selection group of that type. Otherwise, clear the existing cook selection group.

Definition at line 640 of file SOP_NodeVerb.h.

DEP_MicroNode* SOP_NodeVerb::CookParms::depnode ( ) const

inline

Definition at line 551 of file SOP_NodeVerb.h.

bool SOP_NodeVerb::CookParms::destroySelection ( ) const

inline

Definition at line 647 of file SOP_NodeVerb.h.

UT_ErrorManager* SOP_NodeVerb::CookParms::error ( ) const

inline

Definition at line 550 of file SOP_NodeVerb.h.

UT_StringHolder SOP_NodeVerb::CookParms::formatError ( const char * msg ) const

inlineprotected

Prefix errors so we can get sensible results.

Definition at line 700 of file SOP_NodeVerb.h.

GU_DetailHandle& SOP_NodeVerb::CookParms::gdh ( ) const

inline

The initial state of gdh depends on the cookMode()

Definition at line 486 of file SOP_NodeVerb.h.

template<typename T >

T* SOP_NodeVerb::CookParms::getCookNode ( ) const

inline

Definition at line 495 of file SOP_NodeVerb.h.

fpreal SOP_NodeVerb::CookParms::getCookTime ( ) const

inline

Definition at line 499 of file SOP_NodeVerb.h.

OP_Node* SOP_NodeVerb::CookParms::getCwd ( ) const

inline

The getCwd() should be used to evaluate relative paths.

Definition at line 508 of file SOP_NodeVerb.h.

bool SOP_NodeVerb::CookParms::getManagesDataIDs ( ) const

inline

Whether the underlying verb manages data ids. All new nodes should manage data ids, this is purely for the SOP_NodeParmsOptions wrapper.

Definition at line 513 of file SOP_NodeVerb.h.

SOP_Node* SOP_NodeVerb::CookParms::getNode ( void ) const

inline

The currently cooking SOP. This is only non-null if in the old cook path. When executing compiled nodes it will be null as the verb is supposed to operate independently of the original SOP.

Definition at line 492 of file SOP_NodeVerb.h.

SOP_Node* SOP_NodeVerb::CookParms::getSrcNode ( ) const

inline

The node that generated this verb, if any...

Definition at line 506 of file SOP_NodeVerb.h.

bool SOP_NodeVerb::CookParms::hasInput ( exint idx ) const

inline

Definition at line 525 of file SOP_NodeVerb.h.

const GU_Detail* SOP_NodeVerb::CookParms::inputGeo ( exint idx ) const

inline

Definition at line 531 of file SOP_NodeVerb.h.

GU_ConstDetailHandle SOP_NodeVerb::CookParms::inputGeoHandle ( exint idx ) const

inline

Definition at line 536 of file SOP_NodeVerb.h.

exint SOP_NodeVerb::CookParms::nInputs ( ) const

inline

Accessors designed to simplify porting from old cook code. Just becaues you have nInputs does not mean all are wired or cooked. But, the number demanded by your OP_Operator shall be present. Inputs have been locked & preserve request set

Definition at line 524 of file SOP_NodeVerb.h.

template<typename T >

const T& SOP_NodeVerb::CookParms::parms ( ) const

inline

Definition at line 543 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::resetLocalVariableAccessed ( ) const

inline

Tracks if any local variables were accessed by op functions.

Definition at line 691 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::resetLocalVarRefs ( ) const

inline

Definition at line 664 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::select ( GA_GroupType gtype = GA_GROUP_PRIMITIVE ) const

inline

Definition at line 583 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::select	(	GU_SelectionHandle	selection,
		bool	add_to_sel = `false`
	)		const

inline

Definition at line 587 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::select	(	const GA_Group &	group,
		bool	use_gtype = `true`,
		bool	add_to_sel = `false`
	)		const

inline

Definition at line 593 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::select	(	const GEO_Primitive &	prim,
		bool	sel_prim = `true`,
		bool	add_to_sel = `false`
	)		const

inline

Definition at line 598 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::select	(	const GA_Range &	range,
		bool	use_rtype = `true`,
		bool	add_to_sel = `false`
	)		const

inline

Definition at line 618 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::selectFrom	(	const GEO_Primitive &	prim,
		bool	sel_prim = `true`,
		bool	add_to_sel = `false`
	)		const

inline

Definition at line 610 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::selectInputGroup	(	const GA_Group *	group,
		GA_GroupType	grouptype
	)		const

inline

Definition at line 626 of file SOP_NodeVerb.h.

bool SOP_NodeVerb::CookParms::selectionEnabled ( ) const

inline

Definition at line 654 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::selectPoint	(	GA_Offset	ptoff,
		bool	point_sel = `true`,
		bool	add_to_sel = `false`
	)		const

inline

Definition at line 606 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::selectPointsFrom	(	GA_Offset	ptoff,
		bool	point_sel = `true`,
		bool	add_to_sel = `false`
	)		const

inline

Definition at line 614 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::selectPrimitive	(	GA_Offset	primoff,
		bool	prim_sel = `true`,
		bool	add_to_sel = `false`
	)		const

inline

Definition at line 602 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::setCookTime ( fpreal time )

inline

Definition at line 503 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::setCurGdh	(	int	index,
		const GU_DetailHandle &	gdh
	)		const

inline

Definition at line 666 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::setCurPoint	(	int	index,
		GA_Offset	off
	)		const

inline

Definition at line 670 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::setCurPrim	(	int	index,
		GA_Offset	off
	)		const

inline

Definition at line 678 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::setCurVertex	(	int	index,
		GA_Offset	off
	)		const

inline

Definition at line 674 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::setCurVertexNum	(	int	index,
		exint	num
	)		const

inline

Definition at line 682 of file SOP_NodeVerb.h.

bool SOP_NodeVerb::CookParms::setupLocalVars ( ) const

inline

Shims for local variables.

Definition at line 662 of file SOP_NodeVerb.h.

void SOP_NodeVerb::CookParms::setVariableOrder	(	int	detail,
		int	prim,
		int	pt,
		int	vtx
	)		const

inline

Definition at line 686 of file SOP_NodeVerb.h.

UT_ErrorSeverity SOP_NodeVerb::CookParms::sopAddError	(	int	code,
		const char *	msg = `0`,
		const UT_SourceLocation *	loc = `0`
	)		const

inline

Definition at line 579 of file SOP_NodeVerb.h.

UT_ErrorSeverity SOP_NodeVerb::CookParms::sopAddMessage	(	int	code,
		const char *	msg = `0`,
		const UT_SourceLocation *	loc = `0`
	)		const

inline

Definition at line 573 of file SOP_NodeVerb.h.

UT_ErrorSeverity SOP_NodeVerb::CookParms::sopAddWarning	(	int	code,
		const char *	msg = `0`,
		const UT_SourceLocation *	loc = `0`
	)		const

inline

Definition at line 576 of file SOP_NodeVerb.h.

bool SOP_NodeVerb::CookParms::wasLocalVariableAccessed ( ) const

inline

Definition at line 693 of file SOP_NodeVerb.h.

Member Data Documentation

SOP_NodeCache* SOP_NodeVerb::CookParms::myCache

protected

Definition at line 725 of file SOP_NodeVerb.h.

bool SOP_NodeVerb::CookParms::myCookEngine

protected

Definition at line 720 of file SOP_NodeVerb.h.

fpreal SOP_NodeVerb::CookParms::myCookTime

protected

Definition at line 729 of file SOP_NodeVerb.h.

DEP_MicroNode* SOP_NodeVerb::CookParms::myDepNode

protected

Definition at line 727 of file SOP_NodeVerb.h.

GU_DetailHandle& SOP_NodeVerb::CookParms::myDestGdh

protected

Definition at line 721 of file SOP_NodeVerb.h.

UT_ErrorManager* SOP_NodeVerb::CookParms::myError

protected

Definition at line 726 of file SOP_NodeVerb.h.

const UT_Array<GU_ConstDetailHandle>& SOP_NodeVerb::CookParms::myInputs

protected

Definition at line 722 of file SOP_NodeVerb.h.

SOP_Node* SOP_NodeVerb::CookParms::myNode

protected

Definition at line 723 of file SOP_NodeVerb.h.

const SOP_NodeParms* SOP_NodeVerb::CookParms::myParms

protected

Definition at line 724 of file SOP_NodeVerb.h.

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

SOP/SOP_NodeVerb.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation