CentipedeStateContext Class Reference

State context class for tracking the steps involved in creating centipedes in preparation for creating a guideline. More...

#include <CentipedeStateContext.h>

Collaboration diagram for CentipedeStateContext:

Public Member Functions
	CentipedeStateContext (DigitizeStateGuideline &stateGuideline)
	Single constructor.
virtual	~CentipedeStateContext ()
void	createGuidelineCommand (bool selectedXTFinal, double valueFinal)
	Create a command for creating a Guideline.
GraphicsScene *	graphicsScene () const
	Get method for forwarded GraphicsScene.
virtual void	handleKeyPress (Qt::Key key, bool atLeastOneSelectedItem)
virtual void	handleMouseMove (QPointF posScreen)
virtual void	handleMousePress (GraphicsScene *scene, const Transformation &transformation, const DocumentModelGuideline &modelGuideline, const DocumentModelCoords &modelCoords, QPointF posScreen, bool clickedOnItem)
virtual void	handleMouseRelease (QPointF posScreen)
DocumentModelCoords	modelCoords () const
	Get method for forwarded DocumentModelCoords.
DocumentModelGuideline	modelGuideline () const
	Get method for forwarded DocumentModelGuideline.
QPointF	posClickScreen () const
	Get method for forwarded click point.
void	requestDelayedStateTransition (CentipedeState centipedeState)
	Initiate state transition to be performed later, when CentipedeState is off the stack.
void	requestImmediateStateTransition (CentipedeState centipedeState)
	Perform immediate state transition for immediate action. Called when states are off the stack.
GraphicsScene &	scene () const
	Get method for forwarded GraphicsScene.
Transformation	transformation () const
	Get method for forwarded Transformation.

Detailed Description

State context class for tracking the steps involved in creating centipedes in preparation for creating a guideline.

Definition at line 25 of file CentipedeStateContext.h.

Constructor & Destructor Documentation

CentipedeStateContext()

CentipedeStateContext::CentipedeStateContext

(

DigitizeStateGuideline &

stateGuideline

)

Single constructor.

Definition at line 22 of file CentipedeStateContext.cpp.

                                                                                    :
  m_stateGuideline (stateGuideline),
  m_scene (nullptr),
  m_transformation (nullptr)
{
  // These states follow the same order as the CentipedeState enumeration
  m_states.insert (CENTIPEDE_STATE_BUILD_CARTESIAN, new CentipedeStateBuildCartesian (*this));
  m_states.insert (CENTIPEDE_STATE_BUILD_POLAR    , new CentipedeStateBuildPolar     (*this));
  m_states.insert (CENTIPEDE_STATE_PREBUILD       , new CentipedeStatePrebuild       (*this));
  ENGAUGE_ASSERT (m_states.size () == NUM_CENTIPEDE_STATES);
 
  m_currentState = NUM_CENTIPEDE_STATES; // Value that forces a transition right away
  requestImmediateStateTransition (CENTIPEDE_STATE_PREBUILD);
}

~CentipedeStateContext()

CentipedeStateContext::~CentipedeStateContext ( )

virtual

Definition at line 37 of file CentipedeStateContext.cpp.

{
  // Remove states, one of which may have incomplete in-work graphics items
  QVector<CentipedeStateAbstractBase*>::iterator itr;
  for (itr = m_states.begin (); itr != m_states.end (); itr++) {
    CentipedeStateAbstractBase *state = *itr;
    delete state;
  }
 
  m_states.clear();
 
  delete m_scene;
  delete m_transformation;
}

Member Function Documentation

createGuidelineCommand()

void CentipedeStateContext::createGuidelineCommand	(	bool	selectedXTFinal,
		double	valueFinal )

Create a command for creating a Guideline.

Definition at line 70 of file CentipedeStateContext.cpp.

{
  m_stateGuideline.createGuidelineCommand (selectedXT,
                                           selectedValue);
}

graphicsScene()

GraphicsScene * CentipedeStateContext::graphicsScene

(

)

const

Get method for forwarded GraphicsScene.

handleKeyPress()

void CentipedeStateContext::handleKeyPress ( Qt::Key key, bool atLeastOneSelectedItem )

virtual

Definition at line 77 of file CentipedeStateContext.cpp.

{
  m_states [m_currentState]->handleKeyPress (key,
                                             atLeastOneSelectedItem);
 
  completeRequestedStateTransitionIfExists();
 
}

handleMouseMove()

void CentipedeStateContext::handleMouseMove ( QPointF posScreen )

virtual

Definition at line 87 of file CentipedeStateContext.cpp.

{
  m_states [m_currentState]->handleMouseMove (pos);
 
  completeRequestedStateTransitionIfExists();
 
}

handleMousePress()

void CentipedeStateContext::handleMousePress ( GraphicsScene * scene, const Transformation & transformation, const DocumentModelGuideline & modelGuideline, const DocumentModelCoords & modelCoords, QPointF posScreen, bool clickedOnItem )

virtual

Definition at line 95 of file CentipedeStateContext.cpp.

{
  // If a graphics item can be, or was, selected then do not create a new CentipedePair (by
  // skipping the state transition
  if (!clickedOnItem) {
 
    // Forward context variables
    m_scene = scene;
    m_transformation = new Transformation (transformation);
    m_modelGuideline = modelGuideline;
    m_modelCoords = modelCoords;
    m_posClickScreen = pos;
  
    m_states [m_currentState]->handleMousePress (pos);
 
    completeRequestedStateTransitionIfExists();
  }
}

handleMouseRelease()

void CentipedeStateContext::handleMouseRelease ( QPointF posScreen )

virtual

Definition at line 119 of file CentipedeStateContext.cpp.

{
  m_states [m_currentState]->handleMouseRelease (pos);
 
  completeRequestedStateTransitionIfExists();
}

modelCoords()

DocumentModelCoords CentipedeStateContext::modelCoords

(

)

const

Get method for forwarded DocumentModelCoords.

Definition at line 126 of file CentipedeStateContext.cpp.

{
  return m_modelCoords;
}

modelGuideline()

DocumentModelGuideline CentipedeStateContext::modelGuideline

(

)

const

Get method for forwarded DocumentModelGuideline.

Definition at line 131 of file CentipedeStateContext.cpp.

{
  return m_modelGuideline;
}

posClickScreen()

QPointF CentipedeStateContext::posClickScreen

(

)

const

Get method for forwarded click point.

Definition at line 136 of file CentipedeStateContext.cpp.

{
  return m_posClickScreen;
}

requestDelayedStateTransition()

void CentipedeStateContext::requestDelayedStateTransition

(

CentipedeState

centipedeState

)

Initiate state transition to be performed later, when CentipedeState is off the stack.

Definition at line 141 of file CentipedeStateContext.cpp.

{
  m_requestedState = centipedeState;
}

requestImmediateStateTransition()

void CentipedeStateContext::requestImmediateStateTransition

(

CentipedeState

centipedeState

)

Perform immediate state transition for immediate action. Called when states are off the stack.

Definition at line 146 of file CentipedeStateContext.cpp.

{
  m_requestedState = centipedeState;
  completeRequestedStateTransitionIfExists();
}

scene()

GraphicsScene & CentipedeStateContext::scene

(

)

const

Get method for forwarded GraphicsScene.

Definition at line 152 of file CentipedeStateContext.cpp.

{
  return *m_scene;
}

transformation()

Transformation CentipedeStateContext::transformation

(

)

const

Get method for forwarded Transformation.

Definition at line 157 of file CentipedeStateContext.cpp.

{
  return *m_transformation;
}

---

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

• Centipede/CentipedeStateContext.h
• Centipede/CentipedeStateContext.cpp