It's basically an std::vector for Objects that is itself an Object so it can be reference counted and passed around with ease. More...

#include <Collection.hpp>

Inheritance diagram for vl::Collection< T >:

Public Member Functions
	Collection (const std::vector< ref< T > > &vector)

	Collection ()

Collection &	operator= (const std::vector< ref< T > > &vector)

	operator std::vector< ref< T > > () const

void	push_back (T *data)

void	pop_back ()

void	resize (size_t size)

size_t	size () const

bool	empty () const

void	clear ()

const T *	back () const

T *	back ()

void	reserve (size_t capacity)

size_t	capacity () const

const ref< T > &	operator[] (size_t i) const

ref< T > &	operator[] (size_t i)

const T *	at (size_t i) const

T *	at (size_t i)

void	swap (Collection &other)

void	sort ()

size_t	find (T *obj) const

void	shrink ()

void	push_back (const Collection< T > &objs)

void	insert (size_t start, const Collection< T > &objs)

void	set (const Collection< T > &objs)

void	erase (size_t start, size_t count)

void	set (size_t index, T *obj)

void	insert (size_t index, T *obj)

void	erase (const T *data)

void	eraseAt (size_t index)

const std::vector< ref< T > > &	vector () const

std::vector< ref< T > > &	vector ()

Public Member Functions inherited from vl::Object
	Object ()
	Constructor. More...

	Object (const Object &other)
	Copy constructor: copies the name, ref count mutex and user data. More...

Object &	operator= (const Object &other)
	Copy operator: copies the object's name, ref count mutex and user data. More...

const std::string &	objectName () const
	The name of the object, by default set to the object's class name. More...

void	setObjectName (const char *name)
	The name of the object, by default set to the object's class name in debug builds. More...

void	setObjectName (const std::string &name)
	The name of the object, by default set to the object's class name in debug builds. More...

void	setRefCountMutex (IMutex *mutex)
	The mutex used to protect the reference counting of an Object across multiple threads. More...

IMutex *	refCountMutex ()
	The mutex used to protect the reference counting of an Object across multiple threads. More...

const IMutex *	refCountMutex () const
	The mutex used to protect the reference counting of an Object across multiple threads. More...

int	referenceCount () const
	Returns the number of references of an object. More...

void	incReference () const
	Increments the reference count of an object. More...

void	decReference ()
	Decrements the reference count of an object and deletes it if both automaticDelete() is `true` the count reaches 0. More...

void	setAutomaticDelete (bool autodel_on)
	If set to true the Object is deleted when its reference count reaches 0. More...

bool	automaticDelete () const
	If set to true the Object is deleted when its reference count reaches 0. More...

template<class T >
T *	as ()
	Casts an Object to the specified class. More...

template<class T >
const T *	as () const
	Casts an Object to the specified class. More...

Static Public Attributes
static const size_t	not_found = size_t( -1 )

Static Protected Member Functions
static bool	less (const ref< T > &a, const ref< T > &b)

Protected Attributes
std::vector< ref< T > >	mVector

Protected Attributes inherited from vl::Object
std::string	mObjectName

IMutex *	mRefCountMutex

int	mReferenceCount

bool	mAutomaticDelete

Additional Inherited Members
Protected Member Functions inherited from vl::Object
virtual	~Object ()

Detailed Description

template<typename T>
class vl::Collection< T >

It's basically an std::vector for Objects that is itself an Object so it can be reference counted and passed around with ease.

It has also handy utility functions like sort(), find(), etc. Handy alternative to std::vector< ref< Object > > which becomes Collection<Object>.

Definition at line 49 of file Collection.hpp.

Constructor & Destructor Documentation

◆ Collection() [1/2]

template<typename T>

vl::Collection< T >::Collection ( const std::vector< ref< T > > & vector )

inline

Definition at line 57 of file Collection.hpp.

◆ Collection() [2/2]

template<typename T>

vl::Collection< T >::Collection ( )

inline

Definition at line 63 of file Collection.hpp.

Member Function Documentation

◆ at() [1/2]

template<typename T>

const T* vl::Collection< T >::at ( size_t i ) const

inline

Definition at line 103 of file Collection.hpp.

Referenced by vl::TrackballManipulator::adjustView(), vl::ActorTreeAbstract::computeAABB(), vl::SceneManager::computeBounds(), vlX::VLXClassWrapper_Effect::export_ShaderPasses(), vl::EdgeExtractor::extractEdges(), vl::ActorTreeAbstract::extractVisibleActors(), vl::Rendering::fillRenderQueue(), vl::Rendering::render(), and vl::SceneManagerPortals::visitSector().

◆ at() [2/2]

template<typename T>

T* vl::Collection< T >::at ( size_t i )

inline

Definition at line 105 of file Collection.hpp.

◆ back() [1/2]

template<typename T>

const T* vl::Collection< T >::back ( ) const

inline

Definition at line 91 of file Collection.hpp.

◆ back() [2/2]

template<typename T>

T* vl::Collection< T >::back ( )

inline

Definition at line 93 of file Collection.hpp.

◆ capacity()

template<typename T>

size_t vl::Collection< T >::capacity ( ) const

inline

Definition at line 97 of file Collection.hpp.

◆ clear()

template<typename T>

void vl::Collection< T >::clear ( )

inline

Definition at line 89 of file Collection.hpp.

Referenced by vl::VectorGraphics::clear(), vl::VolumePlot::compute(), vl::ActorKdTree::harvestNonLeafActors(), vl::Terrain::init(), vl::RayIntersector::intersect(), vl::ActorKdTree::rebuildKdTree(), vl::Rendering::render(), and vl::Molecule::reset().

◆ empty()

template<typename T>

bool vl::Collection< T >::empty ( ) const

inline

Definition at line 87 of file Collection.hpp.

Referenced by vl::TrackballManipulator::adjustView(), and vl::Rendering::fillRenderQueue().

◆ erase() [1/2]

template<typename T>

void vl::Collection< T >::erase	(	size_t	start,
		size_t	count
	)

inline

Definition at line 145 of file Collection.hpp.

◆ erase() [2/2]

template<typename T>

void vl::Collection< T >::erase ( const T * data )

inline

Definition at line 154 of file Collection.hpp.

◆ eraseAt()

template<typename T>

void vl::Collection< T >::eraseAt ( size_t index )

inline

Definition at line 162 of file Collection.hpp.

Referenced by vl::RendererAbstract::dispatchOnRendererFinished(), vl::RendererAbstract::dispatchOnRendererStarted(), and vl::ActorTreeAbstract::eraseActor().

◆ find()

template<typename T>

size_t vl::Collection< T >::find ( T * obj ) const

inline

Definition at line 116 of file Collection.hpp.

Referenced by vl::ActorTreeAbstract::eraseActor().

◆ insert() [1/2]

template<typename T>

void vl::Collection< T >::insert	(	size_t	start,
		const Collection< T > &	objs
	)

inline

Definition at line 135 of file Collection.hpp.

◆ insert() [2/2]

template<typename T>

void vl::Collection< T >::insert	(	size_t	index,
		T *	obj
	)

inline

Definition at line 152 of file Collection.hpp.

◆ less()

template<typename T>

static bool vl::Collection< T >::less	(	const ref< T > &	a,
		const ref< T > &	b
	)

inlinestaticprotected

Definition at line 169 of file Collection.hpp.

Referenced by vl::Collection< vl::SceneManager >::sort().

◆ operator std::vector< ref< T > >()

template<typename T>

vl::Collection< T >::operator std::vector< ref< T > > ( ) const

inline

Definition at line 74 of file Collection.hpp.

◆ operator=()

template<typename T>

Collection& vl::Collection< T >::operator= ( const std::vector< ref< T > > & vector )

inline

Definition at line 68 of file Collection.hpp.

◆ operator[]() [1/2]

template<typename T>

const ref<T>& vl::Collection< T >::operator[] ( size_t i ) const

inline

Definition at line 99 of file Collection.hpp.

◆ operator[]() [2/2]

template<typename T>

ref<T>& vl::Collection< T >::operator[] ( size_t i )

inline

Definition at line 101 of file Collection.hpp.

◆ pop_back()

template<typename T>

void vl::Collection< T >::pop_back ( )

inline

Definition at line 81 of file Collection.hpp.

◆ push_back() [1/2]

template<typename T>

void vl::Collection< T >::push_back ( T * data )

inline

Definition at line 79 of file Collection.hpp.

Referenced by vl::ActorTreeAbstract::addActor(), vl::VolumePlot::compute(), vl::SceneManagerVectorGraphics::extractActors(), vl::ActorTreeAbstract::extractActors(), vl::SceneManagerPortals::extractActors(), vl::ActorTreeAbstract::extractVisibleActors(), vl::SceneManagerPortals::extractVisibleActors(), vl::ActorKdTree::harvestNonLeafActors(), vl::Terrain::init(), vl::ActorKdTree::insertActor(), vl::VectorGraphics::popScissor(), and vl::ActorKdTree::rebuildKdTree().

◆ push_back() [2/2]

template<typename T>

void vl::Collection< T >::push_back ( const Collection< T > & objs )

inline

Definition at line 130 of file Collection.hpp.

◆ reserve()

template<typename T>

void vl::Collection< T >::reserve ( size_t capacity )

inline

Definition at line 95 of file Collection.hpp.

Referenced by vl::ActorKdTree::rebuildKdTree().

◆ resize()

template<typename T>

void vl::Collection< T >::resize ( size_t size )

inline

Definition at line 83 of file Collection.hpp.

Referenced by vl::Rendering::render().

◆ set() [1/2]

template<typename T>

void vl::Collection< T >::set ( const Collection< T > & objs )

inline

Definition at line 140 of file Collection.hpp.

◆ set() [2/2]

template<typename T>

void vl::Collection< T >::set	(	size_t	index,
		T *	obj
	)

inline

Definition at line 150 of file Collection.hpp.

◆ shrink()

template<typename T>

void vl::Collection< T >::shrink ( )

inline

Definition at line 125 of file Collection.hpp.

◆ size()

template<typename T>

size_t vl::Collection< T >::size ( ) const

inline

Definition at line 85 of file Collection.hpp.

Referenced by vl::TrackballManipulator::adjustView(), vl::ActorTreeAbstract::computeAABB(), vl::SceneManager::computeBounds(), vl::RendererAbstract::dispatchOnRendererFinished(), vl::RendererAbstract::dispatchOnRendererStarted(), vl::RenderingAbstract::dispatchOnRenderingFinished(), vl::RenderingAbstract::dispatchOnRenderingStarted(), vlX::VLXClassWrapper_Effect::export_ShaderPasses(), vl::ActorTreeAbstract::extractActors(), vl::EdgeExtractor::extractEdges(), vl::ActorTreeAbstract::extractVisibleActors(), vl::Rendering::fillRenderQueue(), vl::ActorKdTree::harvestNonLeafActors(), vl::RayIntersector::intersect(), vl::ActorTreeAbstract::prepareActors(), vl::ActorKdTree::rebuildKdTree(), vl::Rendering::render(), and vl::SceneManagerPortals::visitSector().

◆ sort()

template<typename T>

void vl::Collection< T >::sort ( )

inline

Definition at line 111 of file Collection.hpp.

◆ swap()

template<typename T>

void vl::Collection< T >::swap ( Collection< T > & other )

inline

Definition at line 107 of file Collection.hpp.

Referenced by vl::Collection< vl::SceneManager >::shrink().

◆ vector() [1/2]

template<typename T>

const std::vector< ref<T> >& vl::Collection< T >::vector ( ) const

inline

Definition at line 164 of file Collection.hpp.

Referenced by vl::Collection< vl::SceneManager >::Collection(), vl::Collection< vl::SceneManager >::operator=(), and vl::ActorKdTree::rebuildKdTree().

◆ vector() [2/2]

template<typename T>

std::vector< ref<T> >& vl::Collection< T >::vector ( )

inline

Definition at line 166 of file Collection.hpp.

Member Data Documentation

◆ mVector

template<typename T>

std::vector< ref<T> > vl::Collection< T >::mVector

protected

Definition at line 172 of file Collection.hpp.

◆ not_found

template<typename T>

const size_t vl::Collection< T >::not_found = size_t( -1 )

static

Definition at line 54 of file Collection.hpp.

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

C:/git/VL/src/vlCore/Collection.hpp

Public Member Functions

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<typename T> class vl::Collection< T >

Constructor & Destructor Documentation

◆ Collection() [1/2]

◆ Collection() [2/2]

Member Function Documentation

◆ at() [1/2]

◆ at() [2/2]

◆ back() [1/2]

◆ back() [2/2]

◆ capacity()

◆ clear()

◆ empty()

◆ erase() [1/2]

◆ erase() [2/2]

◆ eraseAt()

◆ find()

◆ insert() [1/2]

◆ insert() [2/2]

◆ less()

◆ operator std::vector< ref< T > >()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ pop_back()

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ reserve()

◆ resize()

◆ set() [1/2]

◆ set() [2/2]

◆ shrink()

◆ size()

◆ sort()

◆ swap()

◆ vector() [1/2]

◆ vector() [2/2]

Member Data Documentation

◆ mVector

◆ not_found

template<typename T>
class vl::Collection< T >