CHOP_Channel Class Reference

#include <CHOP_Channel.h>

Inheritance diagram for CHOP_Channel:

List of all members.

Public Member Functions

virtual OP_ERROR cookMyChop (OP_Context &context)

virtual unsigned disableParms ()

virtual void cookMyHandles (OP_Context &context)

virtual float handleChanged (CHOP_Handle *, CHOP_HandleData *)

virtual bool findParmFromTrack (float t, const char *trackname, OP_Node *&node, PRM_Parm *&parm, int &vecidx)

void clearChannelInstances ()

Clear the number channel instances that we have.

int getNumChannelInstances ()

Obtain the number channel instances.

int appendChannelInstance ()

Append a new channel instance, returning instance index.

bool appendParmCopy (float t, const PRM_Parm *src_parm, unsigned copy_field, CH_ChannelRefList &new_refs, bool copy_value=true, bool current_value_only=false, bool lock_copy=false)

void removeChannelRefs (float t, const CH_ChannelRefList &refs)

bool synchSourceParms (float t, bool force, bool synch_keys, const UT_StringArray &parm_paths, const UT_PtrArray< PRM_Parm * > &parms, const UT_IntArray &fields)

int getNumPoseKeys (float t)

bool addPoseKey (float t, bool only_synch=false)

bool copyPoseKeyToSource (float t, unsigned key_idx)

bool removePoseKey (float t, unsigned key_idx)

bool updatePoseKey (float t, unsigned key_idx)

void getSourceChannelRefs (float t, CH_ChannelRefList &refs)

bool matchParmPaths (float t, const UT_StringArray &parm_paths)

void findConflicts (float t, const CH_ChannelRefList &refs, CH_ChannelRefList &conflicts)

Given a list of channel refs, returns a list of possible conflicts.

void setRangeToValueAnimation (float t)

Static Public Member Functions

static OP_Node * myConstructor (OP_Network *, const char *, OP_Operator *)

static void organizeChanRefs (const CH_ChannelRefList &chan_refs, OP_NodeList &nodes, UT_PtrArray< PRM_Parm * > &parms, UT_IntArray &used_fields)

Static Public Attributes

static OP_TemplatePair myTemplatePair

static OP_VariablePair myVariablePair

static PRM_Template myTemplateList []

static CH_LocalVariable myVariableList []

Protected Member Functions

CHOP_Channel (OP_Network *net, const char *name, OP_Operator *op)

virtual ~CHOP_Channel ()

virtual int usesScope () const

virtual int usesUnits ()

virtual float getVariableValue (int index, int thread)

virtual void buildParmDependency (int parm_index)

virtual void handleOpDependency (int referenced_op_id, const OP_Dependency &op_dep, OP_InterestType interest_type, bool &need_cook, const char *old_fullpath, const char *old_cwd, const char *old_chan_name)

Detailed Description

Definition at line 35 of file CHOP_Channel.h.

Constructor & Destructor Documentation

CHOP_Channel::CHOP_Channel	(	OP_Network *	net,
		const char *	name,
		OP_Operator *	op
	)			`[protected]`

virtual CHOP_Channel::~CHOP_Channel ( ) [protected, virtual]

Member Function Documentation

bool CHOP_Channel::addPoseKey	(	float	t,
		bool	only_synch = `false`
	)

int CHOP_Channel::appendChannelInstance ( )

Append a new channel instance, returning instance index.

bool CHOP_Channel::appendParmCopy	(	float	t,
		const PRM_Parm *	src_parm,
		unsigned	copy_field,
		CH_ChannelRefList &	new_refs,
		bool	copy_value = `true`,
		bool	current_value_only = `false`,
		bool	lock_copy = `false`
	)

Append a new channel instance from the given parm. copy_field is a bitfield where bit i is true if we want to copy it. The contents of src_parm is only copied if copy_value is true. In that case, entire channels are copied if they exist unless current_value_only is true. If current_value_only is true, then only the values at the given time are copied. Returns true on success. Created parms are added to new_refs.

virtual void CHOP_Channel::buildParmDependency ( int parm_index ) [protected, virtual]

Reimplemented from OP_Node.

void CHOP_Channel::clearChannelInstances ( )

Clear the number channel instances that we have.

virtual OP_ERROR CHOP_Channel::cookMyChop ( OP_Context & context ) [virtual]

Implements CHOP_Node.

virtual void CHOP_Channel::cookMyHandles ( OP_Context & context ) [virtual]

Reimplemented from CHOP_Node.

bool CHOP_Channel::copyPoseKeyToSource	(	float	t,
		unsigned	key_idx
	)

virtual unsigned CHOP_Channel::disableParms ( ) [virtual]

Reimplemented from CHOP_Node.

void CHOP_Channel::findConflicts	(	float	t,
		const CH_ChannelRefList &	refs,
		CH_ChannelRefList &	conflicts
	)

Given a list of channel refs, returns a list of possible conflicts.

virtual bool CHOP_Channel::findParmFromTrack	(	float	t,
		const char *	trackname,
		OP_Node *&	node,
		PRM_Parm *&	parm,
		int &	vecidx
	)			`[virtual]`

Reimplemented from CHOP_Node.

int CHOP_Channel::getNumChannelInstances ( )

Obtain the number channel instances.

int CHOP_Channel::getNumPoseKeys ( float t )

void CHOP_Channel::getSourceChannelRefs	(	float	t,
		CH_ChannelRefList &	refs
	)

Returns the list of source channel refs that we think we were created from.

virtual float CHOP_Channel::getVariableValue	(	int	index,
		int	thread
	)			`[protected, virtual]`

Reimplemented from OP_Parameters.

virtual float CHOP_Channel::handleChanged	(	CHOP_Handle *	,
		CHOP_HandleData *
	)			`[virtual]`

Reimplemented from CHOP_Node.

virtual void CHOP_Channel::handleOpDependency	(	int	referenced_op_id,
		const OP_Dependency &	op_dep,
		OP_InterestType	interest_type,
		bool &	need_cook,
		const char *	old_fullpath,
		const char *	old_cwd,
		const char *	old_chan_name
	)			`[protected, virtual]`

Reimplemented from CHOP_Node.

bool CHOP_Channel::matchParmPaths	(	float	t,
		const UT_StringArray &	parm_paths
	)

Given a list of parm paths, verifies if it matches our track export paths exactly.

static OP_Node* CHOP_Channel::myConstructor	(	OP_Network *	,
		const char *	,
		OP_Operator *
	)			`[static]`

static void CHOP_Channel::organizeChanRefs	(	const CH_ChannelRefList &	chan_refs,
		OP_NodeList &	nodes,
		UT_PtrArray< PRM_Parm * > &	parms,
		UT_IntArray &	used_fields
	)			`[static]`

Organize the given list of channel refs so that we list them by parms and associated vector indices. Useful for getting a list parms for appendParmCopy()

void CHOP_Channel::removeChannelRefs	(	float	t,
		const CH_ChannelRefList &	refs
	)

Remove instances matching the given channel refs. Useful for removing conflicts.

bool CHOP_Channel::removePoseKey	(	float	t,
		unsigned	key_idx
	)

void CHOP_Channel::setRangeToValueAnimation ( float t )

bool CHOP_Channel::synchSourceParms	(	float	t,
		bool	force,
		bool	synch_keys,
		const UT_StringArray &	parm_paths,
		const UT_PtrArray< PRM_Parm * > &	parms,
		const UT_IntArray &	fields
	)

Synchronize our value parameters to the given list of source parameters. Returns true if changes were done.

bool CHOP_Channel::updatePoseKey	(	float	t,
		unsigned	key_idx
	)

virtual int CHOP_Channel::usesScope ( ) const [inline, protected, virtual]

Reimplemented from CHOP_Node.

Definition at line 130 of file CHOP_Channel.h.

virtual int CHOP_Channel::usesUnits ( ) [protected, virtual]

Reimplemented from CHOP_Node.

Member Data Documentation

PRM_Template CHOP_Channel::myTemplateList[] [static]

Reimplemented from CHOP_Node.

Definition at line 42 of file CHOP_Channel.h.

OP_TemplatePair CHOP_Channel::myTemplatePair [static]

Reimplemented from CHOP_Node.

Definition at line 40 of file CHOP_Channel.h.

CH_LocalVariable CHOP_Channel::myVariableList[] [static]

Reimplemented from CHOP_Node.

Definition at line 43 of file CHOP_Channel.h.

OP_VariablePair CHOP_Channel::myVariablePair [static]

Reimplemented from CHOP_Node.

Definition at line 41 of file CHOP_Channel.h.

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

CHOP/CHOP_Channel.h


Public Member Functions
virtual OP_ERROR	cookMyChop (OP_Context &context)
virtual unsigned	disableParms ()
virtual void	cookMyHandles (OP_Context &context)
virtual float	handleChanged (CHOP_Handle , CHOP_HandleData )
virtual bool	findParmFromTrack (float t, const char trackname, OP_Node &node, PRM_Parm *&parm, int &vecidx)
void	clearChannelInstances ()
	Clear the number channel instances that we have.
int	getNumChannelInstances ()
	Obtain the number channel instances.
int	appendChannelInstance ()
	Append a new channel instance, returning instance index.
bool	appendParmCopy (float t, const PRM_Parm *src_parm, unsigned copy_field, CH_ChannelRefList &new_refs, bool copy_value=true, bool current_value_only=false, bool lock_copy=false)
void	removeChannelRefs (float t, const CH_ChannelRefList &refs)
bool	synchSourceParms (float t, bool force, bool synch_keys, const UT_StringArray &parm_paths, const UT_PtrArray< PRM_Parm * > &parms, const UT_IntArray &fields)
int	getNumPoseKeys (float t)
bool	addPoseKey (float t, bool only_synch=false)
bool	copyPoseKeyToSource (float t, unsigned key_idx)
bool	removePoseKey (float t, unsigned key_idx)
bool	updatePoseKey (float t, unsigned key_idx)
void	getSourceChannelRefs (float t, CH_ChannelRefList &refs)
bool	matchParmPaths (float t, const UT_StringArray &parm_paths)
void	findConflicts (float t, const CH_ChannelRefList &refs, CH_ChannelRefList &conflicts)
	Given a list of channel refs, returns a list of possible conflicts.
void	setRangeToValueAnimation (float t)
Static Public Member Functions
static OP_Node *	myConstructor (OP_Network , const char , OP_Operator *)
static void	organizeChanRefs (const CH_ChannelRefList &chan_refs, OP_NodeList &nodes, UT_PtrArray< PRM_Parm * > &parms, UT_IntArray &used_fields)
Static Public Attributes
static OP_TemplatePair	myTemplatePair
static OP_VariablePair	myVariablePair
static PRM_Template	myTemplateList []
static CH_LocalVariable	myVariableList []
Protected Member Functions
	CHOP_Channel (OP_Network net, const char name, OP_Operator *op)
virtual	~CHOP_Channel ()
virtual int	usesScope () const
virtual int	usesUnits ()
virtual float	getVariableValue (int index, int thread)
virtual void	buildParmDependency (int parm_index)
virtual void	handleOpDependency (int referenced_op_id, const OP_Dependency &op_dep, OP_InterestType interest_type, bool &need_cook, const char old_fullpath, const char old_cwd, const char *old_chan_name)