Maintains a collection of vtkUndoElement that can be undone/redone in a single step. More...

#include <vtkUndoSet.h>

Inheritance diagram for vtkUndoSet:

Collaboration diagram for vtkUndoSet:

[legend]

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual int	Undo ()
	Perform an Undo. More...

virtual int	Redo ()
	Perform a Redo. More...

int	AddElement (vtkUndoElement *elem)
	Add an element to this set. More...

void	RemoveElement (int index)
	Remove an element at a particular index. More...

vtkUndoElement *	GetElement (int index)
	Get an element at a particular index. More...

void	RemoveAllElements ()
	Remove all elemments. More...

int	GetNumberOfElements ()
	Get number of elements in the set. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkUndoSet *	New ()

static int	IsTypeOf (const char *type)

static vtkUndoSet *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkUndoSet ()

	~vtkUndoSet () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkCollection *	Collection

vtkCollection *	TmpWorkingCollection

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Maintains a collection of vtkUndoElement that can be undone/redone in a single step.

This is a concrete class that stores a collection of vtkUndoElement objects. A vtkUndoSet object represents an atomic undo-redoable operation. It can contain one or more vtkUndoElement objects. When added vtkUndoElement objects to a vtkUndoSet they must be added in the sequence of operation. When undoing the operations are performed in reverse order, while when redoing they are performed in forward order.

vtkUndoElement, vtkUndoSet and vtkUndoStack form the undo/redo framework core.

See also: vtkUndoStack vtkUndoElement

Definition at line 42 of file vtkUndoSet.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkUndoSet::Superclass

Definition at line 46 of file vtkUndoSet.h.

Constructor & Destructor Documentation

◆ vtkUndoSet()

vtkUndoSet::vtkUndoSet ( )

protected

◆ ~vtkUndoSet()

vtkUndoSet::~vtkUndoSet ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkUndoSet* vtkUndoSet::New ( )

static

◆ GetClassName()

virtual const char* vtkUndoSet::GetClassName ( )

virtual

◆ IsTypeOf()

static int vtkUndoSet::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkUndoSet::IsA ( const char * type )

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkUndoSet* vtkUndoSet::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

void vtkUndoSet::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkObject.

◆ Undo()

virtual int vtkUndoSet::Undo ( )

virtual

Perform an Undo.

◆ Redo()

virtual int vtkUndoSet::Redo ( )

virtual

Perform a Redo.

◆ AddElement()

int vtkUndoSet::AddElement ( vtkUndoElement * elem )

Add an element to this set.

If the newly added element, elem, and the most recently added element are both Mergeable, then an attempt is made to merge the new element with the previous one. On successful merging, the new element is discarded, otherwise it is appended to the set.

Returns: the index at which the element got added/merged.

◆ RemoveElement()

void vtkUndoSet::RemoveElement ( int index )

Remove an element at a particular index.

◆ GetElement()

vtkUndoElement* vtkUndoSet::GetElement ( int index )

Get an element at a particular index.

◆ RemoveAllElements()

void vtkUndoSet::RemoveAllElements ( )

Remove all elemments.

◆ GetNumberOfElements()

int vtkUndoSet::GetNumberOfElements ( )

Get number of elements in the set.

Member Data Documentation

◆ Collection

vtkCollection* vtkUndoSet::Collection

protected

Definition at line 93 of file vtkUndoSet.h.

◆ TmpWorkingCollection

vtkCollection* vtkUndoSet::TmpWorkingCollection

protected

Definition at line 94 of file vtkUndoSet.h.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/Core/vtkUndoSet.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkUndoSet()

◆ ~vtkUndoSet()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ Undo()

◆ Redo()

◆ AddElement()

◆ RemoveElement()

◆ GetElement()

◆ RemoveAllElements()

◆ GetNumberOfElements()

Member Data Documentation

◆ Collection

◆ TmpWorkingCollection