Blender V4.3
Freestyle::Interface0DIterator Class Reference

#include <Interface0D.h>

Inherits Freestyle::Iterator.

Public Member Functions

 Interface0DIterator (Interface0DIteratorNested *it=nullptr)
 
 Interface0DIterator (const Interface0DIterator &it)
 
virtual ~Interface0DIterator ()
 
Interface0DIteratoroperator= (const Interface0DIterator &it)
 
virtual string getExactTypeName () const
 
Interface0Doperator* ()
 
Interface0Doperator-> ()
 
Interface0DIteratoroperator++ ()
 
Interface0DIterator operator++ (int)
 
Interface0DIteratoroperator-- ()
 
Interface0DIterator operator-- (int)
 
virtual int increment ()
 
virtual int decrement ()
 
virtual bool isBegin () const
 
virtual bool isEnd () const
 
virtual bool atLast () const
 
bool operator== (const Interface0DIterator &it) const
 
bool operator!= (const Interface0DIterator &it) const
 
float t () const
 
float u () const
 
- Public Member Functions inherited from Freestyle::Iterator
virtual ~Iterator ()
 

Protected Attributes

Interface0DIteratorNested_iterator
 

Detailed Description

Class defining an iterator over Interface0D elements. An instance of this iterator is always obtained from a 1D element.

Attention
In the scripting language, you must call
Interface0DIterator(Interface0DIteratorNested *it=nullptr)
instead of
it2 = it1
where it1 and it2 are 2 Interface0DIterator. Otherwise, incrementing it1 will also increment it2.

Definition at line 166 of file Interface0D.h.

Constructor & Destructor Documentation

◆ Interface0DIterator() [1/2]

Freestyle::Interface0DIterator::Interface0DIterator ( Interface0DIteratorNested * it = nullptr)
inline

Definition at line 168 of file Interface0D.h.

References _iterator.

◆ Interface0DIterator() [2/2]

Freestyle::Interface0DIterator::Interface0DIterator ( const Interface0DIterator & it)
inline

Copy constructor

Definition at line 174 of file Interface0D.h.

References _iterator.

◆ ~Interface0DIterator()

virtual Freestyle::Interface0DIterator::~Interface0DIterator ( )
inlinevirtual

Destructor

Definition at line 180 of file Interface0D.h.

References _iterator.

Member Function Documentation

◆ atLast()

virtual bool Freestyle::Interface0DIterator::atLast ( ) const
inlinevirtual

Returns true when the iterator is pointing to the final valid element.

Definition at line 286 of file Interface0D.h.

References _iterator, and result.

◆ decrement()

virtual int Freestyle::Interface0DIterator::decrement ( )
inlinevirtual

Decrements.

Reimplemented from Freestyle::Iterator.

Definition at line 265 of file Interface0D.h.

References _iterator.

◆ getExactTypeName()

virtual string Freestyle::Interface0DIterator::getExactTypeName ( ) const
inlinevirtual

Returns the string "Interface0DIterator".

Reimplemented from Freestyle::Iterator.

Definition at line 202 of file Interface0D.h.

References _iterator, and Freestyle::Interface0D::getExactTypeName().

◆ increment()

virtual int Freestyle::Interface0DIterator::increment ( )
inlinevirtual

Increments.

Reimplemented from Freestyle::Iterator.

Definition at line 259 of file Interface0D.h.

References _iterator.

◆ isBegin()

virtual bool Freestyle::Interface0DIterator::isBegin ( ) const
inlinevirtual

Returns true if the pointed Interface0D is the first of the 1D element containing the points over which we're iterating.

Reimplemented from Freestyle::Iterator.

Definition at line 273 of file Interface0D.h.

References _iterator.

Referenced by Freestyle::Functions0D::getFEdges(), Freestyle::Functions0D::Curvature2DAngleF0D::operator()(), Freestyle::Functions0D::VertexOrientation2DF0D::operator()(), and Freestyle::Functions0D::VertexOrientation3DF0D::operator()().

◆ isEnd()

virtual bool Freestyle::Interface0DIterator::isEnd ( ) const
inlinevirtual

Returns true if the pointed Interface0D is after the after the last point of the 1D element we're iterating from.

Reimplemented from Freestyle::Iterator.

Definition at line 280 of file Interface0D.h.

References _iterator.

Referenced by Freestyle::createStroke(), and Freestyle::Functions1D::GetSteerableViewMapDensityF1D::operator()().

◆ operator!=()

bool Freestyle::Interface0DIterator::operator!= ( const Interface0DIterator & it) const
inline

operator !=.

Definition at line 305 of file Interface0D.h.

◆ operator*()

Interface0D & Freestyle::Interface0DIterator::operator* ( )
inline

Returns a reference to the pointed Interface0D. In the scripting language, you must call "getObject()" instead using this operator.

Definition at line 215 of file Interface0D.h.

References _iterator.

Referenced by operator->().

◆ operator++() [1/2]

Interface0DIterator & Freestyle::Interface0DIterator::operator++ ( )
inline

Increments. In the scripting language, call "increment()".

Definition at line 229 of file Interface0D.h.

References _iterator.

◆ operator++() [2/2]

Interface0DIterator Freestyle::Interface0DIterator::operator++ ( int )
inline

Increments. In the scripting language, call "increment()".

Definition at line 236 of file Interface0D.h.

References _iterator, and ret.

◆ operator--() [1/2]

Interface0DIterator & Freestyle::Interface0DIterator::operator-- ( )
inline

Decrements. In the scripting language, call "decrement()".

Definition at line 244 of file Interface0D.h.

References _iterator.

◆ operator--() [2/2]

Interface0DIterator Freestyle::Interface0DIterator::operator-- ( int )
inline

Decrements. In the scripting language, call "decrement()".

Definition at line 251 of file Interface0D.h.

References _iterator, and ret.

◆ operator->()

Interface0D * Freestyle::Interface0DIterator::operator-> ( )
inline

Returns a pointer to the pointed Interface0D. Can't be called in the scripting language.

Definition at line 223 of file Interface0D.h.

References operator*().

◆ operator=()

Interface0DIterator & Freestyle::Interface0DIterator::operator= ( const Interface0DIterator & it)
inline

Operator =

Attention
In the scripting language, you must call instead of
it2 = it1
where it1 and it2 are 2 Interface0DIterator. Otherwise, incrementing it1 will also increment it2.

Definition at line 192 of file Interface0D.h.

References _iterator.

◆ operator==()

bool Freestyle::Interface0DIterator::operator== ( const Interface0DIterator & it) const
inline

operator ==.

Definition at line 299 of file Interface0D.h.

References _iterator.

◆ t()

float Freestyle::Interface0DIterator::t ( ) const
inline

Returns the curvilinear abscissa.

Definition at line 311 of file Interface0D.h.

References _iterator.

Referenced by Freestyle::Functions0D::GetCurvilinearAbscissaF0D::operator()().

◆ u()

float Freestyle::Interface0DIterator::u ( ) const
inline

Returns the point parameter in the curve 0<=u<=1.

Definition at line 317 of file Interface0D.h.

References _iterator.

Referenced by Freestyle::Functions0D::GetParameterF0D::operator()().

Member Data Documentation

◆ _iterator


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