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

SceneChanged composite notification. More...

#include <sceneNotification.h>

Inheritance diagram for Ufe::SceneCompositeNotification:
Collaboration diagram for Ufe::SceneCompositeNotification:

Classes

struct  Op
 

Public Types

typedef std::list< OpOps
 
- Public Types inherited from Ufe::SceneChanged
enum  OpType : unsigned char {
  ObjectAdd , ObjectDelete , ObjectPathChange , SubtreeInvalidate ,
  SceneCompositeNotification
}
 
using SubOpStorageType = unsigned char
 

Public Member Functions

 SceneCompositeNotification ()
 Constructor. More...
 
 SceneCompositeNotification (const SceneCompositeNotification &)=default
 Default copy constructor. More...
 
 ~SceneCompositeNotification () override
 Destructor. More...
 
Path changedPath () const override
 
void appendSceneChanged (const SceneChanged &sceneChanged)
 
void appendOp (const Op &op)
 
Ops opsList () const
 
std::size_t size () const
 
bool empty () const
 
Ops::const_iterator cbegin () const
 Iteration interface on operations. More...
 
Ops::const_iterator begin () const
 
Ops::const_iterator cend () const
 
Ops::const_iterator end () const
 
Ops::iterator begin ()
 
Ops::iterator end ()
 
- 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

Ops fOps
 

Additional Inherited Members

- Static Public Attributes inherited from Ufe::SceneChanged
static constexpr SubOpStorageType SubOpTypeNone = 0
 
- Protected Member Functions inherited from Ufe::SceneChanged
 SceneChanged (OpType opType)
 Constructor. More...
 

Detailed Description

SceneChanged composite notification.

This class collects multiple scene change operations inside a single notification. The scene change operations are stored as a list, in the same order as they were performed.

Definition at line 426 of file sceneNotification.h.

Member Typedef Documentation

◆ Ops

Definition at line 456 of file sceneNotification.h.

Constructor & Destructor Documentation

◆ SceneCompositeNotification() [1/2]

Ufe::SceneCompositeNotification::SceneCompositeNotification ( )

Constructor.

◆ SceneCompositeNotification() [2/2]

Ufe::SceneCompositeNotification::SceneCompositeNotification ( const SceneCompositeNotification )
default

Default copy constructor.

◆ ~SceneCompositeNotification()

Ufe::SceneCompositeNotification::~SceneCompositeNotification ( )
override

Destructor.

Member Function Documentation

◆ appendOp()

void Ufe::SceneCompositeNotification::appendOp ( const Op op)

◆ appendSceneChanged()

void Ufe::SceneCompositeNotification::appendSceneChanged ( const SceneChanged sceneChanged)

◆ begin() [1/2]

Ops::iterator Ufe::SceneCompositeNotification::begin ( )

◆ begin() [2/2]

Ops::const_iterator Ufe::SceneCompositeNotification::begin ( ) const

◆ cbegin()

Ops::const_iterator Ufe::SceneCompositeNotification::cbegin ( ) const

Iteration interface on operations.

◆ cend()

Ops::const_iterator Ufe::SceneCompositeNotification::cend ( ) const

◆ changedPath()

Path Ufe::SceneCompositeNotification::changedPath ( ) const
overridevirtual
Returns
Returns an empty path. Each op should be queried for its changed path.

Reimplemented from Ufe::SceneChanged.

◆ empty()

bool Ufe::SceneCompositeNotification::empty ( ) const
Returns
True if size() == 0.

◆ end() [1/2]

Ops::iterator Ufe::SceneCompositeNotification::end ( )

◆ end() [2/2]

Ops::const_iterator Ufe::SceneCompositeNotification::end ( ) const

◆ opsList()

Ops Ufe::SceneCompositeNotification::opsList ( ) const
inline
Returns
copy of operation's list

Definition at line 476 of file sceneNotification.h.

◆ size()

std::size_t Ufe::SceneCompositeNotification::size ( ) const
Returns
Size of operations in the composite notification

Member Data Documentation

◆ fOps

Ops Ufe::SceneCompositeNotification::fOps
private

Definition at line 495 of file sceneNotification.h.


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