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

Remove an item from the argument selection. More...

#include <selectionUndoableCommands.h>

Inheritance diagram for Ufe::SelectionRemoveItem:
Collaboration diagram for Ufe::SelectionRemoveItem:

Public Member Functions

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

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

Remove an item from the argument selection.

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

Definition at line 64 of file selectionUndoableCommands.h.

Constructor & Destructor Documentation

◆ SelectionRemoveItem()

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

Constructor.

Member Function Documentation

◆ createAndExecute()

static Ptr Ufe::SelectionRemoveItem::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::SelectionRemoveItem::redo ( )
overridevirtual

Redo the remove.

Implements Ufe::UndoableCommand.

◆ undo()

void Ufe::SelectionRemoveItem::undo ( )
overridevirtual

Undo the remove (i.e. append).

Implements Ufe::UndoableCommand.

Member Data Documentation

◆ fPath

const Path Ufe::SelectionRemoveItem::fPath
private

Definition at line 92 of file selectionUndoableCommands.h.

◆ fSn

const GlobalSelection::Ptr Ufe::SelectionRemoveItem::fSn
private

Definition at line 88 of file selectionUndoableCommands.h.


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