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

Base class for all scene notifications. More...

#include <sceneNotification.h>

Inheritance diagram for Ufe::SceneChanged:
Collaboration diagram for Ufe::SceneChanged:

Public Types

enum  OpType : unsigned char {
  ObjectAdd , ObjectDelete , ObjectPathChange , SubtreeInvalidate ,
  SceneCompositeNotification
}
 
using SubOpStorageType = unsigned char
 

Public Member Functions

 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
 

Static Public Attributes

static constexpr SubOpStorageType SubOpTypeNone = 0
 

Protected Member Functions

 SceneChanged (OpType opType)
 Constructor. More...
 

Private Attributes

const OpType fOpType
 

Detailed Description

Base class for all scene notifications.

This class is the base class for all scene changed notifications.

Definition at line 25 of file sceneNotification.h.

Member Typedef Documentation

◆ SubOpStorageType

using Ufe::SceneChanged::SubOpStorageType = unsigned char

Definition at line 36 of file sceneNotification.h.

Member Enumeration Documentation

◆ OpType

enum Ufe::SceneChanged::OpType : unsigned char
Enumerator
ObjectAdd 
ObjectDelete 
ObjectPathChange 
SubtreeInvalidate 
SceneCompositeNotification 

Definition at line 28 of file sceneNotification.h.

Constructor & Destructor Documentation

◆ SceneChanged() [1/2]

Ufe::SceneChanged::SceneChanged ( const SceneChanged )
default

Default copy constructor.

◆ ~SceneChanged()

Ufe::SceneChanged::~SceneChanged ( )
override

Destructor.

◆ SceneChanged() [2/2]

Ufe::SceneChanged::SceneChanged ( OpType  opType)
protected

Constructor.

Member Function Documentation

◆ changedPath()

virtual Path Ufe::SceneChanged::changedPath ( ) const
virtual
Returns
Path to the object that was changed. In the case of a composite notification, this path will be empty.

Reimplemented in Ufe::ObjectAdd, Ufe::ObjectDelete, Ufe::ObjectRename, Ufe::ObjectReparent, Ufe::ObjectPathAdd, Ufe::ObjectPathRemove, Ufe::SubtreeInvalidate, and Ufe::SceneCompositeNotification.

◆ opType()

OpType Ufe::SceneChanged::opType ( ) const
Returns
OpType of the notification.

◆ subOpType()

virtual SubOpStorageType Ufe::SceneChanged::subOpType ( ) const
virtual
Returns
SubOpType of the notification specific to the OpType.

Reimplemented in Ufe::ObjectDelete, and Ufe::ObjectPathChange.

Member Data Documentation

◆ fOpType

const OpType Ufe::SceneChanged::fOpType
private

Definition at line 59 of file sceneNotification.h.

◆ SubOpTypeNone

constexpr SubOpStorageType Ufe::SceneChanged::SubOpTypeNone = 0
staticconstexpr

Definition at line 37 of file sceneNotification.h.


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