SOFA API  014b24ea
Open source framework for multi-physics simuation
sofa::gui::Operation Class Reference

#include <MouseOperations.h>

Inheritance diagram for sofa::gui::Operation:

Public Attributes

sofa::component::collision::InteractionPerformerperformer
 

Protected Attributes

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

Public Member Functions

 Operation (sofa::component::configurationsetting::MouseButtonSetting::SPtr s=nullptr)
 
virtual ~Operation ()
 
virtual void configure (PickHandler *picker, MOUSE_BUTTON b)
 
virtual void configure (PickHandler *picker, sofa::component::configurationsetting::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::configurationsetting::MouseButtonSetting *s)
 
virtual std::string defaultPerformerType ()
 
virtual sofa::component::collision::InteractionPerformercreatePerformer ()
 
virtual void configurePerformer (sofa::component::collision::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

MOUSE_BUTTON sofa::gui::Operation::button
protected
sofa::component::configurationsetting::MouseButtonSetting::SPtr sofa::gui::Operation::mbsetting
protected
sofa::component::collision::InteractionPerformer* sofa::gui::Operation::performer
PickHandler* sofa::gui::Operation::pickHandle
protected

Constructor details

sofa::gui::Operation::Operation ( sofa::component::configurationsetting::MouseButtonSetting::SPtr  s = nullptr)
inline
virtual sofa::gui::Operation::~Operation ( )
inlinevirtual

Function details

virtual void sofa::gui::Operation::configure ( PickHandler picker,
MOUSE_BUTTON  b 
)
inlinevirtual
sofa::component::collision::InteractionPerformer * sofa::gui::Operation::createPerformer ( )
virtual
void sofa::gui::Operation::end ( )
virtual
virtual void sofa::gui::Operation::endOperation ( )
inlinevirtual

This function is called after each mouse click.

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

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

This function is called each time the mouse is clicked.

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

std::string sofa::gui::Operation::getId ( )
inline
MOUSE_BUTTON sofa::gui::Operation::getMouseButton ( ) const
inline
static MOUSE_BUTTON sofa::gui::Operation::GetMouseId ( unsigned int  i)
inlinestatic
virtual void sofa::gui::Operation::setSetting ( sofa::component::configurationsetting::MouseButtonSetting s)
inlinevirtual

Reimplemented in sofa::gui::AttachOperation.

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

This function is called when shift key is released.

Related details

friend class OperationFactory
friend