Freestyle::Interface1D Class Reference

#include <Interface1D.h>

Inherited by Freestyle::Curve, Freestyle::FEdge, Freestyle::Stroke, and Freestyle::ViewEdge.

Public Member Functions
	Interface1D ()
virtual	~Interface1D ()
virtual string	getExactTypeName () const
virtual Interface0DIterator	verticesBegin ()
virtual Interface0DIterator	verticesEnd ()
virtual Interface0DIterator	pointsBegin (float t=0.0f)
virtual Interface0DIterator	pointsEnd (float t=0.0f)
virtual real	getLength2D () const
virtual Id	getId () const
virtual Nature::EdgeNature	getNature () const
virtual uint	getTimeStamp () const
void	setTimeStamp (uint iTimeStamp)

Protected Attributes
uint	_timeStamp

Detailed Description

Base class for any 1D element.

Definition at line 134 of file Interface1D.h.

Constructor & Destructor Documentation

Interface1D()

Freestyle::Interface1D::Interface1D ( )

inline

Default constructor

Definition at line 137 of file Interface1D.h.

References _timeStamp.

~Interface1D()

virtual Freestyle::Interface1D::~Interface1D ( )

inlinevirtual

Destructor

Definition at line 143 of file Interface1D.h.

Member Function Documentation

getExactTypeName()

virtual string Freestyle::Interface1D::getExactTypeName ( ) const

inlinevirtual

Returns the string "Interface1D".

Reimplemented in Freestyle::Chain, Freestyle::Curve, Freestyle::FEdge, Freestyle::FEdgeSharp, Freestyle::FEdgeSmooth, Freestyle::Stroke, and Freestyle::ViewEdge.

Definition at line 146 of file Interface1D.h.

Referenced by Any_BPy_Interface1D_from_Interface1D().

getId()

Id Freestyle::Interface1D::getId ( ) const

virtual

Returns the Id of the 1D element.

Reimplemented in Freestyle::Curve, Freestyle::FEdge, Freestyle::Stroke, and Freestyle::ViewEdge.

Definition at line 47 of file Interface1D.cpp.

Referenced by Freestyle::createStroke().

getLength2D()

real Freestyle::Interface1D::getLength2D ( ) const

virtual

Returns the 2D length of the 1D element.

Reimplemented in Freestyle::Curve, Freestyle::FEdge, Freestyle::Stroke, and Freestyle::ViewEdge.

Definition at line 41 of file Interface1D.cpp.

Referenced by Freestyle::Predicates1D::Length2DBP1D::operator()().

getNature()

Nature::EdgeNature Freestyle::Interface1D::getNature ( ) const

virtual

Returns the nature of the 1D element.

Reimplemented in Freestyle::FEdge, and Freestyle::ViewEdge.

Definition at line 53 of file Interface1D.cpp.

References Freestyle::Nature::NO_FEATURE.

getTimeStamp()

virtual uint Freestyle::Interface1D::getTimeStamp ( ) const

inlinevirtual

Returns the time stamp of the 1D element. Mainly used for selection.

Definition at line 188 of file Interface1D.h.

References _timeStamp.

Referenced by Freestyle::Predicates1D::EqualToTimeStampUP1D::operator()().

pointsBegin()

Interface0DIterator Freestyle::Interface1D::pointsBegin ( float t = 0.0f )

virtual

Returns an iterator over the Interface1D points, pointing to the first point. The difference with verticesBegin() is that here we can iterate over points of the 1D element at a any given sampling. Indeed, for each iteration, a virtual point is created.

Parameters

t	The sampling with which we want to iterate over points of this 1D element.

Reimplemented in Freestyle::Curve, Freestyle::FEdge, Freestyle::Stroke, and Freestyle::ViewEdge.

Definition at line 29 of file Interface1D.cpp.

Referenced by Freestyle::Functions1D::DensityF1D::operator()(), Freestyle::Functions1D::GetCompleteViewMapDensityF1D::operator()(), Freestyle::Functions1D::GetDirectionalViewMapDensityF1D::operator()(), Freestyle::Functions1D::GetSteerableViewMapDensityF1D::operator()(), and Freestyle::Functions1D::GetViewMapGradientNormF1D::operator()().

pointsEnd()

Interface0DIterator Freestyle::Interface1D::pointsEnd ( float t = 0.0f )

virtual

Returns an iterator over the Interface1D points, pointing after the last point. The difference with verticesEnd() is that here we can iterate over points of the 1D element at a any given sampling. Indeed, for each iteration, a virtual point is created.

Parameters

t	The sampling with which we want to iterate over points of this 1D element.

Reimplemented in Freestyle::Curve, Freestyle::FEdge, Freestyle::Stroke, and Freestyle::ViewEdge.

Definition at line 35 of file Interface1D.cpp.

Referenced by Freestyle::Functions1D::DensityF1D::operator()(), Freestyle::Functions1D::GetCompleteViewMapDensityF1D::operator()(), Freestyle::Functions1D::GetDirectionalViewMapDensityF1D::operator()(), and Freestyle::Functions1D::GetViewMapGradientNormF1D::operator()().

setTimeStamp()

void Freestyle::Interface1D::setTimeStamp ( uint iTimeStamp )

inline

Sets the time stamp for the 1D element.

Definition at line 194 of file Interface1D.h.

References _timeStamp.

Referenced by Freestyle::Functions1D::TimeStampF1D::operator()().

verticesBegin()

Interface0DIterator Freestyle::Interface1D::verticesBegin ( )

virtual

Returns an iterator over the Interface1D vertices, pointing to the first vertex.

Reimplemented in Freestyle::Curve, Freestyle::FEdge, Freestyle::Stroke, and Freestyle::ViewEdge.

Definition at line 17 of file Interface1D.cpp.

Referenced by Freestyle::createStroke(), Freestyle::Functions1D::getOccludeeF1D(), Freestyle::Functions1D::getOccludersF1D(), Freestyle::Functions1D::getShapeF1D(), Freestyle::Functions1D::Curvature2DAngleF1D::operator()(), Freestyle::Functions1D::CurveNatureF1D::operator()(), Freestyle::Functions1D::GetOccludeeF1D::operator()(), Freestyle::Functions1D::GetOccludersF1D::operator()(), Freestyle::Functions1D::GetProjectedXF1D::operator()(), Freestyle::Functions1D::GetProjectedYF1D::operator()(), Freestyle::Functions1D::GetProjectedZF1D::operator()(), Freestyle::Functions1D::GetShapeF1D::operator()(), Freestyle::Functions1D::GetXF1D::operator()(), Freestyle::Functions1D::GetYF1D::operator()(), Freestyle::Functions1D::GetZF1D::operator()(), Freestyle::Functions1D::LocalAverageDepthF1D::operator()(), Freestyle::Functions1D::Normal2DF1D::operator()(), Freestyle::Functions1D::Orientation2DF1D::operator()(), Freestyle::Functions1D::Orientation3DF1D::operator()(), Freestyle::Functions1D::QuantitativeInvisibilityF1D::operator()(), Freestyle::Functions1D::ZDiscontinuityF1D::operator()(), Freestyle::Predicates1D::ContourUP1D::operator()(), and Freestyle::Predicates1D::WithinImageBoundaryUP1D::operator()().

verticesEnd()

Interface0DIterator Freestyle::Interface1D::verticesEnd ( )

virtual

Returns an iterator over the Interface1D vertices, pointing after the last vertex.

Reimplemented in Freestyle::Curve, Freestyle::FEdge, Freestyle::Stroke, and Freestyle::ViewEdge.

Definition at line 23 of file Interface1D.cpp.

Referenced by Freestyle::createStroke(), Freestyle::Functions1D::getOccludeeF1D(), Freestyle::Functions1D::getOccludersF1D(), Freestyle::Functions1D::getShapeF1D(), Freestyle::Functions1D::Curvature2DAngleF1D::operator()(), Freestyle::Functions1D::GetOccludeeF1D::operator()(), Freestyle::Functions1D::GetOccludersF1D::operator()(), Freestyle::Functions1D::GetProjectedXF1D::operator()(), Freestyle::Functions1D::GetProjectedYF1D::operator()(), Freestyle::Functions1D::GetProjectedZF1D::operator()(), Freestyle::Functions1D::GetShapeF1D::operator()(), Freestyle::Functions1D::GetXF1D::operator()(), Freestyle::Functions1D::GetYF1D::operator()(), Freestyle::Functions1D::GetZF1D::operator()(), Freestyle::Functions1D::LocalAverageDepthF1D::operator()(), Freestyle::Functions1D::Normal2DF1D::operator()(), Freestyle::Functions1D::Orientation2DF1D::operator()(), Freestyle::Functions1D::Orientation3DF1D::operator()(), Freestyle::Functions1D::QuantitativeInvisibilityF1D::operator()(), Freestyle::Functions1D::ZDiscontinuityF1D::operator()(), and Freestyle::Predicates1D::WithinImageBoundaryUP1D::operator()().

Member Data Documentation

_timeStamp

uint Freestyle::Interface1D::_timeStamp

protected

Definition at line 200 of file Interface1D.h.

Referenced by getTimeStamp(), Interface1D(), and setTimeStamp().

---

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

• Interface1D.h
• Interface1D.cpp