OOF2: The Manual

Name

OutOfPlaneVectorFieldIterator — Iterate over the out-of-plane components of a vector Field

C++ Synopsis

#include "engine/fieldindex.h"
class OutOfPlaneVectorFieldIterator: , public ComponentIterator {
  OutOfPlaneVectorFieldIterator(int min,
                                int max);

}

Source Files

  • SRC/engine/fieldindex.h: C++ header
  • SRC/engine/fieldindex.C: C++ source code

Description

OutOfPlaneVectorFieldIterator is the ComponentIterator for OutOfPlaneVectorFieldComponents. It is used when looping over the out-of-plane components of a TwoVectorField or ThreeVectorField Dereferencing the iterator produces an IndexP wrapping a OutOfPlaneVectorFieldIndex.

The min and max constructor arguments set the range of the iteration. min is the index of the first component and max is one more than the index of the last component.

OutOfPlaneVectorFieldIterators are created by the begin() and end() methods of OutOfPlaneVectorFieldComponents, and are not directly accessible in Python. The min and max parameters are set by the OutOfPlaneVectorFieldComponents object according to the size of the vector.