OfProxy< T > Class Template Reference

Inheritance diagram for OfProxy< T >:

Public Member Functions
	OfProxy (T handle=T::s_empty_handle)
	OfProxy (const OfProxy< T > &other)
virtual	~OfProxy ()
T	get () const
T &	get ()
bool	is_valid () const
OfProxyId	get_id () const
OfProxy< T > &	operator= (const OfProxy< T > &other)
OfProxy< T > &	operator= (OfProxy< T > &&other)
bool	operator== (const OfProxy< T > &other) const
bool	operator!= (const OfProxy< T > &other) const
Public Member Functions inherited from CoreBaseObject
bool	is_kindof (const CoreBaseObject &object) const
virtual size_t	get_memory_size () const
CoreString	get_class_info_name () const
const unsigned long &	get_class_info_id () const
virtual bool	is_kindof (const CoreClassInfo &cinfo) const
virtual const CoreClassInfo &	get_class_info () const
template<class T >
T *	cast ()
template<class T >
const T *	cast () const
Public Member Functions inherited from CoreBaseType
bool	is_kindof (const CoreClassInfo &cinfo) const

Friends
template<class >
class	OfProxyListener

Additional Inherited Members
Static Public Member Functions inherited from CoreBaseObject
static const CoreClassInfo &	class_info ()
template<class T >
static T *	cast (CoreBaseObject *object)
template<class T >
static const T *	cast (const CoreBaseObject *object)

Detailed Description

template<class T>
class OfProxy< T >

After a scene assembly context is updated because of a modification of the scene, a handle of an item/plug inside this context may then be invalid. OfProxies allows to work with handles of items/plugs without being worried about updating the handle after any scene modifications.

Few words about the Of Proxies :

• The underlying handle is syncronized with the item/plug :

  • If the scene assembly context is refreshed, the handle is updated to reference the correct item/plug which can be different depending of the scene modification.
  • If the item/plug is removed, the handle doesn't reference an obsolete pointer but is set to invalid handle.
  • If the item/plug turns to real (because edited or overidden), the handle references the new item/plug generated by the graph
  • If the item/plug turns to virtual (because edit/override is cancelled), the handle references the correct item/plug

• Lifetime of a proxy is the same as the root context in which the item lives. It means that if this context is removed, the content of this proxy is then invalid.

• All the intelligence of a proxy has a memory cost. Handles should be favored as much as possible. Proxies are interesting to use when storing handles which have to be syncronized with the scene.

Constructor & Destructor Documentation

template<class T >

OfProxy< T >::OfProxy

(

T

handle = T::s_empty_handle

)

Constructor

template<class T >

OfProxy< T >::OfProxy

(

const OfProxy< T > &

other

)

Copy constructor

template<class T >

OfProxy< T >::~OfProxy ( )

virtual

Destructor

Member Function Documentation

template<class T >

OfProxyId OfProxy< T >::get_id

(

)

const

If the underlying item or plug is inside a scene assembly context, it returns an ID of this item or plug inside this context, otherwise it returns a null ID.

template<class T >

bool OfProxy< T >::operator!=

(

const OfProxy< T > &

other

)

const

Inequality operator

template<class T >

OfProxy< T > & OfProxy< T >::operator=

(

const OfProxy< T > &

other

)

Copy assignement

template<class T >

OfProxy< T > & OfProxy< T >::operator=

(

OfProxy< T > &&

other

)

Move assignement

template<class T >

bool OfProxy< T >::operator==

(

const OfProxy< T > &

other

)

const

Equality operator