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::SceneItem Class Referenceabstract

Universal Front End abstract scene item. More...

#include <sceneItem.h>

Collaboration diagram for Ufe::SceneItem:

Public Types

typedef std::shared_ptr< SceneItemPtr
 

Public Member Functions

 SceneItem (const Path &path)
 
 SceneItem (const SceneItem &)=default
 Default copy constructor. More...
 
virtual ~SceneItem ()
 Destructor. More...
 
const Pathpath () const
 
Rtid runTimeId () const
 
virtual std::string nodeType () const =0
 
virtual bool isProperty () const
 
bool operator== (const SceneItem &rhs) const
 
bool operator!= (const SceneItem &rhs) const
 

Private Attributes

Path fPath
 

Detailed Description

Universal Front End abstract scene item.

A scene item identifies an object or 3D path in the scene, independent of its underlying run-time. It consists of a path that identifies an object in the scene.

A scene item may optionally represent a property associated with a given scene object. A property represents data associated with a single node or object. In different run-times, it is variously known as an attribute, a component, or an underworld path, but is always associated with a single node or object.

Definition at line 36 of file sceneItem.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 39 of file sceneItem.h.

Constructor & Destructor Documentation

◆ SceneItem() [1/2]

Ufe::SceneItem::SceneItem ( const Path path)

Constructor.

Parameters
pathPath of the scene item to build.

◆ SceneItem() [2/2]

Ufe::SceneItem::SceneItem ( const SceneItem )
default

Default copy constructor.

◆ ~SceneItem()

virtual Ufe::SceneItem::~SceneItem ( )
virtual

Destructor.

Member Function Documentation

◆ isProperty()

virtual bool Ufe::SceneItem::isProperty ( ) const
virtual

Return whether this scene item represents a property. The implementation in this class returns false.

Returns
true if this scene item represents a property.

◆ nodeType()

virtual std::string Ufe::SceneItem::nodeType ( ) const
pure virtual

Pure virtual method to return the type of the last node

Returns
type of node at the tail of the Path.

◆ operator!=()

bool Ufe::SceneItem::operator!= ( const SceneItem rhs) const

Unfortunately no compiler-generated default equality operators. Items are equal if their path is equal.

◆ operator==()

bool Ufe::SceneItem::operator== ( const SceneItem rhs) const

Unfortunately no compiler-generated default equality operators. Items are equal if their path is equal.

◆ path()

const Path& Ufe::SceneItem::path ( ) const
Returns
Path of the SceneItem.

◆ runTimeId()

Rtid Ufe::SceneItem::runTimeId ( ) const
Returns
Convenience to obtain the run-time ID of the Path.

Member Data Documentation

◆ fPath

Path Ufe::SceneItem::fPath
private

Definition at line 75 of file sceneItem.h.


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