Base class for widget action handler. This class is a base class for all image widget action handlers. To implement a new action handler, derive this class and implement the HandleWidget*() methods. Then register an instance of your handler in the ImageWidgetController. More...

#include <otbImageWidgetActionHandler.h>

Inheritance diagram for otb::ImageWidgetActionHandler:

Collaboration diagram for otb::ImageWidgetActionHandler:

List of all members.

Public Types
typedef itk::SmartPointer < const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef ImageWidgetActionHandler	Self
typedef itk::Object	Superclass

Public Member Functions
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual bool	GetIsActive ()
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
virtual bool	HandleWidgetEvent (const std::string &, int)
virtual bool	HandleWidgetMove (const std::string &, int, int)
virtual bool	HandleWidgetResize (const std::string &, int, int)
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	IsActiveOff ()
virtual void	IsActiveOn ()
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
virtual void	SetIsActive (bool _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const

Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	ImageWidgetActionHandler ()
virtual	~ImageWidgetActionHandler ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, itk::Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

Private Member Functions
	ImageWidgetActionHandler (const Self &)
void	operator= (const Self &)

Private Attributes
bool	m_IsActive

Detailed Description

Base class for widget action handler. This class is a base class for all image widget action handlers. To implement a new action handler, derive this class and implement the HandleWidget*() methods. Then register an instance of your handler in the ImageWidgetController.

See also:: ImageWidgetController; ImageWidget

Definition at line 38 of file otbImageWidgetActionHandler.h.

Member Typedef Documentation

typedef itk::SmartPointer<const Self> otb::ImageWidgetActionHandler::ConstPointer

Reimplemented from itk::Object.

Definition at line 46 of file otbImageWidgetActionHandler.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

typedef itk::SmartPointer<Self> otb::ImageWidgetActionHandler::Pointer

Reimplemented from itk::Object.

Definition at line 45 of file otbImageWidgetActionHandler.h.

typedef ImageWidgetActionHandler otb::ImageWidgetActionHandler::Self

Standard class typedefs

Reimplemented from itk::Object.

Definition at line 43 of file otbImageWidgetActionHandler.h.

typedef itk::Object otb::ImageWidgetActionHandler::Superclass

Reimplemented from itk::Object.

Definition at line 44 of file otbImageWidgetActionHandler.h.

Constructor & Destructor Documentation

otb::ImageWidgetActionHandler::ImageWidgetActionHandler ( )

inlineprotected

Constructor

Definition at line 93 of file otbImageWidgetActionHandler.h.

References m_IsActive.

virtual otb::ImageWidgetActionHandler::~ImageWidgetActionHandler ( )

inlineprotectedvirtual

Destructor

Definition at line 95 of file otbImageWidgetActionHandler.h.

otb::ImageWidgetActionHandler::ImageWidgetActionHandler ( const Self & )

private

Member Function Documentation

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::LightObject::BreakOnError ( )

staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

virtual::itk::LightObject::Pointer otb::ImageWidgetActionHandler::CreateAnother ( void ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

Command * itk::Object::GetCommand ( unsigned long tag )

inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

virtual bool otb::ImageWidgetActionHandler::GetIsActive ( )

virtual

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns:: A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

virtual const char* otb::ImageWidgetActionHandler::GetNameOfClass ( ) const

virtual

Runtime information

Reimplemented from itk::Object.

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

virtual bool otb::ImageWidgetActionHandler::HandleWidgetEvent	(	const std::string &	,
		int
	)

inlinevirtual

Handle widget event

Parameters:

widgetId	The id of the moved widget
event	The event

Returns:: true if the event is handled

Definition at line 59 of file otbImageWidgetActionHandler.h.

Referenced by otb::ImageWidgetController::HandleWidgetEvent().

virtual bool otb::ImageWidgetActionHandler::HandleWidgetMove	(	const std::string &	,
		int	,
		int
	)

inlinevirtual

Handle widget move

Parameters:

widgetId	The id of the moved widget
x	new x location
y	new y location

Returns:: true if the event is handled

Definition at line 70 of file otbImageWidgetActionHandler.h.

Referenced by otb::ImageWidgetController::HandleWidgetMove().

virtual bool otb::ImageWidgetActionHandler::HandleWidgetResize	(	const std::string &	,
		int	,
		int
	)

inlinevirtual

Handle widget resize

Parameters:

widgetId	The id of the resized widget
w	new width
h	new height

Returns:: true if the event is handled

Reimplemented in otb::WidgetResizingActionHandler< TModel, TView >.

Definition at line 81 of file otbImageWidgetActionHandler.h.

Referenced by otb::ImageWidgetController::HandleWidgetResize().

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

virtual void otb::ImageWidgetActionHandler::IsActiveOff ( )

virtual

virtual void otb::ImageWidgetActionHandler::IsActiveOn ( )

virtual

void itk::Object::Modified ( void ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

static Pointer otb::ImageWidgetActionHandler::New ( )

static

Method for creation through the object factory

Reimplemented from itk::Object.

void otb::ImageWidgetActionHandler::operator= ( const Self & )

private

Reimplemented in otb::VectorDataActionHandler< TModel, TView >, otb::PixelDescriptionActionHandler< TModel, TView >, otb::SelectAreaActionHandler< TModel, TWidget >, otb::VectorDataEditVertexActionHandler< TModel, TView >, otb::VectorDataTranslateGeometryActionHandler< TModel, TView >, otb::MouseClickActionHandler< TModel, TView >, otb::WidgetResizingActionHandler< TModel, TView >, and otb::AutoScaleActionHandler< TWidgetType >.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)		const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().