IRefTargMonitor Class Reference

#include <IRefTargMonitor.h>

Class Description

The interface for an owner of a RefTargMonitorRefMaker class.

The owner of a RefTargMonitorRefMaker instance must implement this interface. Messages from the RefTargMonitorRefMaker instance are passed to the owner through this interface.

See also

RefTargMonitorRefMaker, IIndirectReferenceMaker

Inheritance diagram for IRefTargMonitor:

Public Member Functions
virtual RefResult	ProcessRefTargMonitorMsg (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, bool fromMonitoredTarget, bool propagate, RefTargMonitorRefMaker *caller)=0
	Calls to the RefTargMonitorRefMaker instance's NotifyRefChanged method are passed to its owner through this method. More...
virtual int	ProcessEnumDependents (DependentEnumProc *dep)=0
	Calls to the RefTargMonitorRefMaker instance's DoEnumDependents method are passed to its owner through this method. More...

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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...

Member Function Documentation

virtual RefResult ProcessRefTargMonitorMsg ( const Interval &  changeInt, RefTargetHandle  hTarget, PartID &  partID, RefMessage  message, bool  fromMonitoredTarget, bool  propagate, RefTargMonitorRefMaker *  caller  )

pure virtual

Calls to the RefTargMonitorRefMaker instance's NotifyRefChanged method are passed to its owner through this method.

The RefTargMonitorRefMaker owner is responsible for ensuring that an infinite recursion of message passing does not occur. Typically the owner would set a flag while propogating a message, and not propogate a new message if that flag is set.

Since the owner doesn't hold a reference to the RefTargMonitorRefMaker's watched object, the watched object may not be saved or loaded when the owner is saved or loaded. The owner must handle this case. Typically, the owner would also derive from IIndirectReferenceMaker, which will result in the watched object being saved and loaded. For an example, see the NodeTransformMonitor class in maxsdk\samples\controllers\nodetransformmonitor.cpp.

The arguments to this method, other than fromMonitoredTarget, correspond to the arguments of ReferenceMaker::NotifyRefChanged.

Parameters

changeInt	- This is the interval of time over which the message is active.
hTarget	- This is the handle of the reference target the message was sent by.
partID	- This contains information specific to the message passed in.
message	- The message which needs to be handled.
fromMonitoredTarget	- true if message originated from RefTargMonitorRefMaker's monitored target.
propagate	- If called through ReferenceMaker::NotifyDependents(), the value of 'propagate' passed to it. Used if calling NotifyDependents() from within NotifyRefChanged().
caller	- The RefTargMonitorRefMaker instance making this call. May be needed if multiple instances reference the monitored target.

Returns

Typically REF_SUCCEED indicating the message was processed.

virtual int ProcessEnumDependents ( DependentEnumProc *  dep )

pure virtual

Calls to the RefTargMonitorRefMaker instance's DoEnumDependents method are passed to its owner through this method.

The RefTargMonitorRefMaker owner is responsible for ensuring that an infinite recursion does not occur. Typically the owner would set a flag while enumerating dependents, and not start a new enumeration if that flag is set.

Parameters

dep	- the DependentEnumProc.

Returns

1 to stop the enumeration and 0 to continue.