Seg3D::LayerUndoBufferItem Class Reference

Class that describes all the steps that need to be undertaken to undo a layer action. More...

#include <LayerUndoBufferItem.h>

Inheritance diagram for Seg3D::LayerUndoBufferItem:

Public Member Functions
	LayerUndoBufferItem (const std::string &tag)
void	add_filter_to_abort (LayerAbstractFilterHandle filter)
void	add_layer_to_delete (LayerHandle layer)
void	add_layer_to_add (LayerHandle layer)
void	add_layer_to_restore (LayerHandle layer, LayerCheckPointHandle checkpoint)
void	add_id_count_to_restore (LayerManager::id_count_type id_count)
void	set_provenance_step_id (ProvenanceStepID step_id)
void	set_provenance_step_ids (const std::vector< ProvenanceStepID > &step_ids)
void	rollback_layer_changes ()
virtual bool	apply_and_clear_undo ()
virtual size_t	get_byte_size () const
virtual void	compute_size ()
Public Member Functions inherited from Seg3D::UndoBufferItem
	UndoBufferItem (const std::string &tag)
void	set_redo_action (Core::ActionHandle action)
bool	apply_redo (Core::ActionContextHandle &context)
std::string	get_tag () const

Detailed Description

Class that describes all the steps that need to be undertaken to undo a layer action.

Member Function Documentation

void Seg3D::LayerUndoBufferItem::add_filter_to_abort

(

LayerAbstractFilterHandle

filter

)

ADD_FILTER_TO_ABORT: This adds a base filter weak handle to the process that will compute the filter output.

void Seg3D::LayerUndoBufferItem::add_id_count_to_restore

(

LayerManager::id_count_type

id_count

)

ADD_ID_COUNT_TO_RESTORE: Cache the count of layer and group ids, so they can be rolled back to the original ones NOTE: If they are set to -1, the function will query the current ones.

void Seg3D::LayerUndoBufferItem::add_layer_to_add

(

LayerHandle

layer

)

ADD_LAYER_TO_ADD: Add layer to delete list

void Seg3D::LayerUndoBufferItem::add_layer_to_delete

(

LayerHandle

layer

)

ADD_LAYER_TO_DELETE: Add layer to delete list If a new layer is created by the action it should be deleted in the undo This functions adds a handle to the layer that needs to be deleted in the undo

void Seg3D::LayerUndoBufferItem::add_layer_to_restore	(	LayerHandle	layer,
		LayerCheckPointHandle	checkpoint
	)

ADD_LAYER_TO_RESTORE: Add layer to restore list, layers are restored using check points.

bool Seg3D::LayerUndoBufferItem::apply_and_clear_undo ( )

virtual

APPLY_AND_CLEAR_UNDO: Apply the undo information

Implements Seg3D::UndoBufferItem.

void Seg3D::LayerUndoBufferItem::compute_size ( )

virtual

COMPUTE_SIZE: Compute the size of the item

Implements Seg3D::UndoBufferItem.

size_t Seg3D::LayerUndoBufferItem::get_byte_size ( ) const

virtual

GET_BYTE_SIZE: The size of the item in memory ( approximately )

Implements Seg3D::UndoBufferItem.

void Seg3D::LayerUndoBufferItem::rollback_layer_changes

(

)

ROLLBACK_LAYER_CHANGES: Abort corresponding filters (if any) and rollback all the layer changes. NOTE: This function should only be called by LayerFilter when aborted by the user.

void Seg3D::LayerUndoBufferItem::set_provenance_step_id

(

ProvenanceStepID

step_id

)

SET_PROVENANCE_STEP_ID: Set the provenance record ID associated with the action.

void Seg3D::LayerUndoBufferItem::set_provenance_step_ids

(

const std::vector< ProvenanceStepID > &

step_ids

)

SET_PROVENANCE_STEP_IDS: Set the provenance record ID associated with the action.

---

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

• Application/Layer/LayerUndoBufferItem.h
• Application/Layer/LayerUndoBufferItem.cc