[an error occurred while processing this directive]

AppBase::Command< StringType > Class Template Reference

Base class for all panorama commands. More...

#include <Command.h>

Inheritance diagram for AppBase::Command< StringType >:

[legend]List of all members.

Public Member Functions
	Command ()
	Command (const StringType &commandName)
virtual	~Command ()
virtual void	execute ()=0
	execute the command.
virtual void	undo ()=0
	undo execute() [pure virtual]
virtual void	redo ()
	redo execute() [pure virtual]
virtual StringType	getName () const
virtual void	setName (const StringType &newName)
virtual bool	wasSuccessful ()
Protected Member Functions
virtual void	setSuccessful (bool success=true)

---

Detailed Description

template<class StringType = std::string>
class AppBase::Command< StringType >

Base class for all panorama commands.

see command pattern.

---

Constructor & Destructor Documentation

template<class StringType = std::string> AppBase::Command< StringType >::Command (   )  [inline]

template<class StringType = std::string> AppBase::Command< StringType >::Command (  const StringType &  commandName  )  [inline]

template<class StringType = std::string> virtual AppBase::Command< StringType >::~Command (   )  [inline, virtual]

---

Member Function Documentation

template<class StringType = std::string> virtual void AppBase::Command< StringType >::execute (   )  [pure virtual]

execute the command. [pure virtual] should save information for undo(). Implemented in PT::wxAddImagesCmd, PT::wxLoadPTProjectCmd, PT::wxApplyTemplateCmd, PT::wxAddCtrlPointGridCmd, HuginBase::PanoCommand< StringType >, and HuginBase::PanoCommand< std::string >.

template<class StringType = std::string> virtual StringType AppBase::Command< StringType >::getName (   )  const [inline, virtual]

Reimplemented in PT::wxAddImagesCmd, PT::wxLoadPTProjectCmd, PT::wxApplyTemplateCmd, PT::wxAddCtrlPointGridCmd, PT::NewPanoCmd, PT::AddImagesCmd, PT::RemoveImageCmd, PT::RemoveImagesCmd, PT::UpdateVariablesCmd, PT::UpdateCPsCmd, PT::UpdateVariablesCPCmd, PT::UpdateVariablesCPSetCmd, PT::UpdateImageVariablesCmd, PT::UpdateImagesVariablesCmd, PT::UpdateOptimizeVectorCmd, PT::SetVariableCmd, PT::CenterPanoCmd, PT::StraightenPanoCmd, PT::AddCtrlPointCmd, PT::AddCtrlPointsCmd, PT::RemoveCtrlPointCmd, PT::RemoveCtrlPointsCmd, PT::ChangeCtrlPointCmd, PT::SetActiveImagesCmd, PT::SwapImagesCmd, PT::MergePanoCmd, PT::SetImageOptionsCmd, PT::UpdateSrcImageCmd, PT::UpdateSrcImagesCmd, PT::UpdateImageOptionsCmd, PT::SetPanoOptionsCmd, PT::LoadPTProjectCmd, PT::SetVigCorrCmd, PT::RotatePanoCmd, PT::UpdateFocalLengthCmd, PT::UpdateCropFactorCmd, PT::ChangePartNumberCmd, PT::ChangePartImagesLinkingCmd, PT::LinkLensVarsCmd, PT::NewPartCmd, and PT::UpdateMaskForImgCmd.

template<class StringType = std::string> virtual void AppBase::Command< StringType >::redo (   )  [inline, virtual]

redo execute() [pure virtual] for special optimisation; the default implementation calls execute(); Reimplemented in HuginBase::PanoCommand< StringType >, and HuginBase::PanoCommand< std::string >.

template<class StringType = std::string> virtual void AppBase::Command< StringType >::setName (  const StringType &  newName  )  [inline, virtual]

template<class StringType = std::string> virtual void AppBase::Command< StringType >::setSuccessful (  bool  success = true  )  [inline, protected, virtual]

template<class StringType = std::string> virtual void AppBase::Command< StringType >::undo (   )  [pure virtual]

undo execute() [pure virtual] must restore the model to the state before execute(). execute() may be called later to redo the undo. Implemented in HuginBase::PanoCommand< StringType >, and HuginBase::PanoCommand< std::string >.

template<class StringType = std::string> virtual bool AppBase::Command< StringType >::wasSuccessful (   )  [inline, virtual]

---

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

• hugin_base/appbase/Command.h

---