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

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

#include <hierarchyHandler.h>

Public Types

typedef std::shared_ptr< HierarchyHandlerPtr
 

Public Member Functions

 HierarchyHandler ()
 Constructor. More...
 
 HierarchyHandler (const HierarchyHandler &)=default
 Default copy constructor. More...
 
virtual ~HierarchyHandler ()
 Destructor. More...
 
virtual Hierarchy::Ptr hierarchy (const SceneItem::Ptr &item) const =0
 
virtual SceneItem::Ptr createItem (const Path &path) const =0
 

Detailed Description

Factory base class for scene hierarchy interface.

This base class defines an interface for factory objects that run-times can implement to create a scene hierarchy interface object.

Definition at line 26 of file hierarchyHandler.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 29 of file hierarchyHandler.h.

Constructor & Destructor Documentation

◆ HierarchyHandler() [1/2]

Ufe::HierarchyHandler::HierarchyHandler ( )

Constructor.

◆ HierarchyHandler() [2/2]

Ufe::HierarchyHandler::HierarchyHandler ( const HierarchyHandler )
default

Default copy constructor.

◆ ~HierarchyHandler()

virtual Ufe::HierarchyHandler::~HierarchyHandler ( )
virtual

Destructor.

Member Function Documentation

◆ createItem()

virtual SceneItem::Ptr Ufe::HierarchyHandler::createItem ( const Path path) const
pure virtual
Parameters
pathPath of item to create
Returns
SceneItem for the given Path. Returns a null pointer if no SceneItem can be created for the Path

◆ hierarchy()

virtual Hierarchy::Ptr Ufe::HierarchyHandler::hierarchy ( const SceneItem::Ptr item) const
pure virtual
Parameters
itemSceneItem to use for the hierarchy
Returns
Hierarchy interface of given SceneItem. Returns a null pointer if no Hierarchy interface can be created for the argument SceneItem

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