PluginToolsInterface Class Reference

#include <plugintools.h>

Static Public Member Functions
static MAXON_METHOD Int32	GetPluginId ()
static MAXON_FUNCTION maxon::ClassicCommandSettings	CreateCustomCommandSettings (const String &id, const String &name, const String &path)
static MAXON_METHOD Result< void >	AddToPluginStart (Delegate< Result< void >()> d)
static MAXON_METHOD Result< void >	AddToPluginMessage (Delegate< Result< void >(Int32 id, void *data)> d)
static MAXON_METHOD Result< void >	AddToPluginEnd (Delegate< Result< void >()> d)
static MAXON_METHOD Result< void >	ExecutePluginStart ()
static MAXON_METHOD Result< void >	ExecutePluginMessage (Int32 id, void *data)
static MAXON_METHOD Result< void >	ExecutePluginEnd ()

Private Member Functions
	MAXON_INTERFACE_NONVIRTUAL (PluginToolsInterface, MAXON_REFERENCE_NONE, "net.sdktools.interfaces.plugintools")

Member Function Documentation

MAXON_INTERFACE_NONVIRTUAL()

MAXON_INTERFACE_NONVIRTUAL ( PluginToolsInterface  , MAXON_REFERENCE_NONE  , "net.sdktools.interfaces.plugintools"    )

private

GetPluginId()

static MAXON_METHOD Int32 GetPluginId ( )

static

Returns a plugin ID for classic API plugins. The ID value depends on previous calls to GetPluginId() so the value may be different every time.

Returns

A plugin ID.

CreateCustomCommandSettings()

static MAXON_FUNCTION maxon::ClassicCommandSettings CreateCustomCommandSettings ( const String &  id, const String &  name, const String &  path  )

static

Utility function to create a new ClassicCommandSettings object for use with SDKDatabaseInterface::AddClassicCommand(). The plugin ID is automatically set. Added here so there is no coupling between inter.database and cinema.framework

Parameters

[in]	id	ID of the command.
[in]	name	Name of the command (GUI display).
[in]	path	Menu path of the command (GUI display).

Returns

A new ClassicCommandSettings object

AddToPluginStart()

static MAXON_METHOD Result<void> AddToPluginStart ( Delegate< Result< void >()>  d )

static

The given delegate is called on PluginStart().

Parameters

[in]

d

Function delegate.

Returns

maxon::OK on success.

AddToPluginMessage()

static MAXON_METHOD Result<void> AddToPluginMessage ( Delegate< Result< void >(Int32 id, void *data)>  d )

static

The given delegate is called for each message sent to PluginMessage().

Parameters

[in]

d

Function delegate.

Returns

maxon::OK on success.

AddToPluginEnd()

static MAXON_METHOD Result<void> AddToPluginEnd ( Delegate< Result< void >()>  d )

static

The given delegate is called on PluginEnd().

Parameters

[in]

d

Function delegate.

Returns

maxon::OK on success.

ExecutePluginStart()

static MAXON_METHOD Result<void> ExecutePluginStart ( )

static

Executes all delegates registered with AddToPluginStart()

Warning

Must not be used outside of sdk_database.module.

Returns

maxon::OK on success.

ExecutePluginMessage()

static MAXON_METHOD Result<void> ExecutePluginMessage ( Int32  id, void *  data  )

static

Executes all delegates registered with AddToPluginMessage().

Warning

Must not be used outside of sdk_database.module.

Returns

maxon::OK on success.

ExecutePluginEnd()

static MAXON_METHOD Result<void> ExecutePluginEnd ( )

static

Executes all delegates registered with AddToPluginEnd().

Warning

Must not be used outside of sdk_database.module.

Returns

maxon::OK on success.