HuginBase::PanoCommand< StringType > Class Template Reference

Default panorama cmd, provides undo with mementos. More...

#include <PanoCommand.h>

Inheritance diagram for HuginBase::PanoCommand< StringType >:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 PanoCommand (ManagedPanoramaData &panoData)
 PanoCommand (ManagedPanoramaData &panoData, const StringType &commandName)
virtual ~PanoCommand ()
virtual void execute ()
 Processes the panorama and saves the stateThe default implementation calls processPanorama() and saveMemento().
virtual void undo ()
 undoes from saved state
virtual void redo ()
 redoes from saved state

Protected Member Functions

virtual void saveMemento ()
 saves the state for undo
virtual void saveRedoMemento ()
 saves the state for redo
virtual bool processPanorama (ManagedPanoramaData &panoramaData)
 Called by execute().

Protected Attributes

ManagedPanoramaDatapano
PanoramaDataMementomemento
PanoramaDataMementoredoMemento
bool m_clearDirty

Detailed Description

template<typename StringType = std::string>
class HuginBase::PanoCommand< StringType >

Default panorama cmd, provides undo with mementos.

Definition at line 38 of file PanoCommand.h.


Constructor & Destructor Documentation

template<typename StringType = std::string>
HuginBase::PanoCommand< StringType >::PanoCommand ManagedPanoramaData panoData  )  [inline]
 

Definition at line 43 of file PanoCommand.h.

template<typename StringType = std::string>
HuginBase::PanoCommand< StringType >::PanoCommand ManagedPanoramaData panoData,
const StringType &  commandName
[inline]
 

Definition at line 48 of file PanoCommand.h.

template<typename StringType = std::string>
virtual HuginBase::PanoCommand< StringType >::~PanoCommand  )  [inline, virtual]
 

Reimplemented in PT::PanoCommand.

Definition at line 53 of file PanoCommand.h.


Member Function Documentation

template<typename StringType = std::string>
virtual void HuginBase::PanoCommand< StringType >::execute  )  [inline, virtual]
 

Processes the panorama and saves the stateThe default implementation calls processPanorama() and saveMemento().

Only override this method when you want to customize the undo behaviour.

Implements AppBase::Command< StringType >.

Definition at line 86 of file PanoCommand.h.

template<typename StringType = std::string>
virtual bool HuginBase::PanoCommand< StringType >::processPanorama ManagedPanoramaData panoramaData  )  [inline, protected, virtual]
 

Called by execute().

The default implementation does nothing and returns true. Should return false when the processing was unsuccessful.

Definition at line 118 of file PanoCommand.h.

template<typename StringType = std::string>
virtual void HuginBase::PanoCommand< StringType >::redo  )  [inline, virtual]
 

redoes from saved state

the derived class must call PanoComand::execute() or saveRedoMemento() in its execute() method to save the state.

Reimplemented from AppBase::Command< StringType >.

Definition at line 144 of file PanoCommand.h.

template<typename StringType = std::string>
virtual void HuginBase::PanoCommand< StringType >::saveMemento  )  [inline, protected, virtual]
 

saves the state for undo

Definition at line 64 of file PanoCommand.h.

template<typename StringType = std::string>
virtual void HuginBase::PanoCommand< StringType >::saveRedoMemento  )  [inline, protected, virtual]
 

saves the state for redo

Definition at line 72 of file PanoCommand.h.

template<typename StringType = std::string>
virtual void HuginBase::PanoCommand< StringType >::undo  )  [inline, virtual]
 

undoes from saved state

the derived class must call PanoComand::execute() or saveMemento() in its execute() method to save the state.

Implements AppBase::Command< StringType >.

Definition at line 131 of file PanoCommand.h.


Member Data Documentation

template<typename StringType = std::string>
bool HuginBase::PanoCommand< StringType >::m_clearDirty [protected]
 

Definition at line 168 of file PanoCommand.h.

template<typename StringType = std::string>
PanoramaDataMemento* HuginBase::PanoCommand< StringType >::memento [protected]
 

Definition at line 162 of file PanoCommand.h.

template<typename StringType = std::string>
ManagedPanoramaData& HuginBase::PanoCommand< StringType >::pano [protected]
 

Definition at line 157 of file PanoCommand.h.

template<typename StringType = std::string>
PanoramaDataMemento* HuginBase::PanoCommand< StringType >::redoMemento [protected]
 

Definition at line 165 of file PanoCommand.h.


The documentation for this class was generated from the following file:
Generated on Tue Sep 23 01:25:55 2014 for Hugintrunk by  doxygen 1.3.9.1