G3D::Pointer< ValueType > Class Template Reference

#include <Pointer.h>

Classes
class	Accessor
class	FcnAccessor
class	IndirectValue
class	Interface
class	Memory
class	SharedAccessor

Public Member Functions
	Pointer ()
	Pointer (ValueType *v)
bool	isNull () const
Pointer &	operator= (const Pointer &r)
	Pointer (const Pointer &p)
template<class Class >
	Pointer (const shared_ptr< Class > &object, ValueType(Class::*getMethod)() const, void(Class::*setMethod)(ValueType))
template<class Class >
	Pointer (const shared_ptr< Class > &object, const ValueType &(Class::*getMethod)() const, void(Class::*setMethod)(ValueType))
	Pointer (ValueType(*getMethod)(), void(*setMethod)(ValueType))
	Pointer (const ValueType &(*getMethod)(), void(*setMethod)(ValueType))
template<class Class >
	Pointer (const shared_ptr< Class > &object, ValueType(Class::*getMethod)() const, void(Class::*setMethod)(const ValueType &))
template<class Class >
	Pointer (const shared_ptr< Class > &object, const ValueType &(Class::*getMethod)() const, void(Class::*setMethod)(const ValueType &))
template<class Class >
	Pointer (Class *object, const ValueType &(Class::*getMethod)() const, void(Class::*setMethod)(const ValueType &))
template<class Class >
	Pointer (Class *object, ValueType(Class::*getMethod)() const, void(Class::*setMethod)(const ValueType &))
template<class Class >
	Pointer (Class *object, const ValueType &(Class::*getMethod)() const, void(Class::*setMethod)(ValueType))
template<class Class >
	Pointer (Class *object, ValueType(Class::*getMethod)() const, void(Class::*setMethod)(ValueType))
	~Pointer ()
const ValueType	getValue () const
void	setValue (const ValueType &v)
	Assign a value to the referenced element. If this Pointer was initialized with a NULL setMethod, the call is ignored. More...
IndirectValue	operator* ()
const ValueType	operator* () const

Private Attributes
Interface *	m_interface

Detailed Description

template<typename ValueType>
class G3D::Pointer< ValueType >

Acts like a pointer to a value of type ValueType (i.e., ValueType*), but can operate through accessor methods as well as on a value in memory. This is useful for implementing scripting languages and other applications that need to connect existing APIs by reference.

Because the accessors require values to be passed by value (instead of by reference) this is primarily useful for objects whose memory size is small.

class Foo {
public:
 void setEnabled(bool b);
 bool getEnabled() const;
};

Foo f;
bool b;

Pointer<bool> p1(&b);
Pointer<bool> p2(&f, &Foo::getEnabled, &Foo::setEnabled);

*p1 = true;
*p2 = false;
*p2 = *p1; \/\/ Value assignment
p2 = p1; \/\/ Pointer aliasing

\/\/ Or, equivalently:
p1.setValue(true);
p2.setValue(false);

p2.setValue(p1.getValue());
p2 = p1;

Note: Because of the way that dereference is implemented, you cannot pass *p through a function that takes varargs (...), e.g., printf("%d", *p) will produce a compile-time error. Instead use printf("%d",(bool)*p) or printf("%d", p.getValue()).

[McGuire], GUIs for Real-time Programs, using Universal Pointers, SIGGRAPH 2008 Poster.

Constructor & Destructor Documentation

template<typename ValueType>

G3D::Pointer< ValueType >::Pointer ( )

inline

: m_interface(NULL) {};

template<typename ValueType>

G3D::Pointer< ValueType >::Pointer ( ValueType *  v )

inline

Allows implicit cast from real pointer

: m_interface(new Memory(v)) {}

template<typename ValueType>

G3D::Pointer< ValueType >::Pointer ( const Pointer< ValueType > &  p )

inline

 : m_interface(NULL) {
 this[0] = p;
 }

template<typename ValueType>

template<class Class >

G3D::Pointer< ValueType >::Pointer ( const shared_ptr< Class > &  object, ValueType(Class::*)() const  getMethod, void(Class::*)(ValueType)  setMethod  )

inline

Parameters

setMethod

May be NULL

 : 
 m_interface(new SharedAccessor<Class, ValueType (Class::*)() const, void (Class::*)(ValueType)>(object, getMethod, setMethod)) {}

template<typename ValueType>

template<class Class >

G3D::Pointer< ValueType >::Pointer ( const shared_ptr< Class > &  object, const ValueType &(Class::*)() const  getMethod, void(Class::*)(ValueType)  setMethod  )

inline

Parameters

setMethod

May be NULL

 : 
 m_interface(new SharedAccessor<Class, const ValueType& (Class::*)() const, void (Class::*)(ValueType)>(object, getMethod, setMethod)) {}

template<typename ValueType>

G3D::Pointer< ValueType >::Pointer ( ValueType(*)()  getMethod, void(*)(ValueType)  setMethod  )

inline

Parameters

setMethod

May be NULL

 : 
 m_interface(new FcnAccessor<ValueType (*)(), void (*)(ValueType)>(getMethod, setMethod)) {}

template<typename ValueType>

G3D::Pointer< ValueType >::Pointer ( const ValueType &(*)()  getMethod, void(*)(ValueType)  setMethod  )

inline

Parameters

setMethod

May be NULL

 : 
 m_interface(new FcnAccessor<const ValueType& (*)(), void (*)(ValueType)>(getMethod, setMethod)) {}

template<typename ValueType>

template<class Class >

G3D::Pointer< ValueType >::Pointer ( const shared_ptr< Class > &  object, ValueType(Class::*)() const  getMethod, void(Class::*)(const ValueType &)  setMethod  )

inline

Parameters

setMethod

May be NULL

 : 
 m_interface(new SharedAccessor<Class, ValueType (Class::*)() const, void (Class::*)(const ValueType&)>(object, getMethod, setMethod)) {}

template<typename ValueType>

template<class Class >

G3D::Pointer< ValueType >::Pointer ( const shared_ptr< Class > &  object, const ValueType &(Class::*)() const  getMethod, void(Class::*)(const ValueType &)  setMethod  )

inline

Parameters

setMethod

May be NULL

 : 
 m_interface(new SharedAccessor<Class, const ValueType& (Class::*)() const, void (Class::*)(const ValueType&)>(object, getMethod, setMethod)) {}

template<typename ValueType>

template<class Class >

G3D::Pointer< ValueType >::Pointer ( Class *  object, const ValueType &(Class::*)() const  getMethod, void(Class::*)(const ValueType &)  setMethod  )

inline

Parameters

setMethod

May be NULL

 : 
 m_interface(new Accessor<Class, const ValueType& (Class::*)() const, void (Class::*)(const ValueType&)>(object, getMethod, setMethod)) {}

template<typename ValueType>

template<class Class >

G3D::Pointer< ValueType >::Pointer ( Class *  object, ValueType(Class::*)() const  getMethod, void(Class::*)(const ValueType &)  setMethod  )

inline

Parameters

setMethod

May be NULL

 : 
 m_interface(new Accessor<Class, ValueType (Class::*)() const, void (Class::*)(const ValueType&)>(object, getMethod, setMethod)) {}

template<typename ValueType>

template<class Class >

G3D::Pointer< ValueType >::Pointer ( Class *  object, const ValueType &(Class::*)() const  getMethod, void(Class::*)(ValueType)  setMethod  )

inline

Parameters

setMethod

May be NULL

 : 
 m_interface(new Accessor<Class, const ValueType& (Class::*)() const, void (Class::*)(ValueType)>(object, getMethod, setMethod)) {}

template<typename ValueType>

template<class Class >

G3D::Pointer< ValueType >::Pointer ( Class *  object, ValueType(Class::*)() const  getMethod, void(Class::*)(ValueType)  setMethod  )

inline

Parameters

setMethod

May be NULL

 : 
 m_interface(new Accessor<Class, ValueType (Class::*)() const, void (Class::*)(ValueType)>(object, getMethod, setMethod)) {}

template<typename ValueType>

G3D::Pointer< ValueType >::~Pointer ( )

inline

 {
 delete m_interface;
 }

Member Function Documentation

template<typename ValueType>

const ValueType G3D::Pointer< ValueType >::getValue ( ) const

inline

 {
 debugAssert(m_interface != NULL);
 return m_interface->get();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename ValueType>

bool G3D::Pointer< ValueType >::isNull ( ) const

inline

 {
 return (m_interface == NULL) || m_interface->isNull();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename ValueType>

IndirectValue G3D::Pointer< ValueType >::operator* ( )

inline

 {
 return IndirectValue(this);
 }

template<typename ValueType>

const ValueType G3D::Pointer< ValueType >::operator* ( ) const

inline

 {
 return getValue();
 }

Here is the call graph for this function:

template<typename ValueType>

Pointer& G3D::Pointer< ValueType >::operator= ( const Pointer< ValueType > &  r )

inline

 {
 delete m_interface;
 if (r.m_interface != NULL) {
 m_interface = r.m_interface->clone();
 } else {
 m_interface = NULL;
 }
 return this[0];
 }

Here is the call graph for this function:

template<typename ValueType>

void G3D::Pointer< ValueType >::setValue ( const ValueType &  v )

inline

Assign a value to the referenced element. If this Pointer was initialized with a NULL setMethod, the call is ignored.

 {
 debugAssert(m_interface != NULL);
 m_interface->set(v);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

template<typename ValueType>

Interface* G3D::Pointer< ValueType >::m_interface

private

---

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

• dep/g3dlite/include/G3D/Pointer.h