OOF2: The Manual

Name

VectorFieldIterator — Iterate over the components of a TwoVectorField or ThreeVectorField

C++ Synopsis

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

}

Source Files

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

Description

VectorFieldIterator is the ComponentIterator for VectorFieldComponents. It is used when looping over the components of a VectorField. Dereferencing the iterator produces an IndexP wrapping a VectorFieldIndex.

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.

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