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

This tool let the user chose a room. More...

Public Types

enum  IgnoreFlags : int
 Ignore certain room splitting elements. More...
 

Public Member Functions

 SelectRoom ()
 The user will select a room (or abort). More...
 
bool Start ()
 Try to start the tool. More...
 

Properties

IgnoreFlags Ignore
 Ignore certain elements when selecting a room. More...
 
 HandleToolAborted
 Modify what and how to collect. More...
 

Detailed Description

This tool let the user chose a room.

Member Enumeration Documentation

Ignore certain room splitting elements.

Constructor & Destructor Documentation

X3g::Plugin::Tool::SelectRoom::SelectRoom ( )

The user will select a room (or abort).

Member Function Documentation

bool X3g::Plugin::Tool::SelectRoom::Start ( )

Try to start the tool.

On success true is returned.

Property Documentation

void X3g::Plugin::Tool::SelectRoom::HandleToolAborted

Modify what and how to collect.

IgnoreFlags X3g::Plugin::Tool::SelectRoom::Ignore

Ignore certain elements when selecting a room.

Has to be set before calling "Start();".