INodeTransformMonitor Class Reference

This reference page is linked to from the following overview topics: Reference System Best Practices, Node Monitors, Indirect Reference Example.

---

Search for all occurrences

#include <INodeTransformMonitor.h>

Inheritance diagram for INodeTransformMonitor:

---

Class Description

The interface for working with NodeTransformMonitor class.

The NodeTransformMonitor class (defined in ctrl.dlc) is used to monitor a node for its REFMSG_CHANGE / PART_TM and REFMSG_TARGET_DELETED messages. The NodeTransformMonitor class creates a RefTargMonitorRefMaker instance pointing at a node, and allows only the REFMSG_TARGET_DELETED message and the REFMSG_CHANGE message when PartID is PART_TM to propagate to the NodeTransformMonitor's dependents. To prevent circular message loops, the messages are not propagated if that message type is already being propagated.

Public Types
enum	{   kfpGetnode, kfpSetnode, kfpGetforwardPartTM, kfpSetforwardPartTM,   kfpGetforwardFlagNodes, kfpSetforwardFlagNodes, kfpGetforwardEnumDependents, kfpSetforwardEnumDependents }
Public Member Functions
virtual INode *	GetNode ()=0
	Retrieves the node being watched.
virtual void	SetNode (INode *theNode)=0
	Sets the node being watched.
virtual bool	GetForwardTransformChangeMsgs ()=0
	Retrieves whether to monitor for REFMSG_CHANGE / PART_TM messages.
virtual void	SetForwardTransformChangeMsgs (bool state)=0
	Sets whether to monitor for REFMSG_CHANGE / PART_TM messages.
virtual bool	GetForwardFlagNodesMsgs ()=0
	Retrieves whether to monitor for REFMSG_FLAG_NODES_WITH_SEL_DEPENDENTS messages.
virtual void	SetForwardFlagNodesMsgs (bool state)=0
	Sets whether to monitor for REFMSG_FLAG_NODES_WITH_SEL_DEPENDENTS messages.
virtual bool	GetForwardEnumDependentsCalls ()=0
	Retrieves whether to monitor for EnumDependentImp calls.
virtual void	SetForwardEnumDependentsCalls (bool state)=0
	Sets whether to monitor for EnumDependentImp calls.
FPInterfaceDesc *	GetDesc ()
virtual Interface_ID	GetID ()
BEGIN_FUNCTION_MAP	PROP_FNS (kfpGetnode, GetNode, kfpSetnode, SetNode, TYPE_INODE)
	PROP_FNS (kfpGetforwardPartTM, GetForwardTransformChangeMsgs, kfpSetforwardPartTM, SetForwardTransformChangeMsgs, TYPE_bool)
	PROP_FNS (kfpGetforwardFlagNodes, GetForwardFlagNodesMsgs, kfpSetforwardFlagNodes, SetForwardFlagNodesMsgs, TYPE_bool)
	PROP_FNS (kfpGetforwardEnumDependents, GetForwardEnumDependentsCalls, kfpSetforwardEnumDependents, SetForwardEnumDependentsCalls, TYPE_bool)

---

Member Enumeration Documentation

anonymous enum

Search for all occurrences

Enumerator:

kfpGetnode	Search for all occurrences
kfpSetnode	Search for all occurrences
kfpGetforwardPartTM	Search for all occurrences
kfpSetforwardPartTM	Search for all occurrences
kfpGetforwardFlagNodes	Search for all occurrences
kfpSetforwardFlagNodes	Search for all occurrences
kfpGetforwardEnumDependents	Search for all occurrences
kfpSetforwardEnumDependents	Search for all occurrences

             {  
                kfpGetnode, kfpSetnode,
                kfpGetforwardPartTM, kfpSetforwardPartTM,
                kfpGetforwardFlagNodes, kfpSetforwardFlagNodes,
                kfpGetforwardEnumDependents, kfpSetforwardEnumDependents,
        };

---

Member Function Documentation

virtual INode* GetNode

(

)

[pure virtual]

Search for all occurrences

Retrieves the node being watched.

Returns:

INode pointer to the node being watched.

virtual void SetNode

(

INode *

theNode

)

[pure virtual]

Search for all occurrences

Sets the node being watched.

Parameters:

theNode

- Pointer to node to be watched. Can be NULL.

virtual bool GetForwardTransformChangeMsgs

(

)

[pure virtual]

Search for all occurrences

Retrieves whether to monitor for REFMSG_CHANGE / PART_TM messages.

Returns:

True if to monitor for REFMSG_CHANGE / PART_TM messages.

virtual void SetForwardTransformChangeMsgs

(

bool

state

)

[pure virtual]

Search for all occurrences

Sets whether to monitor for REFMSG_CHANGE / PART_TM messages.

Parameters:

state

- True if to monitor for REFMSG_CHANGE / PART_TM messages.

virtual bool GetForwardFlagNodesMsgs

(

)

[pure virtual]

Search for all occurrences

Retrieves whether to monitor for REFMSG_FLAG_NODES_WITH_SEL_DEPENDENTS messages.

Returns:

True if to monitor for REFMSG_FLAG_NODES_WITH_SEL_DEPENDENTS messages.

virtual void SetForwardFlagNodesMsgs

(

bool

state

)

[pure virtual]

Search for all occurrences

Sets whether to monitor for REFMSG_FLAG_NODES_WITH_SEL_DEPENDENTS messages.

Parameters:

state

- True if to monitor for REFMSG_FLAG_NODES_WITH_SEL_DEPENDENTS messages.

virtual bool GetForwardEnumDependentsCalls

(

)

[pure virtual]

Search for all occurrences

Retrieves whether to monitor for EnumDependentImp calls.

Returns:

True if to monitor for EnumDependentImp calls.

virtual void SetForwardEnumDependentsCalls

(

bool

state

)

[pure virtual]

Search for all occurrences

Sets whether to monitor for EnumDependentImp calls.

Parameters:

state

- True if to monitor for EnumDependentImp calls.

FPInterfaceDesc* GetDesc

(

)

[virtual]

Search for all occurrences

Remarks:

Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

virtual Interface_ID GetID

(

)

[inline, virtual]

Search for all occurrences

Remarks:

This method overrides GetID() in those interfaces that do not publish metadata but instead have a unique Interface_ID for quick internal identification in implementation code that might be shared by a bunch of mixin interfaces.

Returns:

The Interface_ID.

Default Implementation:

{ return GetDesc()->ID; }

Reimplemented from FPMixinInterface.

{ return IID_NODETRANSFORMMONITOR; }

BEGIN_FUNCTION_MAP PROP_FNS	(	kfpGetnode	,
		GetNode	,
		kfpSetnode	,
		SetNode	,
		TYPE_INODE
	)

Search for all occurrences

PROP_FNS	(	kfpGetforwardPartTM	,
		GetForwardTransformChangeMsgs	,
		kfpSetforwardPartTM	,
		SetForwardTransformChangeMsgs	,
		TYPE_bool
	)

Search for all occurrences

PROP_FNS	(	kfpGetforwardFlagNodes	,
		GetForwardFlagNodesMsgs	,
		kfpSetforwardFlagNodes	,
		SetForwardFlagNodesMsgs	,
		TYPE_bool
	)

Search for all occurrences

PROP_FNS	(	kfpGetforwardEnumDependents	,
		GetForwardEnumDependentsCalls	,
		kfpSetforwardEnumDependents	,
		SetForwardEnumDependentsCalls	,
		TYPE_bool
	)

Search for all occurrences