FindMAXWrapperEnum Class Reference

#include <mxsobjects.h>

Inheritance diagram for FindMAXWrapperEnum:

Public Member Functions
	FindMAXWrapperEnum (ReferenceTarget *ref, ValueMetaClass *tag, bool(*finalCheckProc)(MAXWrapper *, void *)=nullptr, void *arg=nullptr)
int	proc (ReferenceMaker *rm) override
	This is the method called by system from ReferenceTarget::DoEnumDependentsImpl().
Public Member Functions inherited from DependentEnumProc
virtual int	proc (ReferenceMaker *rmaker)=0
	This is the method called by system from ReferenceTarget::DoEnumDependentsImpl().
CoreExport bool	CheckIfAndSetAsVisited (ReferenceMaker *rmaker)
	This method sets and checks whether a ReferenceMaker was visited.

Public Attributes
Value *	result

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.
Protected Member Functions inherited from DependentEnumProc
CoreExport	DependentEnumProc ()
virtual CoreExport	~DependentEnumProc ()
	DependentEnumProc (const DependentEnumProc &)
DependentEnumProc &	operator= (const DependentEnumProc &rhs)

Constructor & Destructor Documentation

FindMAXWrapperEnum()

FindMAXWrapperEnum ( ReferenceTarget *  ref, ValueMetaClass *  tag, bool(*)(MAXWrapper *, void *)  finalCheckProc = nullptr, void *  arg = nullptr  )

inline

    {
        mytag = tag;
        myref = ref;
        result = nullptr;
        this->finalCheckProc = finalCheckProc;
        this->arg = arg;
    }

Member Function Documentation

proc()

int proc ( ReferenceMaker *  rmaker )

inlineoverridevirtual

This is the method called by system from ReferenceTarget::DoEnumDependentsImpl().

Parameters

rmaker

- A pointer to the reference maker

Returns

One of the following values:

• DEP_ENUM_CONTINUE: This continues the enumeration
• DEP_ENUM_HALT: This stops the enumeration.
• DEP_ENUM_SKIP: Reference Targets can have multiple Reference Makers (dependents). In certain instances when DoEnumDependents() is used to enumerate them you may not want to travel up all of the "branches". By returning DEP_ENUM_SKIP from this method you tell the enumerator to not enumerate the current Reference Maker's dependents but not to halt the enumeration completely.

See also

ReferenceTarget::DoEnumDependentsImpl(DependentEnumProc* dep)

ReferenceTarget::DoEnumDependents(DependentEnumProc* dep)

Implements DependentEnumProc.

    {
        if (rm == myref) 
            return DEP_ENUM_CONTINUE;
        if (rm->SuperClassID() == MAXSCRIPT_WRAPPER_CLASS_ID && 
            ((MAXWrapper*)rm)->tag == mytag &&
            rm->NumRefs() && rm->GetReference(0) == myref &&
            (finalCheckProc == nullptr || (*finalCheckProc)((MAXWrapper*)rm, arg))
            ) 
        {
            result = (MAXWrapper*)rm;
            return DEP_ENUM_HALT;
        }
        return DEP_ENUM_SKIP; // just look at direct dependents
    }

Member Data Documentation

result

Value* result