maquina::ToolPlugin Class Reference

A Tool node plug-in. More...

#include <ToolPlugin.h>

Inheritance diagram for maquina::ToolPlugin:

Public Member Functions
	ToolPlugin (Node *node)
virtual void	activate ()
virtual void	deactivate ()
virtual void	on_mouse_press (const CameraContext &camera, const InteractionContext &interaction)
virtual void	on_mouse_move (const CameraContext &camera, const InteractionContext &interaction)
virtual void	on_mouse_release (const CameraContext &camera, const InteractionContext &interaction)
virtual bool	on_key_press (int32_t key, int32_t modifiers)
	Called when a key is pressed while the tool is active. More...
virtual bool	on_key_release (int32_t key, int32_t modifiers)
	Called when a key is released while the tool is active. More...
virtual bool	override_selection ()
virtual bool	track_mouse ()
virtual bool	manipulates ()
virtual Array	get_help (const char *tool)
virtual Array	get_status (const char *tool)
Public Member Functions inherited from maquina::NodePlugin
	NodePlugin (Node *node)
virtual	~NodePlugin ()
virtual void	on_first_init (bool)
	Perform the one shot initialization tasks for this node. More...
virtual void	on_delete (bool)
	Prepare the node to be deleted. More...
virtual void	on_add_to_document ()
	Callback called when the node is added to the document. More...
virtual void	on_remove_from_document ()
	Callback called when the node is removed from the document. More...
virtual void	on_input_connection (const Plug &, const Plug &, bool)
	Callback called when an a connection has been done between an output plug and a plug of this node as input. More...
virtual void	on_output_connection (const Plug &, const Plug &, bool)
	Callback called when an a connection has been done between a plug of this node as output and an input plug. More...
virtual void	on_input_disconnection (const Plug &, const Plug &)
	Callback called when an a connection has been broken between an output plug and a plug of this node as input. More...
virtual void	on_output_disconnection (const Plug &, const Plug &)
	Callback called when an a connection has been broken between a plug of this node as output and an input plug. More...
virtual void	relationship (NodeSet &set) const
	Return the node relationships. More...
virtual std::shared_ptr< NodeDelegate >	node_delegate () const
	Return a node delegate for this node. More...
Node	node () const
	Returns the Node interface for this object. More...
virtual std::string	selection_path () const
	Returns the node delegate path to use to select that node. More...

Detailed Description

A Tool node plug-in.

A tool node can be used to modify the document using viewport interactions.

Constructor & Destructor Documentation

ToolPlugin()

maquina::ToolPlugin::ToolPlugin

(

Node *

node

)

Member Function Documentation

activate()

virtual void maquina::ToolPlugin::activate ( )

virtual

Reimplemented in maquina::BrushPlugin.

deactivate()

virtual void maquina::ToolPlugin::deactivate ( )

virtual

Reimplemented in maquina::BrushSculptPlugin, and maquina::BrushPlugin.

get_help()

virtual Array maquina::ToolPlugin::get_help ( const char *  tool )

virtual

get_status()

virtual Array maquina::ToolPlugin::get_status ( const char *  tool )

virtual

manipulates()

virtual bool maquina::ToolPlugin::manipulates ( )

virtual

Reimplemented in maquina::BrushPlugin.

on_key_press()

virtual bool maquina::ToolPlugin::on_key_press ( int32_t  key, int32_t  modifiers  )

virtual

Called when a key is pressed while the tool is active.

Returns true if the key event is accepted. The key code is a Qt::Key enum.

on_key_release()

virtual bool maquina::ToolPlugin::on_key_release ( int32_t  key, int32_t  modifiers  )

virtual

Called when a key is released while the tool is active.

Returns true if the key event is accepted. The key code is a Qt::Key enum.

on_mouse_move()

virtual void maquina::ToolPlugin::on_mouse_move ( const CameraContext &  camera, const InteractionContext &  interaction  )

virtual

Reimplemented in maquina::BrushPlugin.

on_mouse_press()

virtual void maquina::ToolPlugin::on_mouse_press ( const CameraContext &  camera, const InteractionContext &  interaction  )

virtual

Reimplemented in maquina::BrushPlugin.

on_mouse_release()

virtual void maquina::ToolPlugin::on_mouse_release ( const CameraContext &  camera, const InteractionContext &  interaction  )

virtual

Reimplemented in maquina::BrushPlugin.

override_selection()

virtual bool maquina::ToolPlugin::override_selection ( )

virtual

Reimplemented in maquina::BrushPlugin.

track_mouse()

virtual bool maquina::ToolPlugin::track_mouse ( )

virtual

Reimplemented in maquina::BrushPlugin.

---

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

• include/Maquina/ToolPlugin.h