Ufe::SetValue2UndoableCommand< VALUE_TYPE > Class Template Reference

Abstract class for set Value2 command. More...

#include <baseUndoableCommands.h>

Inheritance diagram for Ufe::SetValue2UndoableCommand< VALUE_TYPE >:

Collaboration diagram for Ufe::SetValue2UndoableCommand< VALUE_TYPE >:

Public Types
typedef std::shared_ptr< SetValue2UndoableCommand >	Ptr
typedef VALUE_TYPE	ValueType
Public Types inherited from Ufe::UndoableCommand
typedef std::shared_ptr< UndoableCommand >	Ptr

Public Member Functions
	SetValue2UndoableCommand (const Path &path)
	Constructor. More...
	~SetValue2UndoableCommand () override
	Destructor. More...
std::string	commandString () const override
	Get a user friendly string representation of the command. More...
virtual bool	set (VALUE_TYPE x, VALUE_TYPE y)=0
Public Member Functions inherited from Ufe::BaseUndoableCommand
	BaseUndoableCommand (const Path &path)
	~BaseUndoableCommand () override
void	setPath (const Path &path)
	Set the path of the object onto which the command is applied. More...
const Path &	path () const
Ufe::SceneItem::Ptr	sceneItem () const
Public Member Functions inherited from Ufe::UndoableCommand
virtual	~UndoableCommand ()
	Destructor. More...
virtual std::string	commandString () const
	Get a user friendly string representation of the command. More...
virtual void	execute ()
virtual void	undo ()=0
virtual void	redo ()=0

Additional Inherited Members
Protected Member Functions inherited from Ufe::UndoableCommand
	UndoableCommand ()
	Constructor. More...
	UndoableCommand (const UndoableCommand &)=delete
	Deleting copy constructor. More...

Detailed Description

template<typename VALUE_TYPE>
class Ufe::SetValue2UndoableCommand< VALUE_TYPE >

Abstract class for set Value2 command.

Definition at line 74 of file baseUndoableCommands.h.

Member Typedef Documentation

Ptr

template<typename VALUE_TYPE >

typedef std::shared_ptr<SetValue2UndoableCommand> Ufe::SetValue2UndoableCommand< VALUE_TYPE >::Ptr

Definition at line 77 of file baseUndoableCommands.h.

ValueType

template<typename VALUE_TYPE >

typedef VALUE_TYPE Ufe::SetValue2UndoableCommand< VALUE_TYPE >::ValueType

Definition at line 78 of file baseUndoableCommands.h.

Constructor & Destructor Documentation

SetValue2UndoableCommand()

template<typename VALUE_TYPE >

Ufe::SetValue2UndoableCommand< VALUE_TYPE >::SetValue2UndoableCommand ( const Path &  path )

inline

Constructor.

Definition at line 81 of file baseUndoableCommands.h.

~SetValue2UndoableCommand()

template<typename VALUE_TYPE >

Ufe::SetValue2UndoableCommand< VALUE_TYPE >::~SetValue2UndoableCommand ( )

inlineoverride

Destructor.

Definition at line 83 of file baseUndoableCommands.h.

Member Function Documentation

commandString()

template<typename VALUE_TYPE >

std::string Ufe::SetValue2UndoableCommand< VALUE_TYPE >::commandString ( ) const

inlineoverridevirtual

Get a user friendly string representation of the command.

Note

For example, an application can print out the executed command to give an hint to the user of what was sucessfully done.

Reimplemented from Ufe::UndoableCommand.

Definition at line 85 of file baseUndoableCommands.h.

set()

template<typename VALUE_TYPE >

virtual bool Ufe::SetValue2UndoableCommand< VALUE_TYPE >::set ( VALUE_TYPE  x, VALUE_TYPE  y  )

pure virtual

        Set the Value2

!

Parameters

x	x component of vector. !
y	y component of vector.

---

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

• common/include/ufe/baseUndoableCommands.h