Class SubClassList
See Also: Class DllDir, Class ClassDirectory, Class ClassEntry, Class ClassDesc, Class SClassUIInfo.
class SubClassList
Description:
This class is available in release 2.0 and later only.
A sub class list is a table of ClassEntry objects that provide information on plug-in classes as well as usage counts for these classes within 3ds max. These sub class lists are organized by super class ID by the ClassDirectory class.
All methods of this class are implemented by the system.
Methods:
Prototype:
int FindClass(Class_ID subClassID);
Remarks:
Returns the index in the list of sub-classes of the class whose Class_ID is passed.
Parameters:
Class_ID subClassID
Specifies which class to return the index of.
Prototype:
ulong SuperID();
Remarks:
Returns the Super class ID corresponding to this sub-class list.
Prototype:
int Count(int accType);
Remarks:
Returns the number of sub-classes that match the specified access type.
Parameters:
int accType
One of the following values:
ACC_PUBLIC - public classes
ACC_PRIVATE - non-public classes
ACC_ALL - both of the above (ACC_PUBLIC|ACC_PRIVATE).
Prototype:
int FindClass(const TCHAR *name);
Remarks:
Returns the index in the list of sub-classes of the class whose ClassName() is passed.
Parameters:
const TCHAR *name
Specifies which class to return the index of.
Prototype:
int GetFirst(int accType);
Remarks:
Returns the index of the first ClassDesc of the specified type in the list of sub-classes.
Parameters:
int accType
One of the following values:
ACC_PUBLIC - public classes
ACC_PRIVATE - non-public classes
Prototype:
int GetNext(int accType);
Remarks:
Returns the index of the next ClassDesc of the specified type (or -1 at the end).
Parameters:
int accType
One of the following values:
ACC_PUBLIC - public classes
ACC_PRIVATE - non-public classes
Prototype:
void AddClass(ClassDesc *cld, int dllNum, int index);
Remarks:
This method is used internally.
Prototype:
void SetUIInfo(SClassUIInfo *uiInfo);
Remarks:
This method is available in release 3.0 and later only.
Allows developer to provide some additional information on a superclass. Currently this includes a color, and a method which draws a representative image in a Windows DC.
Parameters:
SClassUIInfo *uiInfo
Points to the information to set.
Prototype:
SClassUIInfo *GetUIInfo();
Remarks:
This method is available in release 3.0 and later only.
This method returns additional user interface related information on a given superclass. Returns NULL if no superclass information was assigned.
Prototype:
void ReplaceClass(int idx, ClassDesc *cld, int dllNum, int index, bool load);
Remarks:
This method is available in release 3.0 and later only.
This method is for internal use only.
Operators:
Prototype:
int operator==(const SubClassList& lst) const;
Remarks:
Equality operator.
Prototype:
int operator==(const SubClassList &sl);
Remarks:
Equality operator.
Prototype:
ClassEntry& operator[](int i);
Remarks:
Returns a reference to the 'i-th' ClassEntry for this super class.
Parameters:
int i
The index of the entry to return. Valid values begin at an index of 1.