Base class for object delete scene notifications. More...

#include <sceneNotification.h>

Inheritance diagram for Ufe::ObjectDelete:

[legend]

Collaboration diagram for Ufe::ObjectDelete:

[legend]

Public Types
enum	SubOpType : SubOpStorageType { None = SubOpTypeNone , ObjectPostDelete , ObjectPreDelete , ObjectDestroyed }

Public Types inherited from Ufe::SceneChanged
enum	OpType : unsigned char { ObjectAdd , ObjectDelete , ObjectPathChange , SubtreeInvalidate , SceneCompositeNotification }

using	SubOpStorageType = unsigned char

Public Member Functions
	ObjectDelete (const Path &path)
	Constructor. More...

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

	~ObjectDelete () override
	Destructor. More...

Path	path () const

Path	changedPath () const override

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

Protected Member Functions
	ObjectDelete (const Path &path, SubOpType objectDeleteOpType)
	Constructor. More...

Protected Member Functions inherited from Ufe::SceneChanged
	SceneChanged (OpType opType)
	Constructor. More...

Private Attributes
const Path	fPath

const SubOpType	fSubOpType

Additional Inherited Members
Static Public Attributes inherited from Ufe::SceneChanged
static constexpr SubOpStorageType	SubOpTypeNone = 0

Detailed Description

Base class for object delete scene notifications.

This class is the base class for object delete scene notifications. There are three ObjectDelete derived class notification types: post-delete, pre-delete and destroyed. This covers runtimes that send notification just before the object is deleted (e.g. Maya), and those that send notification just after the object is deleted (e.g. USD).

Definition at line 98 of file sceneNotification.h.

Member Enumeration Documentation

◆ SubOpType

enum Ufe::ObjectDelete::SubOpType : SubOpStorageType

Enumerator
None
ObjectPostDelete
ObjectPreDelete
ObjectDestroyed

Definition at line 101 of file sceneNotification.h.

Constructor & Destructor Documentation

◆ ObjectDelete() [1/3]

Ufe::ObjectDelete::ObjectDelete ( const Path & path )

Constructor.

◆ ObjectDelete() [2/3]

Ufe::ObjectDelete::ObjectDelete ( const ObjectDelete & )

default

Default copy constructor.

◆ ~ObjectDelete()

Ufe::ObjectDelete::~ObjectDelete ( )

override

Destructor.

◆ ObjectDelete() [3/3]

Ufe::ObjectDelete::ObjectDelete	(	const Path &	path,
		SubOpType	objectDeleteOpType
	)

protected

Constructor.

Member Function Documentation

◆ changedPath()

Path Ufe::ObjectDelete::changedPath ( ) const

overridevirtual

Returns: Calls path().

Reimplemented from Ufe::SceneChanged.

◆ path()

Path Ufe::ObjectDelete::path ( ) const

Returns: Path to the object that was deleted.

◆ subOpType()

SubOpStorageType Ufe::ObjectDelete::subOpType ( ) const

overridevirtual

Returns: SubOpType of the notification specific to ObjectDelete.

Reimplemented from Ufe::SceneChanged.

Member Data Documentation

◆ fPath

const Path Ufe::ObjectDelete::fPath

private

Definition at line 131 of file sceneNotification.h.

◆ fSubOpType

const SubOpType Ufe::ObjectDelete::fSubOpType

private

Definition at line 132 of file sceneNotification.h.

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

common/include/ufe/sceneNotification.h

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members