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::ObjectReparent Class Reference

Object reparented scene notification. More...

#include <sceneNotification.h>

Inheritance diagram for Ufe::ObjectReparent:
Collaboration diagram for Ufe::ObjectReparent:

Public Member Functions

 ObjectReparent (const SceneItem::Ptr &item, const Path &previousPath)
 Constructor. More...
 
 ObjectReparent (const ObjectReparent &)=default
 Default copy constructor. More...
 
 ~ObjectReparent () override
 Destructor. More...
 
SceneItem::Ptr item () const
 
Path previousPath () const
 
Path changedPath () const override
 
- Public Member Functions inherited from Ufe::ObjectPathChange
 ObjectPathChange ()
 Constructor. More...
 
 ObjectPathChange (const ObjectPathChange &)=default
 Default copy constructor. More...
 
 ~ObjectPathChange () override
 Destructor. More...
 
SubOpStorageType subOpType () const override
 
- Public Member Functions inherited from Ufe::SceneChanged
 SceneChanged (const SceneChanged &)=default
 Default copy constructor. More...
 
 ~SceneChanged () override
 Destructor. More...
 
virtual Path changedPath () const
 
OpType opType () const
 
virtual SubOpStorageType subOpType () const
 
- Public Member Functions inherited from Ufe::Notification
 Notification ()
 Constructor. More...
 
 Notification (const Notification &)=default
 Default copy constructor. More...
 
virtual ~Notification ()
 Destructor. More...
 
template<typename T >
const T & staticCast () const
 

Private Attributes

const SceneItem::Ptr fItem
 
const Path fPreviousPath
 

Additional Inherited Members

- Public Types inherited from Ufe::ObjectPathChange
enum  SubOpType : SubOpStorageType {
  None = SubOpTypeNone , ObjectRename , ObjectReparent , ObjectPathAdd ,
  ObjectPathRemove
}
 
- Public Types inherited from Ufe::SceneChanged
enum  OpType : unsigned char {
  ObjectAdd , ObjectDelete , ObjectPathChange , SubtreeInvalidate ,
  SceneCompositeNotification
}
 
using SubOpStorageType = unsigned char
 
- Static Public Attributes inherited from Ufe::SceneChanged
static constexpr SubOpStorageType SubOpTypeNone = 0
 
- Protected Member Functions inherited from Ufe::ObjectPathChange
 ObjectPathChange (SubOpType objectPathChangeOpType)
 Constructor. More...
 
- Protected Member Functions inherited from Ufe::SceneChanged
 SceneChanged (OpType opType)
 Constructor. More...
 
- Protected Attributes inherited from Ufe::ObjectPathChange
const SubOpType fSubOpType
 

Detailed Description

Object reparented scene notification.

A reparent notification is a path change notification where one or more components, including the tail, are changed. Conceptually, it is sent when the tail component object is given a new parent. However, because child names must be unique, the tail component can also be changed if there is an existing child with the same name under the new parent. Implicitly, all children of the reparented object have their paths changed; no notification is sent for this.

Should have been implemented using a type alias:

using ObjectReparent = ObjectRename;

See sceneItemOps.h for description of pybind11 problems encountered with this approach. PPT, 13-Aug-2018.

Definition at line 291 of file sceneNotification.h.

Constructor & Destructor Documentation

◆ ObjectReparent() [1/2]

Ufe::ObjectReparent::ObjectReparent ( const SceneItem::Ptr item,
const Path previousPath 
)

Constructor.

◆ ObjectReparent() [2/2]

Ufe::ObjectReparent::ObjectReparent ( const ObjectReparent )
default

Default copy constructor.

◆ ~ObjectReparent()

Ufe::ObjectReparent::~ObjectReparent ( )
override

Destructor.

Member Function Documentation

◆ changedPath()

Path Ufe::ObjectReparent::changedPath ( ) const
overridevirtual
Returns
Calls previousPath().

Reimplemented from Ufe::SceneChanged.

◆ item()

SceneItem::Ptr Ufe::ObjectReparent::item ( ) const
Returns
Reparented SceneItem.

◆ previousPath()

Path Ufe::ObjectReparent::previousPath ( ) const
Returns
Previous path.

Member Data Documentation

◆ fItem

const SceneItem::Ptr Ufe::ObjectReparent::fItem
private

Definition at line 313 of file sceneNotification.h.

◆ fPreviousPath

const Path Ufe::ObjectReparent::fPreviousPath
private

Definition at line 314 of file sceneNotification.h.


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