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

Append an item to the argument selection. More...

#include <selectionUndoableCommands.h>

Inheritance diagram for Ufe::SelectionAppendItem:
Collaboration diagram for Ufe::SelectionAppendItem:

Public Member Functions

 SelectionAppendItem (const GlobalSelection::Ptr &sn, const SceneItem::Ptr &item)
 Constructor. More...
 
void undo () override
 Undo the append (i.e. remove). More...
 
void redo () override
 Redo the append. More...
 
- 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 ()
 

Static Public Member Functions

static Ptr createAndExecute (const GlobalSelection::Ptr &sn, const SceneItem::Ptr &item)
 

Private Attributes

const GlobalSelection::Ptr fSn
 
const Path fPath
 

Additional Inherited Members

- Public Types inherited from Ufe::UndoableCommand
typedef std::shared_ptr< UndoableCommandPtr
 
- Protected Member Functions inherited from Ufe::UndoableCommand
 UndoableCommand ()
 Constructor. More...
 
 UndoableCommand (const UndoableCommand &)=delete
 Deleting copy constructor. More...
 

Detailed Description

Append an item to the argument selection.

This class appends an item from the argument selection on execution, and removes it on undo.

Definition at line 27 of file selectionUndoableCommands.h.

Constructor & Destructor Documentation

◆ SelectionAppendItem()

Ufe::SelectionAppendItem::SelectionAppendItem ( const GlobalSelection::Ptr sn,
const SceneItem::Ptr item 
)

Constructor.

Member Function Documentation

◆ createAndExecute()

static Ptr Ufe::SelectionAppendItem::createAndExecute ( const GlobalSelection::Ptr sn,
const SceneItem::Ptr item 
)
static

Convenience method to create the undoable command and execute it.

Returns
Pointer to the undoable command.

◆ redo()

void Ufe::SelectionAppendItem::redo ( )
overridevirtual

Redo the append.

Implements Ufe::UndoableCommand.

◆ undo()

void Ufe::SelectionAppendItem::undo ( )
overridevirtual

Undo the append (i.e. remove).

Implements Ufe::UndoableCommand.

Member Data Documentation

◆ fPath

const Path Ufe::SelectionAppendItem::fPath
private

Definition at line 55 of file selectionUndoableCommands.h.

◆ fSn

const GlobalSelection::Ptr Ufe::SelectionAppendItem::fSn
private

Definition at line 51 of file selectionUndoableCommands.h.


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