GL Studio C++ Runtime API
Public Member Functions | List of all members
Plugin Class Referenceabstract

#include <plugin.h>

Inheritance diagram for Plugin:
TextureLoader BmpImageLoader DDSImageLoader GifImageLoader JpegImageLoader PngImageLoader PsdImageLoader RgbImageLoader TgaImageLoader TiffImageLoader XpmImageLoader

Public Member Functions

virtual ~Plugin ()
 For Polymorphic deletion.
 
virtual const char * Description ()=0
 
virtual const char * Version ()=0
 
virtual const char * PluginType ()=0
 
virtual const char * PluginDataName ()
 
virtual void WritePluginData (DistiAttributePluginData *)
 
virtual void ReadPluginData (DistiAttributePluginData *)
 
virtual void ResetPluginData ()
 
bool IsPluginType (const char *str)
 

Detailed Description

The Plugin class

Member Function Documentation

virtual const char* Description ( )
pure virtual
Returns
A description string used for informational display by the plugin GUI

Implemented in PngImageLoader, DDSImageLoader, GifImageLoader, PsdImageLoader, RgbImageLoader, TgaImageLoader, TiffImageLoader, XpmImageLoader, BmpImageLoader, and JpegImageLoader.

bool IsPluginType ( const char *  str)
inline

Indicates if the plugin is of the specified type.

Parameters
strThe type of the plugin
Returns
true if plugin is the type specified
Remarks
Used by the plug-in manager as a workaround on systems where RTTI is broken
virtual const char* PluginDataName ( )
inlinevirtual

Allows plugin to specify the name of its entry in the PluginData section of the .gls file. This may contain spaces but shall not contain a ':' or a newline. If this is not overriden, PluginData will not be saved or restored.

virtual const char* PluginType ( )
pure virtual
Returns
The type of the plugin

Implemented in TextureLoader.

virtual void ReadPluginData ( DistiAttributePluginData *  )
inlinevirtual

Allows plugin to read in any persistant data of the form SomeAttribute: SomeValue Data will all be single-line. Data will be terminated by '}' or EOF PluginDataName() must be overriden for this to be called.

virtual void ResetPluginData ( )
inlinevirtual

Allows plugin to reset its attributes back to their default value. This allows for new documents to use the default attributes rather than whatever was used last PluginDataName() must be overriden for this to be called.

virtual const char* Version ( )
pure virtual
Returns
A version string used for informational display by the plugin GUI

Implemented in PngImageLoader, DDSImageLoader, GifImageLoader, PsdImageLoader, RgbImageLoader, TgaImageLoader, TiffImageLoader, XpmImageLoader, BmpImageLoader, and JpegImageLoader.

virtual void WritePluginData ( DistiAttributePluginData *  )
inlinevirtual

Allows plugin to write out any persistant data in the form SomeAttribute: SomeValue Data must all be single-line. PluginDataName() must be overriden for this to be called.

The documentation for this class was generated from the following file: