module::ngui::snap::tool Class Reference

Interactive tool that provides "snappable" transformations for objects. More...

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

List of all members.

Classes

struct  implementation

Public Member Functions

 tool ()
 ~tool ()
const k3d::string_t tool_type ()
 Returns a unique string identifying the tool type.
k3d::iproperty_collectionget_property_collection ()
 Asks for tool's property collection.
viewport_input_modelget_input_model ()
 Returns the tool's user input model.

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.
void on_activate ()
 Called when the tool is activated - override in derived classes to implement custom behavior.
void on_deactivate ()
 Called when the tool is deactivated - override in derived classes to implement custom behavior.
void on_document_selection_changed ()
 Called when the document selection changed - override in derived classes to implement custom behavior.
void on_redraw (viewport::control &Viewport)
 Called to give the tool a chance to draw in the viewport.
void on_select (viewport::control &Viewport)
 Called to give the tool a chance to draw in the viewport.

Private Attributes

implementationm_implementation

Detailed Description

Interactive tool that provides "snappable" transformations for objects.


Constructor & Destructor Documentation

module::ngui::snap::tool::tool (  ) 

Reimplemented from k3d::ngui::tool.

module::ngui::snap::tool::~tool (  )  [virtual]

Reimplemented from k3d::ngui::tool.

References m_implementation.


Member Function Documentation

k3d::iplugin_factory & module::ngui::snap::tool::get_factory (  )  [static]
viewport_input_model & module::ngui::snap::tool::get_input_model (  )  [virtual]

Returns the tool's user input model.

Implements k3d::ngui::tool.

References module::ngui::snap::snap_tool_detail::input_model(), and m_implementation.

k3d::iproperty_collection * module::ngui::snap::tool::get_property_collection (  )  [virtual]

Asks for tool's property collection.

Reimplemented from k3d::ngui::tool.

References m_implementation.

void module::ngui::snap::tool::on_activate (  )  [private, virtual]

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

Reimplemented from k3d::ngui::tool.

References m_implementation, and module::ngui::snap::tool::implementation::on_activate().

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

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

Reimplemented from k3d::ngui::tool.

References m_implementation, and module::ngui::snap::tool::implementation::on_deactivate().

void module::ngui::snap::tool::on_document_selection_changed (  )  [private, virtual]

Called when the document selection changed - override in derived classes to implement custom behavior.

Reimplemented from k3d::ngui::tool.

References m_implementation, and module::ngui::snap::tool::implementation::on_document_selection_changed().

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

Called when the tool is initialized.

Reimplemented from k3d::ngui::tool.

References k3d::ngui::document_state::document(), and m_implementation.

void module::ngui::snap::tool::on_redraw ( viewport::control Viewport  )  [private, virtual]

Called to give the tool a chance to draw in the viewport.

Reimplemented from k3d::ngui::tool.

References m_implementation, and module::ngui::snap::tool::implementation::on_redraw().

void module::ngui::snap::tool::on_select ( viewport::control Viewport  )  [private, virtual]

Called to give the tool a chance to draw in the viewport.

Reimplemented from k3d::ngui::tool.

References m_implementation, and module::ngui::snap::tool::implementation::on_select().

const k3d::string_t module::ngui::snap::tool::tool_type (  )  [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:47 2011 for K-3D by doxygen 1.6.3