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::ITool Interface Reference

Tool. More...

Public Member Functions

bool IsAvailable ()
 Will be called before the tool gets started to check if the tool is currently available. More...
 
bool Start (String^ pArguments, IToolTemplate^ pTemplate)
 Will be called if the tool was started. More...
 
void Abort ()
 Will be called if the tool was aborted. More...
 
void Finish ()
 Will be called if the tool was finished. More...
 
void StartPoint ()
 Will be called if the next tool step has started. More...
 
void FinishPoint ()
 Will be called if the current tool step was finished. More...
 
void PointUpdated ()
 Will be called every time the current point has changed (e.g. More...
 

Detailed Description

Tool.

Member Function Documentation

void X3g::Plugin::ITool::Abort ( )

Will be called if the tool was aborted.

void X3g::Plugin::ITool::Finish ( )

Will be called if the tool was finished.

void X3g::Plugin::ITool::FinishPoint ( )

Will be called if the current tool step was finished.

bool X3g::Plugin::ITool::IsAvailable ( )

Will be called before the tool gets started to check if the tool is currently available.

void X3g::Plugin::ITool::PointUpdated ( )

Will be called every time the current point has changed (e.g.

the mouse was moved).

bool X3g::Plugin::ITool::Start ( String pArguments,
IToolTemplate pTemplate 
)

Will be called if the tool was started.

If this function returns false then the tool start will be canceled.

void X3g::Plugin::ITool::StartPoint ( )

Will be called if the next tool step has started.