BackgroundStateAbstractBase Class Reference

Background image state machine state base class. More...

#include <BackgroundStateAbstractBase.h>

Inheritance diagram for BackgroundStateAbstractBase:

Collaboration diagram for BackgroundStateAbstractBase:

Public Member Functions
	BackgroundStateAbstractBase (BackgroundStateContext &context, GraphicsScene &scene)
	Single constructor. More...
virtual	~BackgroundStateAbstractBase ()
virtual void	begin ()=0
	Method that is called at the exact moment a state is entered. Typically called just after end for the previous state. More...
BackgroundStateContext &	context ()
	Reference to the BackgroundStateContext that contains all the BackgroundStateAbstractBase subclasses, without const. More...
const BackgroundStateContext &	context () const
	Reference to the BackgroundStateContext that contains all the BackgroundStateAbstractBase subclasses, without const. More...
virtual void	end ()=0
	Method that is called at the exact moment a state is exited. Typically called just before begin for the next state. More...
virtual void	fitInView (GraphicsView &view)=0
	Zoom so background fills the window. More...
QImage	image () const
	Image for the current state. More...
QGraphicsPixmapItem &	imageItem () const
	Graphics image item for the current state. More...
GraphicsScene &	scene ()
	Reference to the GraphicsScene, without const. More...
const GraphicsScene &	scene () const
	Reference to the GraphicsScene, without const. More...
virtual void	setCurveSelected (bool isGnuplot, const Transformation &transformation, const DocumentModelGridRemoval &modelGridRemoval, const DocumentModelColorFilter &colorFilter, const QString &curveSelected)=0
	Update the currently selected curve name. More...
virtual void	setPixmap (bool isGnuplot, const Transformation &transformation, const DocumentModelGridRemoval &modelGridRemoval, const DocumentModelColorFilter &modelColorFilter, const QPixmap &pixmap, const QString &curveSelected)=0
	Update the image for this state, after the leaf class processes it appropriately. More...
virtual QString	state () const =0
	State name for debugging. More...
virtual void	updateColorFilter (bool isGnuplot, const Transformation &transformation, const DocumentModelGridRemoval &modelGridRemoval, const DocumentModelColorFilter &modelColorFilter, const QString &curveSelected)=0
	Apply color filter settings. More...

Protected Member Functions
void	setImageVisible (bool visible)
	Show/hide background image. More...
void	setProcessedPixmap (const QPixmap &pixmap)
	Save the image for this state after it has been processed by the leaf class. More...

Detailed Description

Background image state machine state base class.

Definition at line 30 of file BackgroundStateAbstractBase.h.

Constructor & Destructor Documentation

BackgroundStateAbstractBase()

BackgroundStateAbstractBase::BackgroundStateAbstractBase	(	BackgroundStateContext &	context,
		GraphicsScene &	scene
	)

Single constructor.

Definition at line 15 of file BackgroundStateAbstractBase.cpp.

                                                                               :
  m_context (context),
  m_scene (scene),
  m_imageItem (nullptr)
{
  // Create an image but do not show it until the appropriate state is reached
  QPixmap dummy;
  m_imageItem = m_scene.addPixmap (dummy);
  m_imageItem->setVisible (false);
  m_imageItem->setZValue (Z_VALUE_BACKGROUND);
  m_imageItem->setData (DATA_KEY_IDENTIFIER, "view");
  m_imageItem->setData (DATA_KEY_GRAPHICS_ITEM_TYPE, GRAPHICS_ITEM_TYPE_IMAGE);
}

~BackgroundStateAbstractBase()

BackgroundStateAbstractBase::~BackgroundStateAbstractBase ( )

virtual

Definition at line 30 of file BackgroundStateAbstractBase.cpp.

{
}

Member Function Documentation

begin()

virtual void BackgroundStateAbstractBase::begin ( )

pure virtual

Method that is called at the exact moment a state is entered. Typically called just after end for the previous state.

Implemented in BackgroundStateCurve, BackgroundStateNone, BackgroundStateOriginal, and BackgroundStateUnloaded.

context() [1/2]

BackgroundStateContext & BackgroundStateAbstractBase::context

(

)

Reference to the BackgroundStateContext that contains all the BackgroundStateAbstractBase subclasses, without const.

Definition at line 34 of file BackgroundStateAbstractBase.cpp.

{
  return m_context;
}

context() [2/2]

const BackgroundStateContext & BackgroundStateAbstractBase::context

(

)

const

Reference to the BackgroundStateContext that contains all the BackgroundStateAbstractBase subclasses, without const.

Definition at line 39 of file BackgroundStateAbstractBase.cpp.

{
  return m_context;
}

end()

virtual void BackgroundStateAbstractBase::end ( )

pure virtual

Method that is called at the exact moment a state is exited. Typically called just before begin for the next state.

Implemented in BackgroundStateCurve, BackgroundStateNone, BackgroundStateOriginal, and BackgroundStateUnloaded.

fitInView()

virtual void BackgroundStateAbstractBase::fitInView ( GraphicsView &  view )

pure virtual

Zoom so background fills the window.

Implemented in BackgroundStateCurve, BackgroundStateNone, BackgroundStateOriginal, and BackgroundStateUnloaded.

image()

QImage BackgroundStateAbstractBase::image

(

)

const

Image for the current state.

Definition at line 44 of file BackgroundStateAbstractBase.cpp.

{
  return m_image;
}

imageItem()

QGraphicsPixmapItem & BackgroundStateAbstractBase::imageItem

(

)

const

Graphics image item for the current state.

Definition at line 49 of file BackgroundStateAbstractBase.cpp.

{
  return *m_imageItem;
}

scene() [1/2]

GraphicsScene & BackgroundStateAbstractBase::scene

(

)

Reference to the GraphicsScene, without const.

Definition at line 54 of file BackgroundStateAbstractBase.cpp.

{
  return m_scene;
}

scene() [2/2]

const GraphicsScene & BackgroundStateAbstractBase::scene

(

)

const

Reference to the GraphicsScene, without const.

Definition at line 59 of file BackgroundStateAbstractBase.cpp.

{
  return m_scene;
}

setCurveSelected()

virtual void BackgroundStateAbstractBase::setCurveSelected ( bool  isGnuplot, const Transformation &  transformation, const DocumentModelGridRemoval &  modelGridRemoval, const DocumentModelColorFilter &  colorFilter, const QString &  curveSelected  )

pure virtual

Update the currently selected curve name.

Implemented in BackgroundStateCurve, BackgroundStateNone, BackgroundStateOriginal, and BackgroundStateUnloaded.

setImageVisible()

void BackgroundStateAbstractBase::setImageVisible ( bool  visible )

protected

Show/hide background image.

Definition at line 64 of file BackgroundStateAbstractBase.cpp.

{
  m_imageItem->setVisible (visible);
}

setPixmap()

virtual void BackgroundStateAbstractBase::setPixmap ( bool  isGnuplot, const Transformation &  transformation, const DocumentModelGridRemoval &  modelGridRemoval, const DocumentModelColorFilter &  modelColorFilter, const QPixmap &  pixmap, const QString &  curveSelected  )

pure virtual

Update the image for this state, after the leaf class processes it appropriately.

Implemented in BackgroundStateCurve, BackgroundStateNone, BackgroundStateOriginal, and BackgroundStateUnloaded.

setProcessedPixmap()

void BackgroundStateAbstractBase::setProcessedPixmap ( const QPixmap &  pixmap )

protected

Save the image for this state after it has been processed by the leaf class.

Definition at line 69 of file BackgroundStateAbstractBase.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "BackgroundStateAbstractBase::setProcessedPixmap"
                              << " map=(" << pixmap.width() << "x" << pixmap.height() << ")";

  ENGAUGE_CHECK_PTR(m_imageItem);

  m_imageItem->setPixmap (pixmap);

  // Reset scene rectangle or else small image after large image will be off-center
  m_scene.setSceneRect (m_imageItem->boundingRect ());

  m_image = pixmap.toImage();
}

state()

virtual QString BackgroundStateAbstractBase::state ( ) const

pure virtual

State name for debugging.

Implemented in BackgroundStateCurve, BackgroundStateNone, BackgroundStateOriginal, and BackgroundStateUnloaded.

updateColorFilter()

virtual void BackgroundStateAbstractBase::updateColorFilter ( bool  isGnuplot, const Transformation &  transformation, const DocumentModelGridRemoval &  modelGridRemoval, const DocumentModelColorFilter &  modelColorFilter, const QString &  curveSelected  )

pure virtual

Apply color filter settings.

Implemented in BackgroundStateCurve, BackgroundStateNone, BackgroundStateOriginal, and BackgroundStateUnloaded.

---

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

• Background/BackgroundStateAbstractBase.h
• Background/BackgroundStateAbstractBase.cpp