Ufe::SceneItem Class Reference

Universal Front End abstract scene item. More...

#include <sceneItem.h>

Collaboration diagram for Ufe::SceneItem:

Public Types
typedef std::shared_ptr< SceneItem >	Ptr

Public Member Functions
	SceneItem (const Path &path)
	SceneItem (const SceneItem &)=default
	Default copy constructor. More...
virtual	~SceneItem ()
	Destructor. More...
const Path &	path () const
Rtid	runTimeId () const
std::string	nodeName () const
virtual std::string	nodeType () const =0
virtual std::vector< std::string >	ancestorNodeTypes () const
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 runtime. 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 runtimes, 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 37 of file sceneItem.h.

Member Typedef Documentation

Ptr

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

Definition at line 40 of file sceneItem.h.

Constructor & Destructor Documentation

SceneItem() [1/2]

Ufe::SceneItem::SceneItem

(

const Path &

path

)

Constructor.

Parameters

path	Path 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

ancestorNodeTypes()

virtual std::vector<std::string> Ufe::SceneItem::ancestorNodeTypes ( ) const

virtual

Return a list of all ancestor types (including the type of the scene item itself) in order from closest ancestor to farthest. The starting type is itself included, as the first element of the results vector. The implementation in this class returns a vector containing a single item, the nodeType of this scene item.

Returns

List of all ancestor types (including this one).

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.

nodeName()

std::string Ufe::SceneItem::nodeName

(

)

const

Returns

Convenience to return the name of the node at the tail of the Path.

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 runtime ID of the Path.

Member Data Documentation

fPath

Path Ufe::SceneItem::fPath

private

Definition at line 87 of file sceneItem.h.

---

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

• common/include/ufe/sceneItem.h