SOFA API  b3f2f2a4
Open source framework for multi-physics simuation
sofa::gui::common::InciseOperation Class Reference

#include <MouseOperations.h>

Inheritance diagram for sofa::gui::common::InciseOperation:

Protected Attributes

sofa::gui::component::performer::InteractionPerformerstartPerformer
 
int method
 
int snapingBorderValue
 
int snapingValue
 
int cpt
 
bool finishIncision
 
bool keepPoint
 
- Protected Attributes inherited from sofa::gui::common::Operation
PickHandlerpickHandle
 
sofa::component::setting::MouseButtonSetting::SPtr mbsetting
 
MOUSE_BUTTON button
 

Public Member Functions

 InciseOperation ()
 
 ~InciseOperation () override
 
void start () override
 
void execution () override
 This function is called each time the mouse is clicked. More...
 
void end () override
 
void endOperation () override
 This function is called after each mouse click. More...
 
void setIncisionMethod (int m)
 
void setSnapingBorderValue (int m)
 
void setSnapingValue (int m)
 
void setCompleteIncision (bool m)
 
void setKeepPoint (bool m)
 
virtual int getIncisionMethod () const
 
virtual int getSnapingBorderValue () const
 
virtual int getSnapingValue () const
 
virtual bool getCompleteIncision ()
 
virtual bool getKeepPoint ()
 
- Public Member Functions inherited from sofa::gui::common::Operation
 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 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 std::string getDescription ()
 
- Static Public Member Functions inherited from sofa::gui::common::Operation
static MOUSE_BUTTON GetMouseId (unsigned int i)
 

Additional Inherited Members

- Public Attributes inherited from sofa::gui::common::Operation
sofa::gui::component::performer::InteractionPerformerperformer
 

Attribute details

◆ cpt

int sofa::gui::common::InciseOperation::cpt
protected

◆ finishIncision

bool sofa::gui::common::InciseOperation::finishIncision
protected

◆ keepPoint

bool sofa::gui::common::InciseOperation::keepPoint
protected

◆ method

int sofa::gui::common::InciseOperation::method
protected

◆ snapingBorderValue

int sofa::gui::common::InciseOperation::snapingBorderValue
protected

◆ snapingValue

int sofa::gui::common::InciseOperation::snapingValue
protected

◆ startPerformer

sofa::gui::component::performer::InteractionPerformer* sofa::gui::common::InciseOperation::startPerformer
protected

Constructor details

◆ InciseOperation()

sofa::gui::common::InciseOperation::InciseOperation ( )
inline

◆ ~InciseOperation()

sofa::gui::common::InciseOperation::~InciseOperation ( )
override

Function details

◆ end()

void sofa::gui::common::InciseOperation::end ( )
overridevirtual

Reimplemented from sofa::gui::common::Operation.

◆ endOperation()

void sofa::gui::common::InciseOperation::endOperation ( )
overridevirtual

This function is called after each mouse click.

Reimplemented from sofa::gui::common::Operation.

◆ execution()

void sofa::gui::common::InciseOperation::execution ( )
overridevirtual

This function is called each time the mouse is clicked.

Reimplemented from sofa::gui::common::Operation.

◆ getCompleteIncision()

virtual bool sofa::gui::common::InciseOperation::getCompleteIncision ( )
inlinevirtual

◆ getDescription()

static std::string sofa::gui::common::InciseOperation::getDescription ( )
inlinestatic

◆ getIncisionMethod()

virtual int sofa::gui::common::InciseOperation::getIncisionMethod ( ) const
inlinevirtual

◆ getKeepPoint()

virtual bool sofa::gui::common::InciseOperation::getKeepPoint ( )
inlinevirtual

◆ getSnapingBorderValue()

virtual int sofa::gui::common::InciseOperation::getSnapingBorderValue ( ) const
inlinevirtual

◆ getSnapingValue()

virtual int sofa::gui::common::InciseOperation::getSnapingValue ( ) const
inlinevirtual

◆ setCompleteIncision()

void sofa::gui::common::InciseOperation::setCompleteIncision ( bool  m)
inline

◆ setIncisionMethod()

void sofa::gui::common::InciseOperation::setIncisionMethod ( int  m)
inline

◆ setKeepPoint()

void sofa::gui::common::InciseOperation::setKeepPoint ( bool  m)
inline

◆ setSnapingBorderValue()

void sofa::gui::common::InciseOperation::setSnapingBorderValue ( int  m)
inline

◆ setSnapingValue()

void sofa::gui::common::InciseOperation::setSnapingValue ( int  m)
inline

◆ start()

void sofa::gui::common::InciseOperation::start ( )
overridevirtual

Reimplemented from sofa::gui::common::Operation.