Abstract base class for scene hierarchy interface. More...

#include <hierarchy.h>

Public Types
typedef std::shared_ptr< Hierarchy >	Ptr

typedef std::list< ChildFilterFlag >	ChildFilter

Public Member Functions
	Hierarchy ()
	Constructor. More...

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

virtual	~Hierarchy ()
	Destructor. More...

virtual SceneItem::Ptr	sceneItem () const =0
	Scene item accessor. More...

virtual bool	hasChildren () const =0

virtual SceneItemList	children () const =0

virtual SceneItemList	filteredChildren (const ChildFilter &) const =0

virtual SceneItem::Ptr	parent () const =0

virtual SceneItem::Ptr	defaultParent () const =0

virtual SceneItem::Ptr	insertChild (const SceneItem::Ptr &child, const SceneItem::Ptr &pos)=0

virtual InsertChildCommand::Ptr	insertChildCmd (const SceneItem::Ptr &child, const SceneItem::Ptr &pos)=0

InsertChildCommand::Ptr	appendChildCmd (const SceneItem::Ptr &child)

virtual SceneItem::Ptr	createGroup (const Selection &selection, const PathComponent &name) const =0

virtual UndoableCommand::Ptr	createGroupCmd (const Selection &selection, const PathComponent &name) const =0

virtual UndoableCommand::Ptr	reorderCmd (const Ufe::SceneItemList &orderedList) const =0

virtual bool	reorder (const Ufe::SceneItemList &orderedList)

Static Public Member Functions
static Ptr	hierarchy (const SceneItem::Ptr &item)

static SceneItem::Ptr	createItem (const Path &path)

Detailed Description

Abstract base class for scene hierarchy interface.

This base class defines the interface that run-times can implement to navigate the scene hierarchy, for a given scene item. The Hierarchy interface supports parent-child hierarchy semantics and queries, with the following characteristics:

an item has a single parent, or none if it is not in a hierarchy, or is a hierarchy root.
an item has 0 or more children. Certain DCC data models (e.g. Maya) allow objects to have multiple parents in the case of instancing. This does not affect UFE single-parent semantics. The different UFE paths to a Maya instanced object uniquely identify each instance, in exact correspondence to how a Maya MDagPath uniquely identifies the instance to Maya.

To avoid the memory-consuming "one proxy object per scene object" approach, Hierarchy interface objects should be obtained and used within a local scope, and not stored. Hierarchy interfaces should be considered stateless, and can be bound to new selection items.

Definition at line 89 of file hierarchy.h.

Member Typedef Documentation

◆ ChildFilter

typedef std::list<ChildFilterFlag> Ufe::Hierarchy::ChildFilter

Definition at line 93 of file hierarchy.h.

◆ Ptr

typedef std::shared_ptr<Hierarchy> Ufe::Hierarchy::Ptr

Definition at line 92 of file hierarchy.h.

Constructor & Destructor Documentation

◆ Hierarchy() [1/2]

Ufe::Hierarchy::Hierarchy ( )

Constructor.

◆ Hierarchy() [2/2]

Ufe::Hierarchy::Hierarchy ( const Hierarchy & )

default

Default copy constructor.

◆ ~Hierarchy()

virtual Ufe::Hierarchy::~Hierarchy ( )

virtual

Destructor.

Member Function Documentation

◆ appendChildCmd()

InsertChildCommand::Ptr Ufe::Hierarchy::appendChildCmd ( const SceneItem::Ptr & child )

inline

Create a command to remove the argument child from its existing parent, and append it as a child of this SceneItem. Because of name uniqueness, the child may be renamed. The command is not executed.

Parameters

child Child item to be appended.

Returns: Command whose execution will reparent the child.

Definition at line 170 of file hierarchy.h.

◆ children()

virtual SceneItemList Ufe::Hierarchy::children ( ) const

pure virtual

Returns: Ordered list of children for this Hierarchy's SceneItem.

◆ createGroup()

virtual SceneItem::Ptr Ufe::Hierarchy::createGroup	(	const Selection &	selection,
		const PathComponent &	name
	)		const

pure virtual

Create a new group object as a child of this object and move all items in the Selection under it. Returned SceneItem will be the newly created parent. The argument component is the desired name of the created group. The resulting name will be different if an existing sibling already has that name.

Parameters

selection	Items to be moved under the new group
name	Desired name of new group to create

Returns: SceneItem for the new group. Returns a null pointer on failure.

◆ createGroupCmd()

virtual UndoableCommand::Ptr Ufe::Hierarchy::createGroupCmd	(	const Selection &	selection,
		const PathComponent &	name
	)		const

pure virtual

Create a command to create a new group object as a child of this object and move all items in the Selection under it. The argument component is the desired name of the created group. The resulting name will be different if an existing sibling. The command is not executed. already has that name.

Parameters

selection	Items to be moved under the new group
name	Desired name of new group to create

Returns: Command whose execution will create a new group and move the selection under it.

◆ createItem()

static SceneItem::Ptr Ufe::Hierarchy::createItem ( const Path & path )

static

Convenience method that calls the createItem method on the hierarchy handler for the item. Note that this method does not create an object in the run-time; rather, it creates a UFE scene item for an existing run-time object. Returns a null pointer if the argument is an empty path.

Parameters

path	Path of SceneItem to create

Returns: SceneItem of argument Path

Referenced by Ufe::BaseUndoableCommand::sceneItem().

Here is the caller graph for this function:

◆ defaultParent()

virtual SceneItem::Ptr Ufe::Hierarchy::defaultParent ( ) const

pure virtual

Return the parent to which this SceneItem should be appended, if it is removed from its current parent (unparent). This will typically be the scene root, or a meaningful sub-root of a sub-hierarchy.

Returns: The SceneItem's default parent. Returns a null pointer if the item cannot be reparented to a default parent.

◆ filteredChildren()

virtual SceneItemList Ufe::Hierarchy::filteredChildren ( const ChildFilter & ) const

pure virtual

Returns: Ordered list of children filtered by input child filter for this Hierarchy's SceneItem.

◆ hasChildren()

virtual bool Ufe::Hierarchy::hasChildren ( ) const

pure virtual

Predicate to return if the SceneItem has children in the hierarchy.

Returns: True if SceneItem has children

◆ hierarchy()

static Ptr Ufe::Hierarchy::hierarchy ( const SceneItem::Ptr & item )

static

Convenience method that calls the hierarchy method on the hierarchy handler for the item. Returns a null pointer if the argument is null, or has an empty path.

Parameters

item	SceneItem to build Hierarchy on

Returns: Hierarchy of given SceneItem.

◆ insertChild()

virtual SceneItem::Ptr Ufe::Hierarchy::insertChild	(	const SceneItem::Ptr &	child,
		const SceneItem::Ptr &	pos
	)

pure virtual

Remove the argument child from its existing parent, and append it as a child of this SceneItem, inserting before SceneItem pos. If pos is a null pointer, child is appended. Because of name uniqueness, the child may be renamed.

Parameters

child	Child item to be inserted.
pos	Item before which child is to be inserted.

Returns: SceneItem for the appended child, at its new path.

◆ insertChildCmd()

virtual InsertChildCommand::Ptr Ufe::Hierarchy::insertChildCmd	(	const SceneItem::Ptr &	child,
		const SceneItem::Ptr &	pos
	)

pure virtual

Create a command to remove the argument child from its existing parent, and insert it as a child of this SceneItem, inserting before SceneItem pos. If pos is a null pointer, child is appended. Because of name uniqueness, the child may be renamed. The command is not executed.

Parameters

child	Child item to be inserted.
pos	Item before which child is to be inserted.

Returns: Command whose execution will reparent the child.

◆ parent()

virtual SceneItem::Ptr Ufe::Hierarchy::parent ( ) const

pure virtual

Returns: The SceneItem's parent. Returns a null pointer if the item is the world root, and has no parent.

◆ reorder()

virtual bool Ufe::Hierarchy::reorder ( const Ufe::SceneItemList & orderedList )

inlinevirtual

Reorder the children of this scene item. Default implementation calls reorder command and executes.

Parameters

orderedList list of already reordered children.

Returns: Command whose execution will reorder the child(s).

Definition at line 206 of file hierarchy.h.

◆ reorderCmd()

virtual UndoableCommand::Ptr Ufe::Hierarchy::reorderCmd ( const Ufe::SceneItemList & orderedList ) const

pure virtual

Create a command to reorder the children of this scene item.

Parameters

orderedList list of already reordered children.

Returns: Command whose execution will reorder the child(s).

◆ sceneItem()

virtual SceneItem::Ptr Ufe::Hierarchy::sceneItem ( ) const

pure virtual

Scene item accessor.

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

include/ufe/hierarchy.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ChildFilter

◆ Ptr

Constructor & Destructor Documentation

◆ Hierarchy() [1/2]

◆ Hierarchy() [2/2]

◆ ~Hierarchy()

Member Function Documentation

◆ appendChildCmd()

◆ children()

◆ createGroup()

◆ createGroupCmd()

◆ createItem()

◆ defaultParent()

◆ filteredChildren()

◆ hasChildren()

◆ hierarchy()

◆ insertChild()

◆ insertChildCmd()

◆ parent()

◆ reorder()

◆ reorderCmd()

◆ sceneItem()