Public Member Functions

GUPList Class Reference

This reference page is linked to from the following overview topics: Writing Global Utility Plug-ins (GUPs).


Search for all occurrences

Detailed Description

See also:
Class GUP, Class GUPManager, Template Class Tab, Class GUPHandler.

Description:
This class is available in release 3.0 and later only.

This class can be used to create instance of GUP plug-ins on the fly, if needed. It is accessed through the GUPManager object. It keeps a list of available GUP plug-ins. An example of this can be found in /MAXSDK/SAMPLES/UTILITIES/COMSRV. This is a standard Utility plug-in which is used to give the GUP plug-in COMSRV a user interface.

#include <gup.h>

Inheritance diagram for GUPList:
Inheritance graph
[legend]

List of all members.

Public Member Functions

GUPExport  GUPList ()
GUPExport int  FindGup (const Class_ID id)
GUPExport GUP CreateInstance (const Class_ID id)

Constructor & Destructor Documentation

GUPExport GUPList ( ) [inline]
Remarks:
Constructor.
{ ; }

Member Function Documentation

GUPExport int FindGup ( const Class_ID  id )
Remarks:
Returns the zero based index of the specified GUP plug-in in the list maintain by this class. If not found -1 is returned.
Parameters:
const Class_ID id

Identifies the plug-in to find using its unique Class_ID.
GUPExport GUP* CreateInstance ( const Class_ID  id )
Remarks:
This method is used to create a new instance of the GUP plug-in whose Class_ID is specified. If it succeeds, it returns a newly created instance of a GUP object. A developer may then use the GUP::Control() method to communicate with the GUP object.
Parameters:
const Class_ID id

Identifies the plug-in to create.

GUPList GUPList GUPList GUPList GUPList GUPList GUPList GUPList GUPList GUPList
GUPList GUPList GUPList GUPList GUPList GUPList GUPList GUPList GUPList GUPList