MQObjectPlugin class

(new in Rev2.40)

MQObjectPlugin class inherits MQBasePlugin class, and provides functions necessary for an implementation of a Object plug-in.

You can make an Object plug-in with a simple implementation and without taking care of complex message procedures between a plug-in and a main part of Metasequoia by inheriting this MQObjectPlugin class and implementing required virtual functions.

In MQObjectPlugin class, each plug-in member functions and messages are declared as virtual functions. It is necessary to implement the virtual function in the inherited class.

 

Class
MQObjectPlugin Constructor
~MQObjectPlugin Destructor
Declared in super class
GetPlugInID Get a plug-in ID
GetPlugInName Get a plug-in name
Plug-in
GetPlugInType Get a plug-in type
EnumString Enumerate displayed strings
Execute Modify an object
Supplemental functions for the super class
OpenSetting Open a setting file
CloseSetting Close a setting file
GetResourceString Get a resource string
GetSettingValue Get a setting value
GetSystemColor Get a system color
GetResourceCursor Get a default mouse cursor
GetScreenMouseCursor Get a mouse cursor for a screen
SetScreenMouseCursor Set a mouse cursor for a screen
GetLUTCount Get a number of LUTs
GetLUTName Get a LUT's name
GetLUTData Get LUT data
GetSceneOption Get display options of the scene
GetEditOption Get edit options
GetDisplayUnit Get a display unit
GetDisplayUnitString Get display unit's string and scale/td>
GetFilename Get a filename
SaveDocument Save a document
InsertDocument Insert a document
EnumLoadableImages Get loadable image formats
SendUserMessage Send a plugin-in own message to the other plug-ins
SetDrawProxyObject Set a draw proxy object
UpdateUndo Update an undo buffer

MQObjectPlugin::MQObjectPlugin();

This method is a constructor.


virtual MQObjectPlugin::~MQObjectPlugin();

This method is a destructor. It is defined as a virtual function.


virtual int MQObjectPlugin::GetPlugInType();

Return value
A plug-in type
[MQPLUGIN_TYPE_OBJECT] Object plug-in

This method implements a virtual function declared by MQBasePlugin::GetPlugInType(). No additional implementation is necessary in an inherited class.


virtual const char *MQObjectPlugin::EnumString(int index);

index
An index
Return value
A displayed string

It returns a displayed string for a menu and so on.

This function is called when Metasequoia starts up. The 'index' is called sequentially from 0, and the call ends  when this function returns NULL.

This method implements a virtual function declared by MQEnumString(). No additional implementation is necessary in an inherited class.


virtual BOOL MQObjectPlugin::Execute(int index, MQDocument doc);

index
An index
doc
A document
Return value
Succeeded or failed
[TRUE] Succeeded to modify
[FALSE] Failed to modify

It modifies an object.

This method implements a virtual function declared by MQModifyObject(). No additional implementation is necessary in an inherited class.