FreeCAD C++
List of all members
MeshCore::MeshFacetIterator Class Reference

#include <Mod/Mesh/App/Core/Iterator.h>

Detailed Description

The MeshFacetIterator allows to iterate over the facets that hold the topology of the mesh and provides access to their geometric information.

Public Member Functions

Construction
 MeshFacetIterator (const MeshKernel &rclM)
 construction
 
 MeshFacetIterator (const MeshKernel &rclM, unsigned long ulPos)
 construction
 
 MeshFacetIterator (const MeshFacetIterator &rclI)
 construction
 
Transformation
void Transform (const Base::Matrix4D &rclTrf)
 Transforms the returned facet points with the current transformation.
 
Access methods
const MeshGeomFacetoperator * (void)
 Access to the element the iterator points to.
 
const MeshGeomFacetoperator-> (void)
 Access to the element the iterator points to.
 
const MeshFacetIteratoroperator++ (void)
 
const MeshFacetIteratoroperator -- (void)
 
const MeshFacetIteratoroperator+= (int k)
 Increments the iterator by k positions.
 
const MeshFacetIteratoroperator -= (int k)
 Decrements the iterator by k positions.
 
MeshFacetIteratoroperator= (const MeshFacetIterator &rpI)
 Assignment.
 
bool operator< (const MeshFacetIterator &rclI) const
 Compares if this iterator points to a lower element than the other one.
 
bool operator > (const MeshFacetIterator &rclI) const
 Compares if this iterator points to a higher element than the other one.
 
bool operator== (const MeshFacetIterator &rclI) const
 Checks if the iterators points to the same element.
 
void Begin (void)
 Sets the iterator to the beginning of the array.
 
void End (void)
 Sets the iterator to the end of the array.
 
unsigned long Position (void) const
 Returns the current position of the iterator in the array.
 
bool EndReached (void) const
 Checks if the end is already reached.
 
void Init (void)
 Sets the iterator to the beginning of the array.
 
bool More (void) const
 Checks if the end is not yet reached.
 
void Next (void)
 Increments the iterator.
 
bool Set (unsigned long ulIndex)
 Sets the iterator to a given position.
 
MeshFacet GetIndices (void) const
 Returns the topologic facet.
 
const MeshFacetGetReference (void) const
 Returns the topologic facet.
 
void GetNeighbours (MeshFacetIterator &rclN0, MeshFacetIterator &rclN1, MeshFacetIterator &rclN2) const
 Returns iterators pointing to the current facet's neighbours.
 
void SetToNeighbour (unsigned short usN)
 Sets the iterator to the current facet's neighbour of the side usN.
 
unsigned long GetProperty (void) const
 Returns the property information to the current facet.
 
bool IsValid (void) const
 Checks if the iterator points to a valid element inside the array.
 
Flag state
void SetFlag (MeshFacet::TFlagType tF) const
 
void ResetFlag (MeshFacet::TFlagType tF) const
 
bool IsFlag (MeshFacet::TFlagType tF) const
 
void SetProperty (unsigned long uP) const
 

Member Function Documentation

◆ operator --()

const MeshFacetIterator& MeshCore::MeshFacetIterator::operator -- ( void  )

Decrements the iterator. It points then to the previous element if the beginning is not reached.

◆ operator++()

const MeshFacetIterator& MeshCore::MeshFacetIterator::operator++ ( void  )

Increments the iterator. It points then to the next element if the end is not reached.