PanoCommand::PanoCommand Class Reference

Base class for all panorama commands. More...

#include <Command.h>

Inheritance diagram for PanoCommand::PanoCommand:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 PanoCommand (HuginBase::Panorama &pano)
 constructor
 PanoCommand (HuginBase::Panorama &pano, const std::string &commandName)
virtual ~PanoCommand ()
 destructor
virtual void execute ()
 execute the command.
virtual void undo ()
 undo execute() [virtual]
virtual void redo ()
 redo execute() [virtual]
virtual std::string getName () const
 returns the name of the command
virtual void setName (const std::string &newName)
 sets the name for the command
virtual bool wasSuccessful ()
virtual bool processPanorama (HuginBase::Panorama &pano)
 Called by execute().

Protected Member Functions

virtual void setSuccessful (bool success=true)
virtual void saveMemento ()
 saves the state for undo
virtual void saveRedoMemento ()
 saves the state for redo

Protected Attributes

HuginBase::Panoramam_pano
 internal variables
HuginBase::PanoramaDataMementom_memento
HuginBase::PanoramaDataMementom_redoMemento
bool m_clearDirty

Private Attributes

bool m_successful
std::string m_name

Detailed Description

Base class for all panorama commands.

see command pattern.

Definition at line 38 of file Command.h.


Constructor & Destructor Documentation

PanoCommand::PanoCommand::PanoCommand ( HuginBase::Panorama pano  )  [inline, explicit]

constructor

Definition at line 42 of file Command.h.

PanoCommand::PanoCommand::PanoCommand ( HuginBase::Panorama pano,
const std::string commandName 
) [inline]

Definition at line 45 of file Command.h.

virtual PanoCommand::PanoCommand::~PanoCommand (  )  [virtual]

destructor


Member Function Documentation

virtual void PanoCommand::PanoCommand::execute (  )  [virtual]

execute the command.

[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.

virtual std::string PanoCommand::PanoCommand::getName (  )  const [virtual]

returns the name of the command

Reimplemented in PanoCommand::NewPanoCmd, PanoCommand::AddImagesCmd, PanoCommand::RemoveImageCmd, PanoCommand::RemoveImagesCmd, PanoCommand::UpdateVariablesCmd, PanoCommand::UpdateCPsCmd, PanoCommand::UpdateVariablesCPCmd, PanoCommand::UpdateVariablesCPSetCmd, PanoCommand::UpdateImageVariablesCmd, PanoCommand::UpdateImagesVariablesCmd, PanoCommand::UpdateVariablesByParseExpression, PanoCommand::UpdateOptimizeVectorCmd, PanoCommand::UpdateOptimizerSwitchCmd, PanoCommand::UpdatePhotometricOptimizerSwitchCmd, PanoCommand::SetVariableCmd, PanoCommand::CenterPanoCmd, PanoCommand::StraightenPanoCmd, PanoCommand::AddCtrlPointCmd, PanoCommand::AddCtrlPointsCmd, PanoCommand::RemoveCtrlPointCmd, PanoCommand::RemoveCtrlPointsCmd, PanoCommand::ChangeCtrlPointCmd, PanoCommand::SetActiveImagesCmd, PanoCommand::SwapImagesCmd, PanoCommand::MoveImageCmd, PanoCommand::MergePanoCmd, PanoCommand::UpdateSrcImageCmd, PanoCommand::UpdateSrcImagesCmd, PanoCommand::SetPanoOptionsCmd, PanoCommand::LoadPTProjectCmd, PanoCommand::RotatePanoCmd, PanoCommand::TranslatePanoCmd, PanoCommand::UpdateFocalLengthCmd, PanoCommand::UpdateCropFactorCmd, PanoCommand::ChangePartNumberCmd, PanoCommand::ChangePartImagesLinkingCmd, PanoCommand::LinkLensVarsCmd, PanoCommand::ChangeImageFilenameCmd, PanoCommand::ChangeImageSizeCmd, PanoCommand::ChangeImageProjectionCmd, PanoCommand::ChangeImageHFOVCmd, PanoCommand::ChangeImageCropFactorCmd, PanoCommand::ChangeImageResponseTypeCmd, PanoCommand::ChangeImageEMoRParamsCmd, PanoCommand::ChangeImageExposureValueCmd, PanoCommand::ChangeImageGammaCmd, PanoCommand::ChangeImageWhiteBalanceRedCmd, PanoCommand::ChangeImageWhiteBalanceBlueCmd, PanoCommand::ChangeImageRollCmd, PanoCommand::ChangeImagePitchCmd, PanoCommand::ChangeImageYawCmd, PanoCommand::ChangeImageXCmd, PanoCommand::ChangeImageYCmd, PanoCommand::ChangeImageZCmd, PanoCommand::ChangeImageTranslationPlaneYawCmd, PanoCommand::ChangeImageTranslationPlanePitchCmd, PanoCommand::ChangeImageStackCmd, PanoCommand::ChangeImageRadialDistortionCmd, PanoCommand::ChangeImageRadialDistortionRedCmd, PanoCommand::ChangeImageRadialDistortionBlueCmd, PanoCommand::ChangeImageRadialDistortionCenterShiftCmd, PanoCommand::ChangeImageShearCmd, PanoCommand::ChangeImageCropModeCmd, PanoCommand::ChangeImageCropRectCmd, PanoCommand::ChangeImageAutoCenterCropCmd, PanoCommand::ChangeImageVigCorrModeCmd, PanoCommand::ChangeImageFlatfieldFilenameCmd, PanoCommand::ChangeImageRadialVigCorrCoeffCmd, PanoCommand::ChangeImageRadialVigCorrCenterShiftCmd, PanoCommand::ChangeImageExifModelCmd, PanoCommand::ChangeImageExifMakeCmd, PanoCommand::ChangeImageExifLensCmd, PanoCommand::ChangeImageExifFocalLengthCmd, PanoCommand::ChangeImageExifOrientationCmd, PanoCommand::ChangeImageExifApertureCmd, PanoCommand::ChangeImageExifISOCmd, PanoCommand::ChangeImageExifDistanceCmd, PanoCommand::ChangeImageExifFocalLength35Cmd, PanoCommand::ChangeImageExifCropFactorCmd, PanoCommand::ChangeImageExifExposureTimeCmd, PanoCommand::ChangeImageExifDateCmd, PanoCommand::ChangeImageExifExposureModeCmd, PanoCommand::ChangeImageExifRedBalanceCmd, PanoCommand::ChangeImageExifBlueBalanceCmd, PanoCommand::ChangeImageFileMetadataCmd, PanoCommand::ChangeImageMasksCmd, PanoCommand::ChangeImageActiveMasksCmd, PanoCommand::ChangeImageActiveCmd, PanoCommand::NewPartCmd, PanoCommand::UpdateMaskForImgCmd, PanoCommand::UpdateWhiteBalance, PanoCommand::ResetToMeanExposure, PanoCommand::DistributeImagesCmd, PanoCommand::wxAddImagesCmd, PanoCommand::wxLoadPTProjectCmd, PanoCommand::wxNewProjectCmd, PanoCommand::wxApplyTemplateCmd, and PanoCommand::wxAddCtrlPointGridCmd.

virtual bool PanoCommand::PanoCommand::processPanorama ( HuginBase::Panorama pano  )  [virtual]

Called by execute().

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

Reimplemented in PanoCommand::CombinedPanoCommand, PanoCommand::NewPanoCmd, PanoCommand::AddImagesCmd, PanoCommand::RemoveImageCmd, PanoCommand::RemoveImagesCmd, PanoCommand::UpdateVariablesCmd, PanoCommand::UpdateCPsCmd, PanoCommand::UpdateVariablesCPCmd, PanoCommand::UpdateVariablesCPSetCmd, PanoCommand::UpdateImageVariablesCmd, PanoCommand::UpdateImagesVariablesCmd, PanoCommand::UpdateVariablesByParseExpression, PanoCommand::UpdateOptimizeVectorCmd, PanoCommand::UpdateOptimizerSwitchCmd, PanoCommand::UpdatePhotometricOptimizerSwitchCmd, PanoCommand::SetVariableCmd, PanoCommand::CenterPanoCmd, PanoCommand::StraightenPanoCmd, PanoCommand::AddCtrlPointCmd, PanoCommand::AddCtrlPointsCmd, PanoCommand::RemoveCtrlPointCmd, PanoCommand::RemoveCtrlPointsCmd, PanoCommand::ChangeCtrlPointCmd, PanoCommand::SetActiveImagesCmd, PanoCommand::SwapImagesCmd, PanoCommand::MoveImageCmd, PanoCommand::MergePanoCmd, PanoCommand::UpdateSrcImageCmd, PanoCommand::UpdateSrcImagesCmd, PanoCommand::SetPanoOptionsCmd, PanoCommand::LoadPTProjectCmd, PanoCommand::RotatePanoCmd, PanoCommand::TranslatePanoCmd, PanoCommand::UpdateFocalLengthCmd, PanoCommand::UpdateCropFactorCmd, PanoCommand::ChangePartNumberCmd, PanoCommand::ChangePartImagesLinkingCmd, PanoCommand::LinkLensVarsCmd, PanoCommand::ChangeImageFilenameCmd, PanoCommand::ChangeImageSizeCmd, PanoCommand::ChangeImageProjectionCmd, PanoCommand::ChangeImageHFOVCmd, PanoCommand::ChangeImageCropFactorCmd, PanoCommand::ChangeImageResponseTypeCmd, PanoCommand::ChangeImageEMoRParamsCmd, PanoCommand::ChangeImageExposureValueCmd, PanoCommand::ChangeImageGammaCmd, PanoCommand::ChangeImageWhiteBalanceRedCmd, PanoCommand::ChangeImageWhiteBalanceBlueCmd, PanoCommand::ChangeImageRollCmd, PanoCommand::ChangeImagePitchCmd, PanoCommand::ChangeImageYawCmd, PanoCommand::ChangeImageXCmd, PanoCommand::ChangeImageYCmd, PanoCommand::ChangeImageZCmd, PanoCommand::ChangeImageTranslationPlaneYawCmd, PanoCommand::ChangeImageTranslationPlanePitchCmd, PanoCommand::ChangeImageStackCmd, PanoCommand::ChangeImageRadialDistortionCmd, PanoCommand::ChangeImageRadialDistortionRedCmd, PanoCommand::ChangeImageRadialDistortionBlueCmd, PanoCommand::ChangeImageRadialDistortionCenterShiftCmd, PanoCommand::ChangeImageShearCmd, PanoCommand::ChangeImageCropModeCmd, PanoCommand::ChangeImageCropRectCmd, PanoCommand::ChangeImageAutoCenterCropCmd, PanoCommand::ChangeImageVigCorrModeCmd, PanoCommand::ChangeImageFlatfieldFilenameCmd, PanoCommand::ChangeImageRadialVigCorrCoeffCmd, PanoCommand::ChangeImageRadialVigCorrCenterShiftCmd, PanoCommand::ChangeImageExifModelCmd, PanoCommand::ChangeImageExifMakeCmd, PanoCommand::ChangeImageExifLensCmd, PanoCommand::ChangeImageExifFocalLengthCmd, PanoCommand::ChangeImageExifOrientationCmd, PanoCommand::ChangeImageExifApertureCmd, PanoCommand::ChangeImageExifISOCmd, PanoCommand::ChangeImageExifDistanceCmd, PanoCommand::ChangeImageExifFocalLength35Cmd, PanoCommand::ChangeImageExifCropFactorCmd, PanoCommand::ChangeImageExifExposureTimeCmd, PanoCommand::ChangeImageExifDateCmd, PanoCommand::ChangeImageExifExposureModeCmd, PanoCommand::ChangeImageExifRedBalanceCmd, PanoCommand::ChangeImageExifBlueBalanceCmd, PanoCommand::ChangeImageFileMetadataCmd, PanoCommand::ChangeImageMasksCmd, PanoCommand::ChangeImageActiveMasksCmd, PanoCommand::ChangeImageActiveCmd, PanoCommand::NewPartCmd, PanoCommand::UpdateMaskForImgCmd, PanoCommand::UpdateWhiteBalance, PanoCommand::ResetToMeanExposure, PanoCommand::DistributeImagesCmd, PanoCommand::wxAddImagesCmd, PanoCommand::wxLoadPTProjectCmd, PanoCommand::wxNewProjectCmd, PanoCommand::wxApplyTemplateCmd, and PanoCommand::wxAddCtrlPointGridCmd.

virtual void PanoCommand::PanoCommand::redo (  )  [virtual]

redo execute() [virtual]

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

virtual void PanoCommand::PanoCommand::saveMemento (  )  [protected, virtual]

saves the state for undo

virtual void PanoCommand::PanoCommand::saveRedoMemento (  )  [protected, virtual]

saves the state for redo

virtual void PanoCommand::PanoCommand::setName ( const std::string newName  )  [virtual]

sets the name for the command

Referenced by GLPreviewFrame::OnLoadImages().

virtual void PanoCommand::PanoCommand::setSuccessful ( bool  success = true  )  [protected, virtual]

virtual void PanoCommand::PanoCommand::undo (  )  [virtual]

undo execute() [virtual]

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

virtual bool PanoCommand::PanoCommand::wasSuccessful (  )  [virtual]


Member Data Documentation

bool PanoCommand::PanoCommand::m_clearDirty [protected]

Definition at line 100 of file Command.h.

Referenced by PanoCommand::LoadPTProjectCmd::LoadPTProjectCmd().

HuginBase::PanoramaDataMemento* PanoCommand::PanoCommand::m_memento [protected]

Definition at line 96 of file Command.h.

std::string PanoCommand::PanoCommand::m_name [private]

Definition at line 103 of file Command.h.

HuginBase::Panorama& PanoCommand::PanoCommand::m_pano [protected]

internal variables

Definition at line 95 of file Command.h.

HuginBase::PanoramaDataMemento* PanoCommand::PanoCommand::m_redoMemento [protected]

Definition at line 97 of file Command.h.

bool PanoCommand::PanoCommand::m_successful [private]

Definition at line 102 of file Command.h.


The documentation for this class was generated from the following file:
Generated on 26 Apr 2018 for Hugintrunk by  doxygen 1.4.7