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
enum	OpType {   OpType::ObjectAdd, OpType::ObjectDelete, OpType::ObjectPostDelete, OpType::ObjectPreDelete,   OpType::ObjectDestroyed, OpType::ObjectRename, OpType::ObjectReparent, OpType::ObjectPathAdd,   OpType::ObjectPathRemove, OpType::SubtreeInvalidate }
typedef std::list< Op >	Ops

Public Member Functions
	SceneCompositeNotification ()
	Constructor. More...
	SceneCompositeNotification (const SceneCompositeNotification &)=default
	Default copy constructor. More...
	~SceneCompositeNotification () override
	Destructor. More...
Path	changedPath () const override
void	appendObjectAdd (const SceneItem::Ptr &item)
	Append an Add operation to the list of operations. More...
void	appendObjectDelete (const Path &path)
	Append a Delete operation to the list of operations. More...
void	appendObjectPostDelete (const SceneItem::Ptr &item)
	Append a PostDelete operation to the list of operations. More...
void	appendObjectPreDelete (const SceneItem::Ptr &item)
	Append a PreDelete operation to the list of operations. More...
void	appendObjectDestroyed (const Path &path)
	Append a Destroyed operation to the list of operations. More...
void	appendObjectRename (const SceneItem::Ptr &item, const Path &previousPath)
	Append a Rename operation to the list of operations. More...
void	appendObjectReparent (const SceneItem::Ptr &item, const Path &previousPath)
	Append a Reparent operation to the list of operations. More...
void	appendObjectPathAdd (const SceneItem::Ptr &item)
	Append a PathAdd operation to the list of operations. More...
void	appendObjectPathRemove (const Path &path)
	Append a PathRemove operation to the list of operations. More...
void	appendSubtreeInvalidate (const SceneItem::Ptr &item)
	Append a SubtreeInvalidate operation to the list of operations. More...
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
	Iteration interface on operations. More...
Ops::const_iterator	cend () const
	Iteration interface on operations. More...
Ops::const_iterator	end () const
	Iteration interface on operations. More...
Ops::iterator	begin ()
	Iteration interface on operations. More...
Ops::iterator	end ()
	Iteration interface on operations. More...
Public Member Functions inherited from Ufe::SceneChanged
	SceneChanged ()
	Constructor. More...
	SceneChanged (const SceneChanged &)=default
	Default copy constructor. More...
	~SceneChanged () override
	Destructor. More...
Public Member Functions inherited from Ufe::Notification
	Notification ()
	Constructor. More...
	Notification (const Notification &)=default
	Default copy constructor. More...
virtual	~Notification ()
	Destructor. More...

Private Attributes
Ops	fOps

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 369 of file sceneNotification.h.

Member Typedef Documentation

Ops

typedef std::list<Op> Ufe::SceneCompositeNotification::Ops

Definition at line 404 of file sceneNotification.h.

Member Enumeration Documentation

OpType

enum Ufe::SceneCompositeNotification::OpType

strong

Enumerator
ObjectAdd
ObjectDelete
ObjectPostDelete
ObjectPreDelete
ObjectDestroyed
ObjectRename
ObjectReparent
ObjectPathAdd
ObjectPathRemove
SubtreeInvalidate

Definition at line 372 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

appendObjectAdd()

void Ufe::SceneCompositeNotification::appendObjectAdd

(

const SceneItem::Ptr &

item

)

Append an Add operation to the list of operations.

appendObjectDelete()

void Ufe::SceneCompositeNotification::appendObjectDelete

(

const Path &

path

)

Append a Delete operation to the list of operations.

appendObjectDestroyed()

void Ufe::SceneCompositeNotification::appendObjectDestroyed

(

const Path &

path

)

Append a Destroyed operation to the list of operations.

appendObjectPathAdd()

void Ufe::SceneCompositeNotification::appendObjectPathAdd

(

const SceneItem::Ptr &

item

)

Append a PathAdd operation to the list of operations.

appendObjectPathRemove()

void Ufe::SceneCompositeNotification::appendObjectPathRemove

(

const Path &

path

)

Append a PathRemove operation to the list of operations.

appendObjectPostDelete()

void Ufe::SceneCompositeNotification::appendObjectPostDelete

(

const SceneItem::Ptr &

item

)

Append a PostDelete operation to the list of operations.

appendObjectPreDelete()

void Ufe::SceneCompositeNotification::appendObjectPreDelete

(

const SceneItem::Ptr &

item

)

Append a PreDelete operation to the list of operations.

appendObjectRename()

void Ufe::SceneCompositeNotification::appendObjectRename	(	const SceneItem::Ptr &	item,
		const Path &	previousPath
	)

Append a Rename operation to the list of operations.

appendObjectReparent()

void Ufe::SceneCompositeNotification::appendObjectReparent	(	const SceneItem::Ptr &	item,
		const Path &	previousPath
	)

Append a Reparent operation to the list of operations.

appendSubtreeInvalidate()

void Ufe::SceneCompositeNotification::appendSubtreeInvalidate

(

const SceneItem::Ptr &

item

)

Append a SubtreeInvalidate operation to the list of operations.

begin() [1/2]

Ops::const_iterator Ufe::SceneCompositeNotification::begin

(

)

const

Iteration interface on operations.

begin() [2/2]

Ops::iterator Ufe::SceneCompositeNotification::begin

(

)

Iteration interface on operations.

cbegin()

Ops::const_iterator Ufe::SceneCompositeNotification::cbegin

(

)

const

Iteration interface on operations.

cend()

Ops::const_iterator Ufe::SceneCompositeNotification::cend

(

)

const

Iteration interface on operations.

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::const_iterator Ufe::SceneCompositeNotification::end

(

)

const

Iteration interface on operations.

end() [2/2]

Ops::iterator Ufe::SceneCompositeNotification::end

(

)

Iteration interface on operations.

opsList()

Ops Ufe::SceneCompositeNotification::opsList ( ) const

inline

Returns

copy of operation's list

Definition at line 450 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 469 of file sceneNotification.h.

---

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

• common/include/ufe/sceneNotification.h