The ReferenceContainerComponent is a class that inherits from the IndexContainerComponent or PointerContainerComponent classes, depending on the STORE_INDICES template parameter. More...

#include <vclib/mesh/components/bases/reference_container_component.h>

Inheritance diagram for vcl::comp::ReferenceContainerComponent< STORE_INDICES, DerivedComponent, COMP_ID, Elem, N, ParentElemType, VERT, OPT, TTVN >:

[legend]

Protected Types
using	Base = std::conditional_t< STORE_INDICES, IndexContainerComponent< DerivedComponent, COMP_ID, Elem, N, ParentElemType, VERT, OPT, TTVN >, PointerContainerComponent< DerivedComponent, COMP_ID, Elem, N, ParentElemType, VERT, OPT, TTVN > >

Protected Member Functions
uint	size () const

Elem *	element (uint i)

const Elem *	element (uint i) const

uint	elementIndex (uint i) const

Elem *	elementMod (int i)

const Elem *	elementMod (int i) const

uint	elementIndexMod (int i) const

void	setElement (uint i, Elem *e)

void	setElement (uint i, uint ei)

void	setElement (Base::ConstIterator it, Elem *v)

void	setElement (Base::ConstIterator it, uint vi)

void	setElement (Base::ConstIndexIterator it, Elem *v)

void	setElement (Base::ConstIndexIterator it, uint vi)

void	setElementMod (int i, Elem *e)

void	setElementMod (int i, uint ei)

template<Range Rng> requires InputRange<Rng, Elem*>
void	setElements (Rng &&r)

template<Range Rng> requires InputRange<Rng, uint>
void	setElements (Rng &&r)

bool	containsElement (const Elem *e) const

bool	containsElement (uint ei) const

uint	indexOfElement (const Elem *e) const

uint	indexOfElement (uint ei) const

Base::Iterator	elementBegin ()

Base::Iterator	elementEnd ()

Base::ConstIterator	elementBegin () const

Base::ConstIterator	elementEnd () const

Base::ConstIndexIterator	elementIndexBegin () const

Base::ConstIndexIterator	elementIndexEnd () const

View< typename Base::Iterator >	elements ()

View< typename Base::ConstIterator >	elements () const

View< typename Base::ConstIndexIterator >	elementIndices () const

void	resize (uint n)

void	pushBack (Elem *e=nullptr)

void	pushBack (uint ei)

void	insert (uint i, Elem *e=nullptr)

void	insert (uint i, uint ei)

void	erase (uint i)

void	clear ()

uint	indexFromPointer (const Elem *v) const

Elem *	elemFromParent (uint vi)

const Elem *	elemFromParent (uint vi) const

Detailed Description

template<bool STORE_INDICES, typename DerivedComponent, uint COMP_ID, typename Elem, int N, typename ParentElemType, bool VERT, bool OPT, bool TTVN>
class vcl::comp::ReferenceContainerComponent< STORE_INDICES, DerivedComponent, COMP_ID, Elem, N, ParentElemType, VERT, OPT, TTVN >

The ReferenceContainerComponent is a class that inherits from the IndexContainerComponent or PointerContainerComponent classes, depending on the STORE_INDICES template parameter.

Template Parameters

STORE_INDICES	If true, the component will store indices, otherwise pointers to Elem.
DerivedComponent	The type of the Derived Component. It is used to implement the CRTP pattern.
COMP_ID	The id of the component. It is a value of the enum ComponentIDEnum, or an integer value that is not already used by any other component. It is used to identify the component at compile time.
Elem	The type of the Element of which the pointers are stored. E.g. a VertexPointers component would have VertexType as Elem.
N	The size of the container: if >= 0 the size is static, if < 0 the size is dynamic.
ParentElemType	The Parent Element type is used to get access to the Element that has the component (and, in case, to the Mesh that has the Element). If the component doesn't need to access the Element, this type can be void. Note: if the component is vertical (or optional), this type cannot be void.
VERT	Boolean that tells if the component is vertical. If the component is vertical, this parameter must be true. Note: to be vertical, this parameter must be true, and ElementType must be the type of the Element that has the component (the 'parent' Element Type).
OPT	When a component is vertical, it could be optional, that means that could be enabled/disabled at runtime. To make the component optional, this template parameter must be true.
TTVN	"Tied To Vertex Number", this boolean tells whether the component should leave liberty to control the size of the Container to the user, or it should be tied to the vertex number and changed automatically when the number of vertices changes. E.g. a AdjacentFaces component, if part of a Face element, should be tied to the vertex number of the Face, meaning that the number of face pointers should be always be the same of the number of vertices. Setting this value to true will tie the size of this container to the number of vertices.

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

vclib/core/include/vclib/mesh/components/bases/reference_container_component.h

Protected Types

Protected Member Functions

Detailed Description