SOFA API  1a4bb3e7
Open source framework for multi-physics simuation
sofa::gui::common::Operation Class Reference

#include <MouseOperations.h>

Inheritance diagram for sofa::gui::common::Operation:

Public Attributes

sofa::gui::component::performer::InteractionPerformerperformer
 

Protected Attributes

PickHandlerpickHandle
 
sofa::component::setting::MouseButtonSetting::SPtr mbsetting
 
MOUSE_BUTTON button
 

Public Member Functions

 Operation (sofa::component::setting::MouseButtonSetting::SPtr s=nullptr)
 
virtual ~Operation ()
 
virtual void configure (PickHandler *picker, MOUSE_BUTTON b)
 
virtual void configure (PickHandler *picker, sofa::component::setting::MouseButtonSetting *s)
 
virtual void start ()
 
virtual void execution ()
 This function is called each time the mouse is clicked. More...
 
virtual void end ()
 
virtual void endOperation ()
 This function is called after each mouse click. More...
 
virtual void wait ()
 This function is called when shift key is released. More...
 
virtual void setSetting (sofa::component::setting::MouseButtonSetting *s)
 
virtual std::string defaultPerformerType ()
 
virtual sofa::gui::component::performer::InteractionPerformercreatePerformer ()
 
virtual void configurePerformer (sofa::gui::component::performer::InteractionPerformer *p)
 
MOUSE_BUTTON getMouseButton () const
 
std::string getId ()
 

Static Public Member Functions

static MOUSE_BUTTON GetMouseId (unsigned int i)
 

Friends

class OperationFactory
 

Attribute details

◆ button

MOUSE_BUTTON sofa::gui::common::Operation::button
protected

◆ mbsetting

sofa::component::setting::MouseButtonSetting::SPtr sofa::gui::common::Operation::mbsetting
protected

◆ performer

sofa::gui::component::performer::InteractionPerformer* sofa::gui::common::Operation::performer

◆ pickHandle

PickHandler* sofa::gui::common::Operation::pickHandle
protected

Constructor details

◆ Operation()

sofa::gui::common::Operation::Operation ( sofa::component::setting::MouseButtonSetting::SPtr  s = nullptr)
inline

◆ ~Operation()

virtual sofa::gui::common::Operation::~Operation ( )
inlinevirtual

Function details

◆ configure() [1/2]

virtual void sofa::gui::common::Operation::configure ( PickHandler picker,
MOUSE_BUTTON  b 
)
inlinevirtual

◆ configure() [2/2]

◆ configurePerformer()

◆ createPerformer()

InteractionPerformer * sofa::gui::common::Operation::createPerformer ( )
virtual

◆ defaultPerformerType()

◆ end()

void sofa::gui::common::Operation::end ( )
virtual

◆ endOperation()

virtual void sofa::gui::common::Operation::endOperation ( )
inlinevirtual

This function is called after each mouse click.

Reimplemented in sofa::gui::common::TopologyOperation, and sofa::gui::common::InciseOperation.

◆ execution()

virtual void sofa::gui::common::Operation::execution ( )
inlinevirtual

This function is called each time the mouse is clicked.

Reimplemented in sofa::gui::common::TopologyOperation, and sofa::gui::common::InciseOperation.

◆ getId()

std::string sofa::gui::common::Operation::getId ( )
inline

◆ getMouseButton()

MOUSE_BUTTON sofa::gui::common::Operation::getMouseButton ( ) const
inline

◆ GetMouseId()

static MOUSE_BUTTON sofa::gui::common::Operation::GetMouseId ( unsigned int  i)
inlinestatic

◆ setSetting()

virtual void sofa::gui::common::Operation::setSetting ( sofa::component::setting::MouseButtonSetting s)
inlinevirtual

◆ start()

void sofa::gui::common::Operation::start ( )
virtual

◆ wait()

virtual void sofa::gui::common::Operation::wait ( )
inlinevirtual

This function is called when shift key is released.

Related details

◆ OperationFactory

friend class OperationFactory
friend