ClassEntry Class Reference
#include <plugin.h>
Class 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.
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. More... | |
| CoreExport int | IsPublic () const |
| Returns nonzero if the class is public; otherwise zero. More... | |
| CoreExport Class_ID | ClassID () const |
| Returns the Class_ID of the wrapped ClassDesc. More... | |
| CoreExport MSTR & | ClassName () const |
| Returns the class name of the wrapped ClassDesc. More... | |
| CoreExport MSTR & | Category () const |
| Returns the category for the wrapped ClassDesc. More... | |
| CoreExport int | UseCount () const |
| Returns the number of instance of this class used in 3ds Max. More... | |
| 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. More... | |
| CoreExport bool | IsLoaded () const |
| Returns true if the wrapped ClassDesc is loaded, false if it's defer loaded. More... | |
| CoreExport int | ClassNumber () const |
| Returns the index of the wrapped class descriptor within the plug-in Dll. More... | |
| CoreExport ClassDesc * | CD () const |
| Returns a pointer to the wrapped class descriptor. More... | |
| 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. More... | |
| CoreExport ClassEntry & | operator= (const ClassEntry &ce) |
| Assignment operator. More... | |
| CoreExport int | operator== (const ClassEntry &ce) const |
| Equality operator. More... | |
Internal methods | |
| 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 |
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... | |
Constructor & Destructor Documentation
| CoreExport ClassEntry | ( | ) |
| CoreExport ClassEntry | ( | const ClassEntry & | ce | ) |
| CoreExport ClassEntry | ( | ClassDesc * | cld, |
| int | dllN, | ||
| int | index, | ||
| bool | load | ||
| ) |
| CoreExport ~ClassEntry | ( | ) |
Member Function Documentation
| 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.
Non-public classes are those that are meant for private use by other plug-ins.
| CoreExport Class_ID ClassID | ( | ) | const |
| CoreExport MSTR& ClassName | ( | ) | const |
Returns the 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 | ( | ) |
This is used internally to increment the usage count for this entry.
| CoreExport void SetUseCount | ( | int | i | ) |
This is used internally to set the usage count for this entry.
| 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
| 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.
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.
| 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.
| CoreExport ClassEntry& operator= | ( | const ClassEntry & | ce | ) |
Assignment operator.
| CoreExport int operator== | ( | const ClassEntry & | ce | ) | const |
Equality operator.
Always returns 0.
| CoreExport void Set | ( | ClassDesc * | cld, |
| int | dllN, | ||
| int | index, | ||
| bool | load | ||
| ) |
This method is used internally.
| CoreExport int GetScroll | ( | ) | const |
This method is used internally.
| CoreExport void SetScroll | ( | int | s | ) |
This method is used internally.
| CoreExport BOOL PageStateSet | ( | ) | const |
Tests if page state has been actually been set, default initializes to 0x7fffffff
| CoreExport BOOL GetPageState | ( | int | i | ) | const |
This method is used internally.
| CoreExport void SetPageState | ( | int | i, |
| BOOL | state | ||
| ) |
This method is used internally.
| CoreExport DWORD GetPageState | ( | ) | const |
This method is used internally.