Ufe::GlobalSelection Namespace Reference

Typedefs
typedef std::shared_ptr< ObservableSelection >	Ptr

Functions
void	initializeInstance (const Ptr &globalSelection)
const Ptr &	get ()

Typedef Documentation

Ptr

typedef std::shared_ptr<ObservableSelection> Ufe::GlobalSelection::Ptr

Definition at line 35 of file globalSelection.h.

Function Documentation

get()

const Ptr & Ufe::GlobalSelection::get

(

)

Returns

The global observable selection

initializeInstance()

void Ufe::GlobalSelection::initializeInstance

(

const Ptr &

globalSelection

)

Initialize the observable selection singleton. This selection is useful for applications where user operations are done on a single selection that is shared by all viewers and editors. Initializing the global selection should be done on startup, and for proper selection lifescope management should be cleared with a null pointer on exit. If the current global selection is non-null, the argument must be null, to prevent initializing the global selection more than once.

Parameters

globalSelection

The single global selection for the application.

Exceptions

std::invalid_argument

if the argument and current global selection are both non-null.