ClassEntry Class Reference

This class wraps a ClassDesc instance and maintains run-time related information about it. More...

#include <plugin.h>

Inheritance diagram for ClassEntry:

Public Member Functions
CoreExport	ClassEntry ()
CoreExport	ClassEntry (const ClassEntry &ce)
CoreExport	ClassEntry (ClassDesc *cld, int dllN, int index, bool load)
CoreExport	~ClassEntry ()
CoreExport int	DllNumber () const
	Returns the DllDir index of the plug-in dll that exposes the ClassDesc wrapped by this ClassEntry instance.
CoreExport int	IsPublic () const
	Returns nonzero if the class is public; otherwise zero.
CoreExport Class_ID	ClassID () const
	Returns the Class_ID of the wrapped ClassDesc.
CoreExport MSTR &	ClassName () const
	Returns the class name of the wrapped ClassDesc.
CoreExport MSTR &	NonLocalizedClassName () const
	Returns the non-localized class name of the wrapped ClassDesc.
CoreExport MSTR &	Category () const
	Returns the category for the wrapped ClassDesc.
CoreExport int	UseCount () const
	Returns the number of instance of this class used in 3ds Max.
CoreExport void	IncUseCount ()
CoreExport void	SetUseCount (int i)
CoreExport int	IsAccType (int accType)
	Returns nonzero if this entry matches the specified access type; otherwise zero.
CoreExport bool	IsLoaded () const
	Returns true if the wrapped ClassDesc is loaded, false if it's defer loaded.
CoreExport int	ClassNumber () const
	Returns the index of the wrapped class descriptor within the plug-in Dll.
CoreExport ClassDesc *	CD () const
	Returns a pointer to the wrapped class descriptor.
CoreExport ClassDesc *	FullCD ()
	Force the plug-in Dll that exposes the wrapped ClassDesc to load and returns a pointer to the wrapped and loaded class descriptor.
CoreExport ClassEntry &	operator= (const ClassEntry &ce)
	Assignment operator.
CoreExport int	operator== (const ClassEntry &ce) const
	Equality operator.
Internal methods <br>
CoreExport void	Set (ClassDesc *cld, int dllN, int index, bool load)
CoreExport int	GetScroll () const
CoreExport void	SetScroll (int s)
CoreExport BOOL	PageStateSet () const
CoreExport BOOL	GetPageState (int i) const
CoreExport void	SetPageState (int i, BOOL state)
CoreExport DWORD	GetPageState () const

Static Public Member Functions
static CoreExport int __cdecl	CompareClassEntry (const void *elem1, const void *elem2)
	Comparison method used for Tab<ClassEntry*>::Sort().
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.

Detailed Description

This class wraps a ClassDesc instance and maintains run-time related information about it.

One class ClassEntry instance for each ClassDesc is created by 3ds Max and stored in the ClassDirectory. The ClassEntry maintains information such as the usage count, rollout state etc. All methods of this class are implemented by the system. Client code can access ClassEntry instance via ClassDirectory::FindClassEntry() or various methods of class SubClassList.

See also

Class DllDir, Class SubClassList, Class ClassDesc, Class Class_ID.

Constructor & Destructor Documentation

ClassEntry() [1/3]

CoreExport ClassEntry

(

)

ClassEntry() [2/3]

CoreExport ClassEntry

(

const ClassEntry &

ce

)

ClassEntry() [3/3]

CoreExport ClassEntry	(	ClassDesc *	cld,
		int	dllN,
		int	index,
		bool	load
	)

~ClassEntry()

CoreExport ~ClassEntry

(

)

Member Function Documentation

DllNumber()

CoreExport int DllNumber

(

)

const

Returns the DllDir index of the plug-in dll that exposes the ClassDesc wrapped by this ClassEntry instance.

IsPublic()

CoreExport int IsPublic

(

)

const

Returns nonzero if the class is public; otherwise zero.

Non-public classes are those that are meant for private use by other plug-ins.

ClassID()

CoreExport Class_ID ClassID

(

)

const

Returns the Class_ID of the wrapped ClassDesc.

ClassName()

CoreExport MSTR & ClassName

(

)

const

Returns the class name of the wrapped ClassDesc.

NonLocalizedClassName()

CoreExport MSTR & NonLocalizedClassName

(

)

const

Returns the non-localized class name of the wrapped ClassDesc.

Category()

CoreExport MSTR & Category

(

)

const

Returns the category for the wrapped ClassDesc.

UseCount()

CoreExport int UseCount

(

)

const

Returns the number of instance of this class used in 3ds Max.

IncUseCount()

CoreExport void IncUseCount

(

)

This is used internally to increment the usage count for this entry.

SetUseCount()

CoreExport void SetUseCount

(

int

i

)

This is used internally to set the usage count for this entry.

IsAccType()

CoreExport int IsAccType

(

int

accType

)

Returns nonzero if this entry matches the specified access type; otherwise zero.

Parameters

accType

- One of the following values: ACC_PUBLIC - public classes, ACC_PRIVATE - non-public classes

IsLoaded()

CoreExport bool IsLoaded

(

)

const

Returns true if the wrapped ClassDesc is loaded, false if it's defer loaded.

ClassNumber()

CoreExport int ClassNumber

(

)

const

Returns the index of the wrapped class descriptor within the plug-in Dll.

CD()

CoreExport ClassDesc * CD

(

)

const

Returns a pointer to the wrapped class descriptor.

If the class descriptor corresponds to a defer loaded plug-in, 3ds Max will load that plug-in automatically as soon as it's needed. Developers to not need to load the plug-in themselves.

FullCD()

CoreExport ClassDesc * FullCD

(

)

Force the plug-in Dll that exposes the wrapped ClassDesc to load and returns a pointer to the wrapped and loaded class descriptor.

As of 3ds Max 2012, FullCD() doesn't have to be called to ensure that the wrapped ClassDesc is loaded. 3ds Max loads the class descriptor on demand as soon as client code uses it. See Deferred Loading of Plug-Ins for more details.

operator=()

CoreExport ClassEntry & operator=

(

const ClassEntry &

ce

)

Assignment operator.

operator==()

CoreExport int operator==

(

const ClassEntry &

ce

)

const

Equality operator.

Always returns 0.

CompareClassEntry()

static CoreExport int __cdecl CompareClassEntry ( const void *  elem1, const void *  elem2  )

inlinestatic

Comparison method used for Tab<ClassEntry*>::Sort().

        {
            ClassEntry* ce1 = *((ClassEntry**)elem1);
            ClassEntry* ce2 = *((ClassEntry**)elem2);
 
            if (ce1->ClassName() < ce2->ClassName()) return -1;
            if (ce1->ClassName() > ce2->ClassName()) return 1;
            return 0;
        }

Set()

CoreExport void Set	(	ClassDesc *	cld,
		int	dllN,
		int	index,
		bool	load
	)

This method is used internally.

GetScroll()

CoreExport int GetScroll

(

)

const

This method is used internally.

SetScroll()

CoreExport void SetScroll

(

int

s

)

This method is used internally.

PageStateSet()

CoreExport BOOL PageStateSet

(

)

const

Tests if page state has been actually been set, default initializes to 0x7fffffff

GetPageState() [1/2]

CoreExport BOOL GetPageState

(

int

i

)

const

This method is used internally.

SetPageState()

CoreExport void SetPageState	(	int	i,
		BOOL	state
	)

This method is used internally.

GetPageState() [2/2]

CoreExport DWORD GetPageState

(

)

const

This method is used internally.