INodeTransformMonitor Class Reference

The interface for working with NodeTransformMonitor class. More...

#include <INodeTransformMonitor.h>

Inheritance diagram for INodeTransformMonitor:

Public Types
enum	{   kfpGetnode , kfpSetnode , kfpGetforwardPartTM , kfpSetforwardPartTM ,   kfpGetforwardFlagNodes , kfpSetforwardFlagNodes , kfpGetforwardEnumDependents , kfpSetforwardEnumDependents }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

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 ()
	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)
Public Member Functions inherited from FPMixinInterface
	FPMixinInterface ()
virtual LifetimeType	LifetimeControl ()
virtual CoreExport bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
CoreExport	~FPMixinInterface ()
virtual BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDescByID (Interface_ID id)
virtual Interface_ID	GetID ()
Public Member Functions inherited from FPInterface
virtual BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDesc ()=0
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPParams *params)
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
virtual CoreExport FunctionID	FindFn (const MCHAR *name)
virtual CoreExport BOOL	IsEnabled (FunctionID actionID)
virtual CoreExport BOOL	IsChecked (FunctionID actionID)
virtual CoreExport BOOL	IsVisible (FunctionID actionID)
virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)
virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)
virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)
virtual ActionTable *	GetActionTable ()
virtual void	EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor.
UtilExport BaseInterface *	GetInterface (Interface_ID id) override
virtual UtilExport Interface_ID	GetID ()
virtual LifetimeType	LifetimeControl ()
virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface
Protected Member Functions inherited from FPMixinInterface
	FPMixinInterface (const FPMixinInterface &rhs)
FPMixinInterface &	operator= (const FPMixinInterface &rhs)
Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Detailed 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.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kfpGetnode
kfpSetnode
kfpGetforwardPartTM
kfpSetforwardPartTM
kfpGetforwardFlagNodes
kfpSetforwardFlagNodes
kfpGetforwardEnumDependents
kfpSetforwardEnumDependents

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

Member Function Documentation

GetNode()

virtual INode * GetNode ( )

pure virtual

Retrieves the node being watched.

Returns

INode pointer to the node being watched.

SetNode()

virtual void SetNode ( INode *  theNode )

pure virtual

Sets the node being watched.

Parameters

theNode

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

GetForwardTransformChangeMsgs()

virtual bool GetForwardTransformChangeMsgs ( )

pure virtual

Retrieves whether to monitor for REFMSG_CHANGE / PART_TM messages.

Returns

True if to monitor for REFMSG_CHANGE / PART_TM messages.

SetForwardTransformChangeMsgs()

virtual void SetForwardTransformChangeMsgs ( bool  state )

pure virtual

Sets whether to monitor for REFMSG_CHANGE / PART_TM messages.

Parameters

state

- True if to monitor for REFMSG_CHANGE / PART_TM messages.

GetForwardFlagNodesMsgs()

virtual bool GetForwardFlagNodesMsgs ( )

pure virtual

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.

SetForwardFlagNodesMsgs()

virtual void SetForwardFlagNodesMsgs ( bool  state )

pure virtual

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.

GetForwardEnumDependentsCalls()

virtual bool GetForwardEnumDependentsCalls ( )

pure virtual

Retrieves whether to monitor for EnumDependentImp calls.

Returns

True if to monitor for EnumDependentImp calls.

SetForwardEnumDependentsCalls()

virtual void SetForwardEnumDependentsCalls ( bool  state )

pure virtual

Sets whether to monitor for EnumDependentImp calls.

Parameters

state

- True if to monitor for EnumDependentImp calls.

GetDesc()

FPInterfaceDesc * GetDesc ( )

virtual

Remarks

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

Implements FPInterface.

GetID()

virtual Interface_ID GetID ( )

inlinevirtual

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; }

PROP_FNS() [1/4]

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

PROP_FNS() [2/4]

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

PROP_FNS() [3/4]

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

PROP_FNS() [4/4]

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