Ufe::NodeDefHandler Class Reference

Base class for NodeDefHandler interface. More...

#include <nodeDefHandler.h>

Public Types
typedef std::shared_ptr< NodeDefHandler >	Ptr

Public Member Functions
	NodeDefHandler ()
	Constructor. More...
	NodeDefHandler (const NodeDefHandler &)=default
	Default copy constructor. More...
virtual	~NodeDefHandler ()
	Destructor. More...
virtual Ufe::NodeDef::Ptr	definition (const Ufe::SceneItem::Ptr &item) const =0
	Returns the node definition interface for a provided SceneItem. Returns a. More...
virtual Ufe::NodeDef::Ptr	definition (const std::string &type) const =0
	Returns the node definition interface for a provided type. Returns a nullptr. More...
virtual Ufe::NodeDefs	definitions (const std::string &category=kNodeDefCategoryAll) const =0
	Returns the available node definitions for the provided category. More...

Static Public Attributes
static constexpr char	kNodeDefCategoryAll [] = "All"

Detailed Description

Base class for NodeDefHandler interface.

This base class defines an interface for retrieving node definition interfaces.

Implementers of this class will need to provide a means of retrieving classes derived from NodeDef. A specific instance of this derived NodeDef will need to be retrievable through the definition function which can be called either by SceneItem::Ptr or by type. Additionally, all available derived NodeDef classes will need to be obtainable through the definitions function.

Definition at line 36 of file nodeDefHandler.h.

Member Typedef Documentation

Ptr

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

Definition at line 39 of file nodeDefHandler.h.

Constructor & Destructor Documentation

NodeDefHandler() [1/2]

Ufe::NodeDefHandler::NodeDefHandler

(

)

Constructor.

NodeDefHandler() [2/2]

Ufe::NodeDefHandler::NodeDefHandler ( const NodeDefHandler &  )

default

Default copy constructor.

~NodeDefHandler()

virtual Ufe::NodeDefHandler::~NodeDefHandler ( )

virtual

Destructor.

Member Function Documentation

definition() [1/2]

virtual Ufe::NodeDef::Ptr Ufe::NodeDefHandler::definition ( const std::string &  type ) const

pure virtual

Returns the node definition interface for a provided type. Returns a nullptr.

definition() [2/2]

virtual Ufe::NodeDef::Ptr Ufe::NodeDefHandler::definition ( const Ufe::SceneItem::Ptr &  item ) const

pure virtual

Returns the node definition interface for a provided SceneItem. Returns a.

definitions()

virtual Ufe::NodeDefs Ufe::NodeDefHandler::definitions ( const std::string &  category = kNodeDefCategoryAll ) const

pure virtual

Returns the available node definitions for the provided category.

Member Data Documentation

kNodeDefCategoryAll

constexpr char Ufe::NodeDefHandler::kNodeDefCategoryAll[] = "All"

staticconstexpr

Definition at line 41 of file nodeDefHandler.h.

---

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

• common/include/ufe/nodeDefHandler.h