Ufe::CameraHandler Class Reference

Factory base class for Camera interface. More...

#include <cameraHandler.h>

Public Types
typedef std::shared_ptr< CameraHandler >	Ptr

Public Member Functions
	CameraHandler ()
	Constructor. More...
	CameraHandler (const CameraHandler &)=default
	Default copy constructor. More...
virtual	~CameraHandler ()
	Destructor. More...
virtual Camera::Ptr	camera (const SceneItem::Ptr &item) const =0
virtual Selection	find_ (const Path &path) const =0

Static Public Member Functions
static Selection	find (const Path &path)
static Selection	findAll (const Path &path)

Detailed Description

Factory base class for Camera interface.

This base class defines an interface for factory objects that runtimes can implement to create a Camera interface object.

Definition at line 27 of file cameraHandler.h.

Member Typedef Documentation

Ptr

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

Definition at line 30 of file cameraHandler.h.

Constructor & Destructor Documentation

CameraHandler() [1/2]

Ufe::CameraHandler::CameraHandler

(

)

Constructor.

CameraHandler() [2/2]

Ufe::CameraHandler::CameraHandler ( const CameraHandler &  )

default

Default copy constructor.

~CameraHandler()

virtual Ufe::CameraHandler::~CameraHandler ( )

virtual

Destructor.

Member Function Documentation

camera()

virtual Camera::Ptr Ufe::CameraHandler::camera ( const SceneItem::Ptr &  item ) const

pure virtual

Creates a Camera interface on the given SceneItem.

Parameters

item	SceneItem to use to retrieve its Camera interface.

Returns

Camera interface of given SceneItem. Returns a null pointer if no Camera interface can be created for the item.

find()

static Selection Ufe::CameraHandler::find ( const Path &  path )

static

Find cameras which are at path or descendants of path and in the scene segment of path. If path is a gateway node then search the scene segment which is an immediate child of path.

Parameters

path	Path to inclusive root of hierarchy under which cameras should be found, but only in the path's scene segment.

Returns

Selection of all cameras at or under path, in path's scene segment.

find_()

virtual Selection Ufe::CameraHandler::find_ ( const Path &  path ) const

pure virtual

Find cameras which are at path or descendants of path and in the scene segment of path. If path is a gateway node then search the scene segment which is an immediate child of path.

Parameters

path	Path to inclusive root of hierarchy under which cameras should be found, but only in the path's scene segment.

Returns

Selection of all cameras at or under path, in path's scene segment.

findAll()

static Selection Ufe::CameraHandler::findAll ( const Path &  path )

static

Find all the cameras which are at path or descendants of path.

Parameters

path	Path to search from (inclusive).

Returns

Selection of all cameras.

---

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

• common/include/ufe/cameraHandler.h