PanoCommand::PanoCommand Class Reference

Base class for all panorama commands. More...

#include <Command.h>

Inheritance diagram for PanoCommand::PanoCommand:

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 () const
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::Panorama &	m_pano
	internal variables
HuginBase::PanoramaDataMemento *	m_memento
HuginBase::PanoramaDataMemento *	m_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() [1/2]

PanoCommand::PanoCommand::PanoCommand ( HuginBase::Panorama &  pano )

inlineexplicit

constructor

Definition at line 42 of file Command.h.

PanoCommand() [2/2]

PanoCommand::PanoCommand::PanoCommand ( HuginBase::Panorama &  pano, const std::string &  commandName  )

inline

Definition at line 45 of file Command.h.

~PanoCommand()

PanoCommand::PanoCommand::~PanoCommand ( )

virtual

destructor

Definition at line 29 of file Command.cpp.

References threshold().

Member Function Documentation

execute()

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.

Definition at line 41 of file Command.cpp.

References threshold().

getName()

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::NewPartCmd, PanoCommand::UpdateMaskForImgCmd, PanoCommand::UpdateWhiteBalance, PanoCommand::ResetToMeanExposure, PanoCommand::DistributeImagesCmd, PanoCommand::wxAddImagesCmd, PanoCommand::wxLoadPTProjectCmd, PanoCommand::wxNewProjectCmd, PanoCommand::wxApplyTemplateCmd, and PanoCommand::wxAddCtrlPointGridCmd.

Definition at line 83 of file Command.cpp.

processPanorama()

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::NewPartCmd, PanoCommand::UpdateMaskForImgCmd, PanoCommand::UpdateWhiteBalance, PanoCommand::ResetToMeanExposure, PanoCommand::DistributeImagesCmd, PanoCommand::wxAddImagesCmd, PanoCommand::wxLoadPTProjectCmd, PanoCommand::wxNewProjectCmd, PanoCommand::wxApplyTemplateCmd, and PanoCommand::wxAddCtrlPointGridCmd.

Definition at line 121 of file Command.cpp.

redo()

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.

Definition at line 70 of file Command.cpp.

References threshold().

saveMemento()

void PanoCommand::PanoCommand::saveMemento ( )

protectedvirtual

saves the state for undo

Definition at line 103 of file Command.cpp.

References threshold().

saveRedoMemento()

void PanoCommand::PanoCommand::saveRedoMemento ( )

protectedvirtual

saves the state for redo

Definition at line 112 of file Command.cpp.

References threshold().

setName()

void PanoCommand::PanoCommand::setName ( const std::string &  newName )

virtual

sets the name for the command

Definition at line 88 of file Command.cpp.

References threshold().

Referenced by RawImportDialog::OnOk().

setSuccessful()

void PanoCommand::PanoCommand::setSuccessful ( bool  success = true )

protectedvirtual

Definition at line 98 of file Command.cpp.

References threshold().

undo()

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.

Definition at line 62 of file Command.cpp.

References DEBUG_ASSERT, and threshold().

wasSuccessful()

bool PanoCommand::PanoCommand::wasSuccessful ( ) const

virtual

Definition at line 93 of file Command.cpp.

Member Data Documentation

m_clearDirty

bool PanoCommand::PanoCommand::m_clearDirty

protected

Definition at line 100 of file Command.h.

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

m_memento

HuginBase::PanoramaDataMemento* PanoCommand::PanoCommand::m_memento

protected

Definition at line 96 of file Command.h.

m_name

std::string PanoCommand::PanoCommand::m_name

private

Definition at line 103 of file Command.h.

m_pano

HuginBase::Panorama& PanoCommand::PanoCommand::m_pano

protected

internal variables

Definition at line 95 of file Command.h.

m_redoMemento

HuginBase::PanoramaDataMemento* PanoCommand::PanoCommand::m_redoMemento

protected

Definition at line 97 of file Command.h.

m_successful

bool PanoCommand::PanoCommand::m_successful

private

Definition at line 102 of file Command.h.

---

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

• hugin1/base_wx/Command.h
• hugin1/base_wx/Command.cpp