![]() |
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
|
Abstract base class for scene item operations interface. More...
#include <sceneItemOps.h>
Public Types | |
typedef std::shared_ptr< SceneItemOps > | Ptr |
Public Member Functions | |
SceneItemOps () | |
Constructor. More... | |
SceneItemOps (const SceneItemOps &)=default | |
Default copy constructor. More... | |
virtual | ~SceneItemOps () |
Destructor. More... | |
virtual SceneItem::Ptr | sceneItem () const =0 |
Scene item accessor. More... | |
virtual UndoableCommand::Ptr | deleteItemCmd ()=0 |
virtual bool | deleteItem ()=0 |
virtual Duplicate | duplicateItemCmd ()=0 |
virtual SceneItem::Ptr | duplicateItem ()=0 |
virtual Rename | renameItemCmd (const PathComponent &newName)=0 |
virtual SceneItem::Ptr | renameItem (const PathComponent &newName)=0 |
Static Public Member Functions | |
static Ptr | sceneItemOps (const SceneItem::Ptr &item) |
Abstract base class for scene item operations interface.
This base class defines the interface that run-times can implement to operate on a given selection item as a whole. These include operations like:
Each operation has two calls, one with undo capability, and one without. Providing undo capability typically involves code complexity, and using undo capability incurs run-time cost in processing and memory. Therefore, non- interactive use of this interface should use calls without undo capability.
To avoid the memory-consuming "one proxy object per scene object" approach, SceneItemOps interface objects should be obtained and used within a local scope, and not stored. SceneItemOps interfaces should be considered stateless, and can be bound to new selection items.
Definition at line 80 of file sceneItemOps.h.
typedef std::shared_ptr<SceneItemOps> Ufe::SceneItemOps::Ptr |
Definition at line 83 of file sceneItemOps.h.
Ufe::SceneItemOps::SceneItemOps | ( | ) |
Constructor.
|
default |
Default copy constructor.
|
virtual |
Destructor.
|
pure virtual |
Remove the item from participation in the scene.
|
pure virtual |
Remove the item from participation in the scene.
|
pure virtual |
Duplicate the item and all its descendants.
|
pure virtual |
|
pure virtual |
Rename the scene item by changing the tail of its path. After the rename, this interface object will be updated to the new scene item.
|
pure virtual |
|
pure virtual |
Scene item accessor.
|
static |
Convenience method that calls the sceneItemOps method on the SceneItemOps handler for the item. Returns a null pointer if the argument is null, or has an empty path.
item | SceneItem's SceneItemOps to retrieve |