Inheritance diagram for Seg3D::ActionMigrateSandboxLayer:

Public Member Functions
virtual bool	validate (Core::ActionContextHandle &context)

virtual bool	run (Core::ActionContextHandle &context, Core::ActionResultHandle &result)

virtual void	clear_cache ()

Public Member Functions inherited from Core::Action
virtual ActionInfoHandle	get_action_info () const =0

std::string	get_definition () const
	Get the definition of the action (in XML format)

std::string	get_type () const
	Get the type of the action.

std::string	get_usage () const
	Get a usage description.

std::string	get_key (size_t index) const
	Get the name of the key with a certain index.

std::string	get_default_key_value (size_t index) const
	Get the name of the key with a certain index.

int	get_key_index (const std::string &name) const
	Get the index of a certain key.

bool	is_undoable () const
	Check whether the action is undoable.

virtual bool	changes_project_data ()

virtual bool	translate (ActionContextHandle &context)

std::string	export_to_string () const

bool	import_from_string (const std::string &action, std::string &error)

bool	import_from_string (const std::string &action)
	Same as function above, but without the error report.

Additional Inherited Members
Protected Member Functions inherited from Core::Action
template<class T >
void	add_parameter (T &parameter)

void	add_param (ActionParameterBase *parameter)
	Add a parameter to the internal structure of the action.

ActionParameterBase *	get_param (size_t index) const
	Retrieve the parameter from the internal structure of the action.

const size_t	num_params () const
	Number of parameter in this action.

Member Function Documentation

void Seg3D::ActionMigrateSandboxLayer::clear_cache ( )

virtual

CLEAR_CACHE: Clear any objects that were given as a short cut to improve performance.

Reimplemented from Core::Action.

bool Seg3D::ActionMigrateSandboxLayer::run	(	Core::ActionContextHandle &	context,
		Core::ActionResultHandle &	result
	)

virtual

RUN: Each action needs to have this piece implemented. It spells out how the action is run. It returns whether the action was successful or not.

Implements Core::Action.

bool Seg3D::ActionMigrateSandboxLayer::validate ( Core::ActionContextHandle & context )

virtual

VALIDATE: Each action needs to be validated just before it is posted. This way we enforce that every action that hits the main post_action signal will be a valid action to execute.

Implements Core::Action.

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

Application/Layer/Actions/ActionMigrateSandboxLayer.h
Application/Layer/Actions/ActionMigrateSandboxLayer.cc

Public Member Functions

Additional Inherited Members

Member Function Documentation