NDEVR
API Documentation
VertexIterator< t_type >

Typed vertex iterator providing array-style access to geometry vertex data. More...

Inheritance diagram for VertexIterator< t_type >:
[legend]
Collaboration diagram for VertexIterator< t_type >:
[legend]

Public Member Functions

 VertexIterator (const StringView &vertex_property, Geometry geo)
 Constructs a typed iterator for a named custom vertex property.
 VertexIterator (VertexProperty vertex_property, Geometry geo)
 Constructs a typed iterator for a standard vertex property.
t_type operator[] (uint04 index) const
 Array-style access to a vertex value.
Public Member Functions inherited from VertexLookup
 VertexLookup ()
 Default constructor creating an empty lookup.
 VertexLookup (const StringView &vertex_property, Geometry geo)
 Constructs a lookup for a named custom vertex property.
 VertexLookup (VertexProperty vertex_property, Geometry geo)
 Constructs a lookup for a standard vertex property.
BitFlag flag (uint04 index) const
 Retrieves the vertex flags at the given index.
template<class t_type>
t_type get (uint04 index) const
 Retrieves a vertex value at the given index.
void setFlag (uint04 index, const BitFlag &value)
 Sets the flag value for a vertex, creating the flag column if necessary.
template<class t_type>
void setVertex (uint04 index, const t_type &value)
 Sets a vertex value at the given index.
uint04 size () const
 Returns the number of vertices available for iteration.
void swap (uint04 a, uint04 b)
 Swaps two vertex entries in the column.

Additional Inherited Members

Public Attributes inherited from VertexLookup
TableColumnm_column
 Pointer to the vertex data column.
TableColumnm_flag_column
 Pointer to the vertex flag column (may be nullptr).
Geometry m_geo
 The geometry being iterated.
uint04 m_vertex_count
 The number of vertices in this geometry.
uint04 m_vertex_offset
 The offset of this geometry's vertices in the shared table.
VertexProperty m_vertex_property
 The vertex property being accessed.

Detailed Description

template<class t_type>
class VertexIterator< t_type >

Typed vertex iterator providing array-style access to geometry vertex data.


Definition at line 2565 of file Geometry.h.

Constructor & Destructor Documentation

◆ VertexIterator() [1/2]

template<class t_type>
VertexIterator< t_type >::VertexIterator ( VertexProperty vertex_property,
Geometry geo )
inline

Constructs a typed iterator for a standard vertex property.

Parameters
[in]vertex_propertyThe vertex property to iterate.
[in]geoThe geometry to iterate over.

Definition at line 2574 of file Geometry.h.

References VertexLookup::VertexLookup().

◆ VertexIterator() [2/2]

template<class t_type>
VertexIterator< t_type >::VertexIterator ( const StringView & vertex_property,
Geometry geo )
inline

Constructs a typed iterator for a named custom vertex property.

Parameters
[in]vertex_propertyThe property name.
[in]geoThe geometry to iterate over.

Definition at line 2581 of file Geometry.h.

References VertexLookup::VertexLookup().

Member Function Documentation

◆ operator[]()

template<class t_type>
t_type VertexIterator< t_type >::operator[] ( uint04 index) const
inline

Array-style access to a vertex value.

Parameters
[in]indexThe vertex index.
Returns
The vertex value at the given index.

Definition at line 2588 of file Geometry.h.

References VertexLookup::get().


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