ufe  1.0
Universal Front End is a DCC-agnostic component that will allow a DCC to browse and edit data in multiple data models
Ufe::TranslateUndoableCommand Class Referenceabstract

Abstract class for undoable translate command. More...

#include <transform3dUndoableCommands.h>

Inheritance diagram for Ufe::TranslateUndoableCommand:
Collaboration diagram for Ufe::TranslateUndoableCommand:

Public Types

typedef std::shared_ptr< TranslateUndoableCommandPtr
 
- Public Types inherited from Ufe::UndoableCommand
typedef std::shared_ptr< UndoableCommandPtr
 

Public Member Functions

 TranslateUndoableCommand (const SceneItem::Ptr &item)
 Constructor. More...
 
 TranslateUndoableCommand (const TranslateUndoableCommand &)=default
 Default copy constructor. More...
 
virtual ~TranslateUndoableCommand ()
 Destructor. More...
 
virtual bool translate (double x, double y, double z)=0
 
- Public Member Functions inherited from Ufe::BaseTransformUndoableCommand
 BaseTransformUndoableCommand (const SceneItem::Ptr &item)
 
virtual ~BaseTransformUndoableCommand ()
 
SceneItem::Ptr sceneItem () const
 
- Public Member Functions inherited from Ufe::UndoableCommand
virtual ~UndoableCommand ()
 Destructor. 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

Abstract class for undoable translate command.

Definition at line 33 of file transform3dUndoableCommands.h.

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ TranslateUndoableCommand() [1/2]

Ufe::TranslateUndoableCommand::TranslateUndoableCommand ( const SceneItem::Ptr item)

Constructor.

◆ TranslateUndoableCommand() [2/2]

Ufe::TranslateUndoableCommand::TranslateUndoableCommand ( const TranslateUndoableCommand )
default

Default copy constructor.

◆ ~TranslateUndoableCommand()

virtual Ufe::TranslateUndoableCommand::~TranslateUndoableCommand ( )
virtual

Destructor.

Member Function Documentation

◆ translate()

virtual bool Ufe::TranslateUndoableCommand::translate ( double  x,
double  y,
double  z 
)
pure virtual

Translate the object by the given x, y, z values. The semantics of the translation, whether absolute or relative, and the coordinate system in which it is done (object local, parent, world) is up to the concrete derived class.

Parameters
xvalue to translate on the X-axis.
yvalue to translate on the Y-axis.
zvalue to translate on the Z-axis.

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