Subtree invalidate notification. More...

#include <sceneNotification.h>

Inheritance diagram for Ufe::SubtreeInvalidate:

Collaboration diagram for Ufe::SubtreeInvalidate:

Public Member Functions
	SubtreeInvalidate (const SceneItem::Ptr &item)
	Constructor. More...

	SubtreeInvalidate (const SubtreeInvalidate &)=default
	Default copy constructor. More...

	~SubtreeInvalidate () override
	Destructor. More...

SceneItem::Ptr	root () const

Path	changedPath () 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	fRoot

Additional Inherited Members
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::SceneChanged
	SceneChanged (OpType opType)
	Constructor. More...

Detailed Description

Subtree invalidate notification.

An invalidate notification is for data model changes where all descendants of the root will be invalidated. This could mean the entire hierarchy has been removed and/or an entirely new hierarchy attached.

The root item contained in this notification is valid, but all its descendants are stale (have been invalidated).

Synchronously within this notification you cannot query for the replacement of the invalidated hierarchy because it might not be there yet.

Definition at line 395 of file sceneNotification.h.

Constructor & Destructor Documentation

◆ SubtreeInvalidate() [1/2]

Ufe::SubtreeInvalidate::SubtreeInvalidate ( const SceneItem::Ptr & item )

Constructor.

◆ SubtreeInvalidate() [2/2]

Ufe::SubtreeInvalidate::SubtreeInvalidate ( const SubtreeInvalidate & )

default

Default copy constructor.

◆ ~SubtreeInvalidate()

Ufe::SubtreeInvalidate::~SubtreeInvalidate ( )

override

Destructor.

Member Function Documentation

◆ changedPath()

Path Ufe::SubtreeInvalidate::changedPath ( ) const

overridevirtual

Returns: Returns the path of the invalidated subtree root.

Reimplemented from Ufe::SceneChanged.

◆ root()

SceneItem::Ptr Ufe::SubtreeInvalidate::root ( ) const

Returns: The root SceneItem of the invalidated subtree.

Member Data Documentation

◆ fRoot

const SceneItem::Ptr Ufe::SubtreeInvalidate::fRoot

private

Definition at line 414 of file sceneNotification.h.

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

common/include/ufe/sceneNotification.h

Public Member Functions

Private Attributes

Additional Inherited Members