Ocean::Rendering::SmartObjectRef< T > Class Template Reference

This class implements a smart rendering object reference. More...

#include <ObjectRef.h>

Inheritance diagram for Ocean::Rendering::SmartObjectRef< T >:

Public Member Functions
	SmartObjectRef ()
	Creates an empty smart object reference.
	SmartObjectRef (const Rendering::ObjectRef &objectRef)
	Creates a new smart object reference by a given object reference.
template<typename T2>
	SmartObjectRef (const Rendering::SmartObjectRef< T2 > &reference)
	Copies a smart object reference.
Public Member Functions inherited from Ocean::SmartObjectRef< T, Object >
	SmartObjectRef ()=default
	Creates a new SmartObjectRef with no internal object.
SmartObjectRef< T, Object > &	operator= (const SmartObjectRef< T, Object > &smartObjectRef)
	Assign operator.
void	release ()
	Releases the internal object, if any.
T *	pointer () const
	Returns a pointer to the objects that is encapsulated by this wrapper.
T *	operator-> () const
	Returns a point to the internal object if existing.
T &	operator* () const
	Returns a reference to the internal object if existing.
Public Member Functions inherited from Ocean::ObjectRef< Object >
	ObjectRef ()=default
	Creates an empty ObjectRef object.
	ObjectRef (const ObjectRef< Object > &objectRef)
	Copy constructor.
	ObjectRef (ObjectRef< Object > &&object) noexcept
	Move constructor.
	ObjectRef (Object *object)
	Creates a new ObjectRef holding a given object.
	ObjectRef (Object *object, const ReleaseCallback &releaseCallback)
	Creates a new ObjectRef holding and managing a given object.
	~ObjectRef ()
	Destructs an object reference object and releases the internal object if possible.
T2 &	force () const
	Returns a reference to the internal object forcing to a specified type.
Object *	operator-> () const
	Returns a point to the internal object if existing.
Object &	operator* () const
	Returns a reference to the internal object if existing.
bool	isUnique () const
	Returns whether there is no other object reference but this one.
bool	isNull () const
	Returns whether this object reference holds no internal object.
void	release ()
	Releases the internal object, if any.
Object *	pointer () const
	Returns a pointer to the objects that is encapsulated by this wrapper.
ObjectRef< Object > &	operator= (const ObjectRef< Object > &objectRef)
	Assign operator.
ObjectRef< Object > &	operator= (ObjectRef< Object > &&right) noexcept
	Move operator.
bool	operator== (const ObjectRef< Object > &objectRef) const
	Returns whether two object references are holds the same internal object.
bool	operator!= (const ObjectRef< Object > &objectRef) const
	Returns whether two object references are not equal.
bool	operator< (const ObjectRef< Object > &objectRef) const
	Returns whether the left object is less than the right one.
	operator bool () const
	Returns whether this object reference holds an internal object.

Additional Inherited Members
Public Types inherited from Ocean::SmartObjectRef< T, Object >
using	ReleaseCallback
	Redefinition of the release callback function defined in ObjectRef.
Public Types inherited from Ocean::ObjectRef< Object >
using	ReleaseCallback
	Definition of a release callback function.
Static Protected Member Functions inherited from Ocean::ObjectRef< Object >
static void	destroyObject (Object *object)
	Destroys the object located in the ObjectHolder object.
Protected Attributes inherited from Ocean::SmartObjectRef< T, Object >
T *	objectPointer_
	Pointer to the internal object.
Protected Attributes inherited from Ocean::ObjectRef< Object >
ObjectHolder *	objectHolder_
	Pointer to the object holder.

Detailed Description

template<typename T>
class Ocean::Rendering::SmartObjectRef< T >

This class implements a smart rendering object reference.

Template Parameters

T	Type of the derived object that has to be encapsulated by the smart reference object

Constructor & Destructor Documentation

SmartObjectRef() [1/3]

template<typename T>

Ocean::Rendering::SmartObjectRef< T >::SmartObjectRef

(

)

Creates an empty smart object reference.

SmartObjectRef() [2/3]

template<typename T>

Ocean::Rendering::SmartObjectRef< T >::SmartObjectRef

(

const Rendering::ObjectRef &

objectRef

)

Creates a new smart object reference by a given object reference.

Parameters

objectRef

Object reference to copy

SmartObjectRef() [3/3]

template<typename T>

template<typename T2>

Ocean::Rendering::SmartObjectRef< T >::SmartObjectRef

(

const Rendering::SmartObjectRef< T2 > &

reference

)

Copies a smart object reference.

Parameters

reference

Reference to copy

---

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

• rendering/ObjectRef.h