#include <PI_OpHandleLink.h>

Inheritance diagram for PI_OpHandleLink:

Classes
struct	LateBinding

class	PI_Interest

Public Types
using	ReadParmFunc = UT_Function< void(const PRM_Parm &parm, int vecidx)>

using	ModifyParmFunc = UT_Function< void(PRM_Parm &parm, int vecidx)>

Public Member Functions
	PI_OpHandleLink (const PI_PITemplate &templ)

virtual	~PI_OpHandleLink ()

int	linkOpParmToHandleParm (const char op_type, const char handle_parm_name, const char *op_parm_name)

int	activateHandleParm (int pindex)

void	disableHandleParm (int pindex)

virtual int	attach (OP_Node &node)

virtual int	detach (OP_Node &node)

virtual void	detachAll ()

void	attachForKeyframe (OP_Node &node)

void	detachForKeyframe (OP_Node &node)

void	detachAllForKeyframe ()

void	isolateHandleParms (int beg, const UT_StringArray &handle_parms)

void	setShowOpPath (bool onoff)

virtual bool	getShowOpPath () const

void	setRootDescription (const char *description)

const char *	getRootDescription () const

void	buildDescription ()

const char *	getDescription () const

virtual void	descriptionChanged (const char *old_description)

void	setIsTimeOverride (bool is_time_override)

void	setTimeOverrideTime (fpreal t)

bool	getIsTimeOverride () const

fpreal	getTimeOverrideTime () const

bool	allowsUsingPerOpSettingsTable () const

bool	allowsUsingLastSettingsTable () const

bool	allowsUsingOpTypeSettings () const

bool	allowsUsingLastVisibilitySetting () const

OP_Operator *	lastSettingsOperatorTypeRestriction () const

OP_Node *	getOpNode (int opnum=0) const

int	getNumOps () const

OP_Node *	getKeyframeOpNode (int opnum=0) const

int	getKeyframeNumOps () const

int	hasOpNode (const OP_Node &node) const

int	hasKeyframeOpNode (const OP_Node &node) const

OP_Node *	findOpNode (int op_type, const char *op_name) const

void	doUpdateFromOpParms ()

virtual void	forceUpdateFromOpParms ()

virtual void	handleOpNodeChange (OP_Node &node)

virtual void	handleOpUIChange (OP_Node &)

virtual int	wantsOpNodeChange (const OP_Node &) const

virtual bool	flagOpNodeChangeNeeded (OP_Node &)

virtual int	refreshBindings (int op_type, const char *op_name)

void	id (int i)

int	id () const

bool	hasLinkedParms () const

const UT_StringArray &	linkedParmNames (int opnum) const

virtual const UT_StringArray &	allParmNames (int opnum) const

int	getOpnumForHandleParmIndex (int idx) const

const UT_Color &	getActiveColor () const

virtual void	setActiveColor (const UT_Color &c)

void	setBindingState (const bool active)

virtual int	isEqual (const PI_OpHandleLink &pi) const

virtual int	setEqual (const PI_OpHandleLink &pi)

bool	ethereal () const

const PI_PITemplate &	getTemplate () const

PI_PITemplate &	getTemplate ()

int	writeOptions (std::ostream &os, const char *baseCommand)

int	runBindCommand (CMD_Args &args)

int	runUnbindCommand (CMD_Args &args)

void	editChannels (int append_channels, int opnum=-1)

void	findKey (int direction, int opnum=-1)

void	setKeys (int opnum=-1, int pindex_start=-1, int pined_stop=-1, const char *undo_str=0)

void	removeKeys (int opnum=-1)

void	deleteChannels (int opnum=-1)

void	lockParms (int opnum=-1)

void	revertToDefaults (int opnum=-1)

void	revertToFactoryDefaults (int opnum=-1)

void	overwriteDefaults (int opnum=-1)

virtual void	loadSettings (const PI_SettingList &settings)

virtual void	saveSettings (PI_SettingList &settings, bool specific_to_op) const

virtual void	saveSettingsToAppropriateLocation ()

void	loadSettingsFromTables (bool okay_to_use_last_settings)

void	removeSettingsFromTables ()

void	setLateBinding (LateBinding *binding)

bool	hasLateBinding () const

bool	hasLateBinding (LateBinding const *binding) const

int	findHandleParmIndex (const char *h_parm_name) const

virtual void	onDeletion ()

int	getProxyIndex () const

void	updateSettings (char const *setting_string)

void	setAllowUsingPerOpSettingsTable (bool onoff)

void	setAllowUsingLastSettingsTable (bool onoff)

void	setAllowUsingOpTypeSettings (bool onoff)

void	setAllowUsingLastVisibilitySetting (bool onoff)

int	iterateParms (int opnum, ReadParmFunc func) const

int	iterateParms (int opnum, ModifyParmFunc func, bool modify_locked=false)

Static Public Member Functions
static void	extractProjection (UT_String &channel, const char *parmname, fpreal &a, fpreal &b, fpreal &c, fpreal &d)

static void	extractChannelName (UT_String &channel, const char *parmname)

Protected Member Functions
virtual void	updateFromOpParms ()

virtual int	justLinked (int pindex)

virtual void	justUnlinked (int pindex)

virtual PI_Interest *	getInputGroupInterests () const

void	addAllInputGroupInterests (int opnum)

void	removeAllInputGroupInterests (int opnum)

virtual fpreal	getTime () const

int	getParmValue (int pindex, int &val, int d=0) const

int	getParmValue (int pindex, fpreal &val, fpreal d=0) const

int	getParmValue (int pindex, UT_String &val, UT_String d=0) const

void	getParmVector3 (int pindex, UT_Vector3R &v, fpreal def=0.0) const

int	getParmInstValue (int pindex, const int *inst, int &val, int d=0, int nestlevel=1) const

int	getParmInstValue (int pindex, const int *inst, fpreal &val, fpreal d=0, int nestlevel=1) const

int	getParmInstValue (int pindex, const int *inst, UT_String &val, UT_String d=0, int nestlevel=1) const

void	getParmInstVector3 (int pindex, const int *inst, UT_Vector3R &v, fpreal def=0.0) const

int	setParmValue (int pindex, int val, bool addkey=false)

int	setParmValue (int pindex, fpreal val, bool addkey=false)

int	setParmValue (int pindex, const UT_String &val, CH_StringMeaning meaning)

void	setParmVector3 (int pindex, const UT_Vector3R &v)

int	setParmInstValue (int pindex, const int *inst, int val, bool addkey=false, int nestlevel=1)

int	setParmInstValue (int pindex, const int *inst, fpreal val, bool addkey=false, int nestlevel=1)

int	setParmInstValue (int pindex, const int *inst, const UT_String &val, CH_StringMeaning meaning, int nestlevel=1)

void	setParmInstVector3 (int pindex, const int *inst, const UT_Vector3R &v)

int	performParmCallback (int pindex, int theitem)

int	setOpParmValue (OP_Node op, PRM_Parm parm, int vecidx, int val, bool addkey=false)

int	setOpParmValue (OP_Node op, PRM_Parm parm, int vecidx, fpreal val, bool addkey=false)

int	setOpParmValue (OP_Node op, PRM_Parm parm, int vecidx, const UT_String &val, CH_StringMeaning meaning)

bool	readParm (int pindex, ReadParmFunc f) const

bool	modifyParm (int pindex, ModifyParmFunc f, bool modify_locked=false)

void	copyKeyStructure (int pindex_dest, int pindex_from)

bool	isParmEnabled (int pindex, int opnum=0) const

PRM_ChanState	getParmState (int pindex, int opnum=0) const

int	getLinkedParmCount () const

virtual int	hasTimeInterest () const

virtual void	handleTimeChange ()

void	beginDistributedUndoBlock (const char *operation, UT_UndoBlockType blocktype)

void	endDistributedUndoBlock ()

bool	inDistributedUndoBlock ()

virtual void	handleOpChange (OP_Node op, OP_EventType etype, void data)

virtual void	setOwnerOp (const char *owner_op)

const UT_String &	getOwnerOp () const

OP_Node *	getOwnerOpRelativeTo (OP_Node *node) const

virtual void	setOwnerOpGroup (const char *owner_op_group)

const UT_String &	getOwnerOpGroup () const

const UT_StringHolder &	getFirstInputGroupInterestName () const

void	updateStateValues (void *ui_event)

void	beginHandleChange (void *ui_event)

void	endHandleChange (void *ui_event)

void	allocProxy (void *ptr)

void	freeProxy ()

UT_StringHolder	getOpParmLabel (int pi_index) const

Static Protected Member Functions
static bool	isOpParmLocked (const char channel_name, OP_Node &op, fpreal time, const PRM_Parm ret_parm=NULL, const OP_Node *ret_node=NULL)

Detailed Description

Definition at line 46 of file PI_OpHandleLink.h.

Member Typedef Documentation

using PI_OpHandleLink::ModifyParmFunc = UT_Function<void(PRM_Parm& parm, int vecidx)>

Definition at line 50 of file PI_OpHandleLink.h.

using PI_OpHandleLink::ReadParmFunc = UT_Function<void(const PRM_Parm& parm, int vecidx)>

Definition at line 49 of file PI_OpHandleLink.h.

Constructor & Destructor Documentation

PI_OpHandleLink::PI_OpHandleLink ( const PI_PITemplate & templ )

virtual PI_OpHandleLink::~PI_OpHandleLink ( )

virtual

Member Function Documentation

int PI_OpHandleLink::activateHandleParm ( int pindex )

void PI_OpHandleLink::addAllInputGroupInterests ( int opnum )

protected

void PI_OpHandleLink::allocProxy ( void * ptr )

protected

bool PI_OpHandleLink::allowsUsingLastSettingsTable ( ) const

inline

Definition at line 143 of file PI_OpHandleLink.h.

bool PI_OpHandleLink::allowsUsingLastVisibilitySetting ( ) const

inline

Definition at line 147 of file PI_OpHandleLink.h.

bool PI_OpHandleLink::allowsUsingOpTypeSettings ( ) const

inline

Definition at line 145 of file PI_OpHandleLink.h.

bool PI_OpHandleLink::allowsUsingPerOpSettingsTable ( ) const

inline

Definition at line 141 of file PI_OpHandleLink.h.

virtual const UT_StringArray& PI_OpHandleLink::allParmNames ( int opnum ) const

inlinevirtual

Definition at line 211 of file PI_OpHandleLink.h.

virtual int PI_OpHandleLink::attach ( OP_Node & node )

virtual

void PI_OpHandleLink::attachForKeyframe ( OP_Node & node )

void PI_OpHandleLink::beginDistributedUndoBlock	(	const char *	operation,
		UT_UndoBlockType	blocktype
	)

protected

void PI_OpHandleLink::beginHandleChange ( void * ui_event )

protected

void PI_OpHandleLink::buildDescription ( )

void PI_OpHandleLink::copyKeyStructure	(	int	pindex_dest,
		int	pindex_from
	)

protected

void PI_OpHandleLink::deleteChannels ( int opnum = -1 )

virtual void PI_OpHandleLink::descriptionChanged ( const char * old_description )

virtual

virtual int PI_OpHandleLink::detach ( OP_Node & node )

virtual

virtual void PI_OpHandleLink::detachAll ( )

virtual

void PI_OpHandleLink::detachAllForKeyframe ( )

void PI_OpHandleLink::detachForKeyframe ( OP_Node & node )

void PI_OpHandleLink::disableHandleParm ( int pindex )

void PI_OpHandleLink::doUpdateFromOpParms ( )

void PI_OpHandleLink::editChannels	(	int	append_channels,
		int	opnum = `-1`
	)

void PI_OpHandleLink::endDistributedUndoBlock ( )

protected

void PI_OpHandleLink::endHandleChange ( void * ui_event )

protected

bool PI_OpHandleLink::ethereal ( ) const

static void PI_OpHandleLink::extractChannelName	(	UT_String &	channel,
		const char *	parmname
	)

inlinestatic

Definition at line 282 of file PI_OpHandleLink.h.

static void PI_OpHandleLink::extractProjection	(	UT_String &	channel,
		const char *	parmname,
		fpreal &	a,
		fpreal &	b,
		fpreal &	c,
		fpreal &	d
	)

static

int PI_OpHandleLink::findHandleParmIndex ( const char * h_parm_name ) const

void PI_OpHandleLink::findKey	(	int	direction,
		int	opnum = `-1`
	)

OP_Node* PI_OpHandleLink::findOpNode	(	int	op_type,
		const char *	op_name
	)		const

virtual bool PI_OpHandleLink::flagOpNodeChangeNeeded ( OP_Node & )

inlinevirtual

Definition at line 186 of file PI_OpHandleLink.h.

virtual void PI_OpHandleLink::forceUpdateFromOpParms ( )

virtual

void PI_OpHandleLink::freeProxy ( )

protected

const UT_Color& PI_OpHandleLink::getActiveColor ( ) const

const char* PI_OpHandleLink::getDescription ( ) const

const UT_StringHolder& PI_OpHandleLink::getFirstInputGroupInterestName ( ) const

protected

virtual PI_Interest* PI_OpHandleLink::getInputGroupInterests ( ) const

protectedvirtual

bool PI_OpHandleLink::getIsTimeOverride ( ) const

inline

Definition at line 134 of file PI_OpHandleLink.h.

int PI_OpHandleLink::getKeyframeNumOps ( ) const

OP_Node* PI_OpHandleLink::getKeyframeOpNode ( int opnum = 0 ) const

int PI_OpHandleLink::getLinkedParmCount ( ) const

inlineprotected

Definition at line 423 of file PI_OpHandleLink.h.

int PI_OpHandleLink::getNumOps ( ) const

OP_Node* PI_OpHandleLink::getOpNode ( int opnum = 0 ) const

int PI_OpHandleLink::getOpnumForHandleParmIndex ( int idx ) const

UT_StringHolder PI_OpHandleLink::getOpParmLabel ( int pi_index ) const

protected

const UT_String& PI_OpHandleLink::getOwnerOp ( ) const

protected

const UT_String& PI_OpHandleLink::getOwnerOpGroup ( ) const

protected

OP_Node* PI_OpHandleLink::getOwnerOpRelativeTo ( OP_Node * node ) const

protected

int PI_OpHandleLink::getParmInstValue	(	int	pindex,
		const int *	inst,
		int &	val,
		int	d = `0`,
		int	nestlevel = `1`
	)		const

protected

int PI_OpHandleLink::getParmInstValue	(	int	pindex,
		const int *	inst,
		fpreal &	val,
		fpreal	d = `0`,
		int	nestlevel = `1`
	)		const

protected

int PI_OpHandleLink::getParmInstValue	(	int	pindex,
		const int *	inst,
		UT_String &	val,
		UT_String	d = `0`,
		int	nestlevel = `1`
	)		const

protected

void PI_OpHandleLink::getParmInstVector3	(	int	pindex,
		const int *	inst,
		UT_Vector3R &	v,
		fpreal	def = `0.0`
	)		const

protected

PRM_ChanState PI_OpHandleLink::getParmState	(	int	pindex,
		int	opnum = `0`
	)		const

protected

int PI_OpHandleLink::getParmValue	(	int	pindex,
		int &	val,
		int	d = `0`
	)		const

protected

int PI_OpHandleLink::getParmValue	(	int	pindex,
		fpreal &	val,
		fpreal	d = `0`
	)		const

protected

int PI_OpHandleLink::getParmValue	(	int	pindex,
		UT_String &	val,
		UT_String	d = `0`
	)		const

protected

void PI_OpHandleLink::getParmVector3	(	int	pindex,
		UT_Vector3R &	v,
		fpreal	def = `0.0`
	)		const

protected

int PI_OpHandleLink::getProxyIndex ( ) const

inline

Definition at line 306 of file PI_OpHandleLink.h.

const char* PI_OpHandleLink::getRootDescription ( ) const

virtual bool PI_OpHandleLink::getShowOpPath ( ) const

virtual

const PI_PITemplate& PI_OpHandleLink::getTemplate ( ) const

PI_PITemplate& PI_OpHandleLink::getTemplate ( )

virtual fpreal PI_OpHandleLink::getTime ( ) const

protectedvirtual

fpreal PI_OpHandleLink::getTimeOverrideTime ( ) const

inline

Definition at line 136 of file PI_OpHandleLink.h.

virtual void PI_OpHandleLink::handleOpChange	(	OP_Node *	op,
		OP_EventType	etype,
		void *	data
	)

protectedvirtual

Reimplemented in PI_OHLPersistent.

virtual void PI_OpHandleLink::handleOpNodeChange ( OP_Node & node )

virtual

virtual void PI_OpHandleLink::handleOpUIChange ( OP_Node & )

inlinevirtual

Definition at line 182 of file PI_OpHandleLink.h.

virtual void PI_OpHandleLink::handleTimeChange ( )

protectedvirtual

int PI_OpHandleLink::hasKeyframeOpNode ( const OP_Node & node ) const

bool PI_OpHandleLink::hasLateBinding ( ) const

bool PI_OpHandleLink::hasLateBinding ( LateBinding const * binding ) const

bool PI_OpHandleLink::hasLinkedParms ( ) const

inline

Definition at line 200 of file PI_OpHandleLink.h.

int PI_OpHandleLink::hasOpNode ( const OP_Node & node ) const

virtual int PI_OpHandleLink::hasTimeInterest ( ) const

protectedvirtual

void PI_OpHandleLink::id ( int i )

int PI_OpHandleLink::id ( ) const

bool PI_OpHandleLink::inDistributedUndoBlock ( )

protected

virtual int PI_OpHandleLink::isEqual ( const PI_OpHandleLink & pi ) const

virtual

void PI_OpHandleLink::isolateHandleParms	(	int	beg,
		const UT_StringArray &	handle_parms
	)

static bool PI_OpHandleLink::isOpParmLocked	(	const char *	channel_name,
		OP_Node &	op,
		fpreal	time,
		const PRM_Parm **	ret_parm = `NULL`,
		const OP_Node **	ret_node = `NULL`
	)

staticprotected

bool PI_OpHandleLink::isParmEnabled	(	int	pindex,
		int	opnum = `0`
	)		const

protected

int PI_OpHandleLink::iterateParms	(	int	opnum,
		ReadParmFunc	func
	)		const

int PI_OpHandleLink::iterateParms	(	int	opnum,
		ModifyParmFunc	func,
		bool	modify_locked = `false`
	)

virtual int PI_OpHandleLink::justLinked ( int pindex )

protectedvirtual

virtual void PI_OpHandleLink::justUnlinked ( int pindex )

protectedvirtual

OP_Operator* PI_OpHandleLink::lastSettingsOperatorTypeRestriction ( ) const

const UT_StringArray& PI_OpHandleLink::linkedParmNames ( int opnum ) const

inline

Definition at line 204 of file PI_OpHandleLink.h.

int PI_OpHandleLink::linkOpParmToHandleParm	(	const char *	op_type,
		const char *	handle_parm_name,
		const char *	op_parm_name
	)

virtual void PI_OpHandleLink::loadSettings ( const PI_SettingList & settings )

virtual

void PI_OpHandleLink::loadSettingsFromTables ( bool okay_to_use_last_settings )

void PI_OpHandleLink::lockParms ( int opnum = -1 )

bool PI_OpHandleLink::modifyParm	(	int	pindex,
		ModifyParmFunc	f,
		bool	modify_locked = `false`
	)

protected

virtual void PI_OpHandleLink::onDeletion ( )

virtual

void PI_OpHandleLink::overwriteDefaults ( int opnum = -1 )

int PI_OpHandleLink::performParmCallback	(	int	pindex,
		int	theitem
	)

protected

bool PI_OpHandleLink::readParm	(	int	pindex,
		ReadParmFunc	f
	)		const

protected

virtual int PI_OpHandleLink::refreshBindings	(	int	op_type,
		const char *	op_name
	)

virtual

void PI_OpHandleLink::removeAllInputGroupInterests ( int opnum )

protected

void PI_OpHandleLink::removeKeys ( int opnum = -1 )

void PI_OpHandleLink::removeSettingsFromTables ( )

void PI_OpHandleLink::revertToDefaults ( int opnum = -1 )

void PI_OpHandleLink::revertToFactoryDefaults ( int opnum = -1 )

int PI_OpHandleLink::runBindCommand ( CMD_Args & args )

int PI_OpHandleLink::runUnbindCommand ( CMD_Args & args )

virtual void PI_OpHandleLink::saveSettings	(	PI_SettingList &	settings,
		bool	specific_to_op
	)		const

virtual

virtual void PI_OpHandleLink::saveSettingsToAppropriateLocation ( )

virtual

virtual void PI_OpHandleLink::setActiveColor ( const UT_Color & c )

virtual

Reimplemented in PI_OHLPersistent.

void PI_OpHandleLink::setAllowUsingLastSettingsTable ( bool onoff )

inline

Definition at line 314 of file PI_OpHandleLink.h.

void PI_OpHandleLink::setAllowUsingLastVisibilitySetting ( bool onoff )

inline

Definition at line 318 of file PI_OpHandleLink.h.

void PI_OpHandleLink::setAllowUsingOpTypeSettings ( bool onoff )

inline

Definition at line 316 of file PI_OpHandleLink.h.

void PI_OpHandleLink::setAllowUsingPerOpSettingsTable ( bool onoff )

inline

Definition at line 312 of file PI_OpHandleLink.h.

void PI_OpHandleLink::setBindingState ( const bool active )

virtual int PI_OpHandleLink::setEqual ( const PI_OpHandleLink & pi )

virtual

Reimplemented in PI_OHLPersistent.

void PI_OpHandleLink::setIsTimeOverride ( bool is_time_override )

void PI_OpHandleLink::setKeys	(	int	opnum = `-1`,
		int	pindex_start = `-1`,
		int	pined_stop = `-1`,
		const char *	undo_str = `0`
	)

void PI_OpHandleLink::setLateBinding ( LateBinding * binding )

int PI_OpHandleLink::setOpParmValue	(	OP_Node *	op,
		PRM_Parm *	parm,
		int	vecidx,
		int	val,
		bool	addkey = `false`
	)

protected

int PI_OpHandleLink::setOpParmValue	(	OP_Node *	op,
		PRM_Parm *	parm,
		int	vecidx,
		fpreal	val,
		bool	addkey = `false`
	)

protected

int PI_OpHandleLink::setOpParmValue	(	OP_Node *	op,
		PRM_Parm *	parm,
		int	vecidx,
		const UT_String &	val,
		CH_StringMeaning	meaning
	)

protected

virtual void PI_OpHandleLink::setOwnerOp ( const char * owner_op )

protectedvirtual

virtual void PI_OpHandleLink::setOwnerOpGroup ( const char * owner_op_group )

protectedvirtual

int PI_OpHandleLink::setParmInstValue	(	int	pindex,
		const int *	inst,
		int	val,
		bool	addkey = `false`,
		int	nestlevel = `1`
	)

protected

int PI_OpHandleLink::setParmInstValue	(	int	pindex,
		const int *	inst,
		fpreal	val,
		bool	addkey = `false`,
		int	nestlevel = `1`
	)

protected

int PI_OpHandleLink::setParmInstValue	(	int	pindex,
		const int *	inst,
		const UT_String &	val,
		CH_StringMeaning	meaning,
		int	nestlevel = `1`
	)

protected

void PI_OpHandleLink::setParmInstVector3	(	int	pindex,
		const int *	inst,
		const UT_Vector3R &	v
	)

protected

int PI_OpHandleLink::setParmValue	(	int	pindex,
		int	val,
		bool	addkey = `false`
	)

protected

int PI_OpHandleLink::setParmValue	(	int	pindex,
		fpreal	val,
		bool	addkey = `false`
	)

protected

int PI_OpHandleLink::setParmValue	(	int	pindex,
		const UT_String &	val,
		CH_StringMeaning	meaning
	)

protected

void PI_OpHandleLink::setParmVector3	(	int	pindex,
		const UT_Vector3R &	v
	)

protected

void PI_OpHandleLink::setRootDescription ( const char * description )

void PI_OpHandleLink::setShowOpPath ( bool onoff )

void PI_OpHandleLink::setTimeOverrideTime ( fpreal t )

virtual void PI_OpHandleLink::updateFromOpParms ( )

protectedvirtual

void PI_OpHandleLink::updateSettings ( char const * setting_string )

void PI_OpHandleLink::updateStateValues ( void * ui_event )

protected

virtual int PI_OpHandleLink::wantsOpNodeChange ( const OP_Node & ) const

inlinevirtual

Definition at line 184 of file PI_OpHandleLink.h.

int PI_OpHandleLink::writeOptions	(	std::ostream &	os,
		const char *	baseCommand
	)

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

PI/PI_OpHandleLink.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation