module::ngui::parent::tool Class Reference

User-interface tool that provides interactive node parenting. More...

Inheritance diagram for module::ngui::parent::tool:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 tool ()
 ~tool ()
const k3d::string_t tool_type ()
 Returns a unique string identifying the tool type.

Static Public Member Functions

static k3d::iplugin_factoryget_factory ()

Private Member Functions

virtual void on_initialize (document_state &DocumentState)
 Called when the tool is initialized.
virtual void on_deactivate ()
 Called when the tool is deactivated - override in derived classes to implement custom behavior.
virtual viewport_input_modelget_input_model ()
 Returns the tool's user input model.

Private Attributes

parent::implementationm_implementation

Detailed Description

User-interface tool that provides interactive node parenting.


Constructor & Destructor Documentation

module::ngui::parent::tool::tool (  )  [inline]

Reimplemented from k3d::ngui::tool.

module::ngui::parent::tool::~tool (  )  [inline, virtual]

Reimplemented from k3d::ngui::tool.

References m_implementation.


Member Function Documentation

static k3d::iplugin_factory& module::ngui::parent::tool::get_factory (  )  [inline, static]
virtual viewport_input_model& module::ngui::parent::tool::get_input_model (  )  [inline, private, virtual]

Returns the tool's user input model.

Implements k3d::ngui::tool.

References m_implementation, and module::ngui::parent::implementation::m_input_model.

virtual void module::ngui::parent::tool::on_deactivate (  )  [inline, private, virtual]

Called when the tool is deactivated - override in derived classes to implement custom behavior.

Reimplemented from k3d::ngui::tool.

References k3d::ngui::document_state::clear_cursor_signal(), module::ngui::parent::implementation::m_document_state, and m_implementation.

virtual void module::ngui::parent::tool::on_initialize ( document_state DocumentState  )  [inline, private, virtual]

Called when the tool is initialized.

Reimplemented from k3d::ngui::tool.

References m_implementation.

const k3d::string_t module::ngui::parent::tool::tool_type (  )  [inline, virtual]

Returns a unique string identifying the tool type.

Implements k3d::ngui::tool.

References get_factory(), and k3d::iplugin_factory::name().


Member Data Documentation


The documentation for this class was generated from the following file:

Generated on Mon Mar 21 07:43:45 2011 for K-3D by doxygen 1.6.3