pCon.planner Plugin SDK  Version 8.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | List of all members
X3g::Plugin::IActionManager Class Referenceabstract

Action Manager. More...

Public Member Functions

virtual void RegisterAction (String^ pActionKey)=0
 Registers an action with given action key. More...
 
virtual void UnregisterAction (String^ pActionKey)=0
 Unregisters an action via action key. More...
 
virtual void RegisterTool (String^ pToolKey, ITool^ pTool)=0
 Registers a tool. More...
 
virtual void UnregisterTool (String^ pToolKey)=0
 Unregisters a tool. More...
 
bool ExecuteAction (String^ pKey, String^ pArguments)
 Executes an action or a tool with given optional arguments. More...
 
void PlaceEntities (IEnumerable< DbEntity^ >^pEntities, bool pRotate)
 Starts tool which allows user to place given top-level entities. More...
 

Detailed Description

Action Manager.

Member Function Documentation

bool X3g::Plugin::IActionManager::ExecuteAction ( String pKey,
String pArguments 
)

Executes an action or a tool with given optional arguments.

void X3g::Plugin::IActionManager::PlaceEntities ( IEnumerable< DbEntity^ >^  pEntities,
bool  pRotate 
)

Starts tool which allows user to place given top-level entities.

Entities are erased if user aborts the placement.

Parameters
pRotateEnables rotation when positioning is done.
virtual void X3g::Plugin::IActionManager::RegisterAction ( String pActionKey)
pure virtual

Registers an action with given action key.

An action results in behavior provided by the given plugin. The key must be unique within all registered plugin actions. Each time the action is executed, X3gAction() gets called. A registered action can also be triggered by a gui element provided in the manifest.

virtual void X3g::Plugin::IActionManager::RegisterTool ( String pToolKey,
ITool pTool 
)
pure virtual

Registers a tool.

virtual void X3g::Plugin::IActionManager::UnregisterAction ( String pActionKey)
pure virtual

Unregisters an action via action key.

virtual void X3g::Plugin::IActionManager::UnregisterTool ( String pToolKey)
pure virtual

Unregisters a tool.