Blender  V3.3
Public Types | Public Member Functions | Public Attributes | Friends | List of all members
Freestyle::ViewEdge Class Reference

#include <ViewMap.h>

Inheritance diagram for Freestyle::ViewEdge:
Freestyle::Interface1D

Public Types

typedef SVertex vertex_type
 
typedef ViewEdgeInternal::edge_iterator_base< Nonconst_traits< ViewEdge * > > edge_iterator
 
typedef ViewEdgeInternal::edge_iterator_base< Const_traits< ViewEdge * > > const_edge_iterator
 
typedef ViewEdgeInternal::fedge_iterator_base< Nonconst_traits< FEdge * > > fedge_iterator
 
typedef ViewEdgeInternal::fedge_iterator_base< Const_traits< FEdge * > > const_fedge_iterator
 
typedef ViewEdgeInternal::vertex_iterator_base< Nonconst_traits< SVertex * > > vertex_iterator
 
typedef ViewEdgeInternal::vertex_iterator_base< Const_traits< SVertex * > > const_vertex_iterator
 

Public Member Functions

virtual string getExactTypeName () const
 
virtual Id getId () const
 
virtual Nature::EdgeNature getNature () const
 
 ViewEdge ()
 
 ViewEdge (ViewVertex *iA, ViewVertex *iB)
 
 ViewEdge (ViewVertex *iA, ViewVertex *iB, FEdge *iFEdgeA)
 
 ViewEdge (ViewVertex *iA, ViewVertex *iB, FEdge *iFEdgeA, FEdge *iFEdgeB, ViewShape *iShape)
 
 ViewEdge (ViewEdge &iBrother)
 
virtual ViewEdgeduplicate ()
 
virtual ~ViewEdge ()
 
ViewVertexA ()
 
ViewVertexB ()
 
FEdgefedgeA ()
 
FEdgefedgeB ()
 
ViewShapeviewShape ()
 
ViewShapeaShape ()
 
bool isClosed ()
 
unsigned getChainingTimeStamp ()
 
const ViewShapeaShape () const
 
const ViewShapebShape () const
 
vector< ViewShape * > & occluders ()
 
IdsplittingId ()
 
bool isInImage () const
 
void setA (ViewVertex *iA)
 
void setB (ViewVertex *iB)
 
void setNature (Nature::EdgeNature iNature)
 
void setFEdgeA (FEdge *iFEdge)
 
void setFEdgeB (FEdge *iFEdge)
 
void setShape (ViewShape *iVShape)
 
void setId (const Id &id)
 
void UpdateFEdges ()
 
void setaShape (ViewShape *iShape)
 
void setQI (int qi)
 
void setChainingTimeStamp (unsigned ts)
 
void AddOccluder (ViewShape *iShape)
 
void setSplittingId (Id *id)
 
void setIsInImage (bool iFlag)
 
bool intersect_2d_area (const Vec2r &iMin, const Vec2r &iMax) const
 
bool include_in_2d_area (const Vec2r &iMin, const Vec2r &iMax) const
 
real getLength2D () const
 
int qi () const
 
occluder_container::const_iterator occluders_begin () const
 
occluder_container::const_iterator occluders_end () const
 
int occluders_size () const
 
bool occluders_empty () const
 
const Polygon3roccludee () const
 
const SShapeoccluded_shape () const
 
const bool occludee_empty () const
 
Id shape_id () const
 
const SShapeshape () const
 
float shape_importance () const
 
edge_iterator ViewEdge_iterator ()
 view edge iterator More...
 
const_edge_iterator ViewEdge_iterator () const
 
fedge_iterator fedge_iterator_begin ()
 feature edge iterator More...
 
const_fedge_iterator fedge_iterator_begin () const
 
fedge_iterator fedge_iterator_last ()
 
const_fedge_iterator fedge_iterator_last () const
 
fedge_iterator fedge_iterator_end ()
 
const_fedge_iterator fedge_iterator_end () const
 
const_vertex_iterator vertices_begin () const
 embedding vertex iterator More...
 
vertex_iterator vertices_begin ()
 
const_vertex_iterator vertices_last () const
 
vertex_iterator vertices_last ()
 
const_vertex_iterator vertices_end () const
 
vertex_iterator vertices_end ()
 
virtual Interface0DIterator verticesBegin ()
 
virtual Interface0DIterator verticesEnd ()
 
virtual Interface0DIterator pointsBegin (float t=0.0f)
 
virtual Interface0DIterator pointsEnd (float t=0.0f)
 
- Public Member Functions inherited from Freestyle::Interface1D
 Interface1D ()
 
virtual ~Interface1D ()
 
virtual unsigned getTimeStamp () const
 
void setTimeStamp (unsigned iTimeStamp)
 

Public Attributes

voiduserdata
 

Friends

class ViewShape
 

Additional Inherited Members

- Protected Attributes inherited from Freestyle::Interface1D
unsigned _timeStamp
 

Detailed Description

Class defining a ViewEdge. A ViewEdge in an edge of the image graph. it connects two ViewVertex. It is made by connecting a set of FEdges.

Definition at line 898 of file ViewMap.h.

Member Typedef Documentation

◆ const_edge_iterator

Definition at line 924 of file ViewMap.h.

◆ const_fedge_iterator

Definition at line 927 of file ViewMap.h.

◆ const_vertex_iterator

Definition at line 930 of file ViewMap.h.

◆ edge_iterator

Definition at line 923 of file ViewMap.h.

◆ fedge_iterator

Definition at line 926 of file ViewMap.h.

◆ vertex_iterator

Definition at line 929 of file ViewMap.h.

◆ vertex_type

Definition at line 920 of file ViewMap.h.

Constructor & Destructor Documentation

◆ ViewEdge() [1/5]

Freestyle::ViewEdge::ViewEdge ( )
inline

Default constructor.

Definition at line 959 of file ViewMap.h.

References NULL, and userdata.

Referenced by duplicate().

◆ ViewEdge() [2/5]

Freestyle::ViewEdge::ViewEdge ( ViewVertex iA,
ViewVertex iB 
)
inline

Definition at line 973 of file ViewMap.h.

References NULL, and userdata.

◆ ViewEdge() [3/5]

Freestyle::ViewEdge::ViewEdge ( ViewVertex iA,
ViewVertex iB,
FEdge iFEdgeA 
)
inline

Definition at line 988 of file ViewMap.h.

References NULL, and userdata.

◆ ViewEdge() [4/5]

Freestyle::ViewEdge::ViewEdge ( ViewVertex iA,
ViewVertex iB,
FEdge iFEdgeA,
FEdge iFEdgeB,
ViewShape iShape 
)
inline

Definition at line 1003 of file ViewMap.h.

References NULL, UpdateFEdges(), and userdata.

◆ ViewEdge() [5/5]

Freestyle::ViewEdge::ViewEdge ( ViewEdge iBrother)
inline

Copy constructor.

Definition at line 1022 of file ViewMap.h.

References NULL, and userdata.

◆ ~ViewEdge()

virtual Freestyle::ViewEdge::~ViewEdge ( )
inlinevirtual

Destructor.

Definition at line 1049 of file ViewMap.h.

References NULL.

Member Function Documentation

◆ A()

ViewVertex* Freestyle::ViewEdge::A ( )
inline

◆ AddOccluder()

void Freestyle::ViewEdge::AddOccluder ( ViewShape iShape)
inline

Definition at line 1208 of file ViewMap.h.

◆ aShape() [1/2]

ViewShape* Freestyle::ViewEdge::aShape ( )
inline

Returns the shape that is occluded by the ViewShape to which this ViewEdge belongs to. If no object is occluded, NULL is returned.

Returns
The occluded ViewShape.

Definition at line 1099 of file ViewMap.h.

Referenced by Freestyle::Functions0D::getOccludeeF0D(), Freestyle::Functions1D::getOccludeeF1D(), Freestyle::FEdge::occluded_shape(), and Freestyle::Functions1D::GetOccludeeF1D::operator()().

◆ aShape() [2/2]

const ViewShape* Freestyle::ViewEdge::aShape ( ) const
inline

Definition at line 1119 of file ViewMap.h.

◆ B()

ViewVertex* Freestyle::ViewEdge::B ( )
inline

◆ bShape()

const ViewShape* Freestyle::ViewEdge::bShape ( ) const
inline

Definition at line 1124 of file ViewMap.h.

◆ duplicate()

virtual ViewEdge* Freestyle::ViewEdge::duplicate ( )
inlinevirtual

Cloning method.

Definition at line 1041 of file ViewMap.h.

References ViewEdge().

Referenced by Freestyle::ViewShape::ViewShape().

◆ fedge_iterator_begin() [1/2]

ViewEdge::fedge_iterator Freestyle::ViewEdge::fedge_iterator_begin ( )

feature edge iterator

Definition at line 676 of file ViewMap.cpp.

Referenced by getLength2D().

◆ fedge_iterator_begin() [2/2]

ViewEdge::const_fedge_iterator Freestyle::ViewEdge::fedge_iterator_begin ( ) const

Definition at line 681 of file ViewMap.cpp.

◆ fedge_iterator_end() [1/2]

ViewEdge::fedge_iterator Freestyle::ViewEdge::fedge_iterator_end ( )

Definition at line 696 of file ViewMap.cpp.

Referenced by getLength2D().

◆ fedge_iterator_end() [2/2]

ViewEdge::const_fedge_iterator Freestyle::ViewEdge::fedge_iterator_end ( ) const

Definition at line 701 of file ViewMap.cpp.

◆ fedge_iterator_last() [1/2]

ViewEdge::fedge_iterator Freestyle::ViewEdge::fedge_iterator_last ( )

Definition at line 686 of file ViewMap.cpp.

Referenced by getLength2D().

◆ fedge_iterator_last() [2/2]

ViewEdge::const_fedge_iterator Freestyle::ViewEdge::fedge_iterator_last ( ) const

Definition at line 691 of file ViewMap.cpp.

◆ fedgeA()

FEdge* Freestyle::ViewEdge::fedgeA ( )
inline

◆ fedgeB()

FEdge* Freestyle::ViewEdge::fedgeB ( )
inline

◆ getChainingTimeStamp()

unsigned Freestyle::ViewEdge::getChainingTimeStamp ( )
inline

Returns the time stamp of this ViewEdge.

Definition at line 1114 of file ViewMap.h.

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

◆ getExactTypeName()

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

Returns the string "ViewEdge".

Reimplemented from Freestyle::Interface1D.

Definition at line 901 of file ViewMap.h.

◆ getId()

virtual Id Freestyle::ViewEdge::getId ( ) const
inlinevirtual

Returns the Id of the vertex.

Reimplemented from Freestyle::Interface1D.

Definition at line 908 of file ViewMap.h.

Referenced by Freestyle::ViewMap::InsertViewVertex(), and Freestyle::ViewShape::SplitEdge().

◆ getLength2D()

real Freestyle::ViewEdge::getLength2D ( ) const
virtual

◆ getNature()

virtual Nature::EdgeNature Freestyle::ViewEdge::getNature ( ) const
inlinevirtual

◆ include_in_2d_area()

bool Freestyle::ViewEdge::include_in_2d_area ( const Vec2r iMin,
const Vec2r iMax 
) const
inline

◆ intersect_2d_area()

bool Freestyle::ViewEdge::intersect_2d_area ( const Vec2r iMin,
const Vec2r iMax 
) const
inline

◆ isClosed()

bool Freestyle::ViewEdge::isClosed ( )
inline

Tells whether this ViewEdge forms a closed loop or not.

Definition at line 1105 of file ViewMap.h.

◆ isInImage()

bool Freestyle::ViewEdge::isInImage ( ) const
inline

Definition at line 1139 of file ViewMap.h.

◆ occluded_shape()

const SShape * Freestyle::ViewEdge::occluded_shape ( ) const
inline

Definition at line 1801 of file ViewMap.h.

References Freestyle::ViewShape::sshape().

◆ occludee()

const Polygon3r& Freestyle::ViewEdge::occludee ( ) const
inline

Definition at line 1307 of file ViewMap.h.

References Freestyle::FEdge::aFace().

◆ occludee_empty()

const bool Freestyle::ViewEdge::occludee_empty ( ) const
inline

Definition at line 1314 of file ViewMap.h.

Referenced by Freestyle::FEdge::occludee_empty().

◆ occluders()

vector<ViewShape *>& Freestyle::ViewEdge::occluders ( )
inline

◆ occluders_begin()

occluder_container::const_iterator Freestyle::ViewEdge::occluders_begin ( ) const
inline

◆ occluders_empty()

bool Freestyle::ViewEdge::occluders_empty ( ) const
inline

Definition at line 1302 of file ViewMap.h.

Referenced by Freestyle::FEdge::occluders_empty().

◆ occluders_end()

occluder_container::const_iterator Freestyle::ViewEdge::occluders_end ( ) const
inline

◆ occluders_size()

int Freestyle::ViewEdge::occluders_size ( ) const
inline

Definition at line 1297 of file ViewMap.h.

Referenced by Freestyle::FEdge::occluders_size().

◆ pointsBegin()

Interface0DIterator Freestyle::ViewEdge::pointsBegin ( float  t = 0.0f)
virtual

Returns an Interface0DIterator to iterate over the points of this ViewEdge at a given resolution. The returned Interface0DIterator points on the first Point of the ViewEdge.

Parameters
tthe sampling value.

Reimplemented from Freestyle::Interface1D.

Definition at line 751 of file ViewMap.cpp.

References verticesBegin().

◆ pointsEnd()

Interface0DIterator Freestyle::ViewEdge::pointsEnd ( float  t = 0.0f)
virtual

Returns an Interface0DIterator to iterate over the points of this ViewEdge at a given resolution. The returned Interface0DIterator points after the last Point of the ViewEdge.

Parameters
tthe sampling value.

Reimplemented from Freestyle::Interface1D.

Definition at line 756 of file ViewMap.cpp.

References verticesEnd().

◆ qi()

int Freestyle::ViewEdge::qi ( ) const
inline

◆ setA()

void Freestyle::ViewEdge::setA ( ViewVertex iA)
inline

◆ setaShape()

void Freestyle::ViewEdge::setaShape ( ViewShape iShape)
inline

Sets the occluded ViewShape

Definition at line 1191 of file ViewMap.h.

◆ setB()

void Freestyle::ViewEdge::setB ( ViewVertex iB)
inline

◆ setChainingTimeStamp()

void Freestyle::ViewEdge::setChainingTimeStamp ( unsigned  ts)
inline

◆ setFEdgeA()

void Freestyle::ViewEdge::setFEdgeA ( FEdge iFEdge)
inline

◆ setFEdgeB()

void Freestyle::ViewEdge::setFEdgeB ( FEdge iFEdge)
inline

◆ setId()

void Freestyle::ViewEdge::setId ( const Id id)
inline

◆ setIsInImage()

void Freestyle::ViewEdge::setIsInImage ( bool  iFlag)
inline

Definition at line 1218 of file ViewMap.h.

◆ setNature()

void Freestyle::ViewEdge::setNature ( Nature::EdgeNature  iNature)
inline

◆ setQI()

void Freestyle::ViewEdge::setQI ( int  qi)
inline

Sets the quantitative invisibility value.

Definition at line 1197 of file ViewMap.h.

References qi().

◆ setShape()

void Freestyle::ViewEdge::setShape ( ViewShape iVShape)
inline

Sets the ViewShape to which this ViewEdge belongs to.

Definition at line 1176 of file ViewMap.h.

Referenced by Freestyle::ViewShape::AddEdge().

◆ setSplittingId()

void Freestyle::ViewEdge::setSplittingId ( Id id)
inline

Definition at line 1213 of file ViewMap.h.

References id.

Referenced by Freestyle::ViewShape::SplitEdge().

◆ shape()

const SShape* Freestyle::ViewEdge::shape ( ) const
inline

Definition at line 1329 of file ViewMap.h.

References Freestyle::SVertex::shape(), and Freestyle::FEdge::vertexA().

◆ shape_id()

Id Freestyle::ViewEdge::shape_id ( ) const
inline

◆ shape_importance()

float Freestyle::ViewEdge::shape_importance ( ) const
inline

Definition at line 1334 of file ViewMap.h.

References Freestyle::FEdge::shape_importance().

◆ splittingId()

Id* Freestyle::ViewEdge::splittingId ( )
inline

Definition at line 1134 of file ViewMap.h.

Referenced by Freestyle::ViewShape::SplitEdge().

◆ UpdateFEdges()

void Freestyle::ViewEdge::UpdateFEdges ( )

Sets Viewedge to this for all embedded fedges

Definition at line 817 of file ViewMap.cpp.

References ELEM, Freestyle::FEdge::nextEdge(), NULL, and Freestyle::FEdge::setViewEdge().

Referenced by Freestyle::ViewShape::SplitEdge(), and ViewEdge().

◆ vertices_begin() [1/2]

ViewEdge::vertex_iterator Freestyle::ViewEdge::vertices_begin ( )

Definition at line 712 of file ViewMap.cpp.

References Freestyle::FEdge::vertexA().

◆ vertices_begin() [2/2]

ViewEdge::const_vertex_iterator Freestyle::ViewEdge::vertices_begin ( ) const

embedding vertex iterator

Definition at line 707 of file ViewMap.cpp.

References Freestyle::FEdge::vertexA().

Referenced by Freestyle::Chain::push_viewedge_back(), and Freestyle::Chain::push_viewedge_front().

◆ vertices_end() [1/2]

ViewEdge::vertex_iterator Freestyle::ViewEdge::vertices_end ( )

Definition at line 732 of file ViewMap.cpp.

◆ vertices_end() [2/2]

ViewEdge::const_vertex_iterator Freestyle::ViewEdge::vertices_end ( ) const

◆ vertices_last() [1/2]

ViewEdge::vertex_iterator Freestyle::ViewEdge::vertices_last ( )

Definition at line 722 of file ViewMap.cpp.

References Freestyle::FEdge::vertexB().

◆ vertices_last() [2/2]

ViewEdge::const_vertex_iterator Freestyle::ViewEdge::vertices_last ( ) const

◆ verticesBegin()

Interface0DIterator Freestyle::ViewEdge::verticesBegin ( )
virtual

Returns an Interface0DIterator to iterate over the SVertex constituting the embedding of this ViewEdge. The returned Interface0DIterator points to the first SVertex of the ViewEdge.

Reimplemented from Freestyle::Interface1D.

Definition at line 737 of file ViewMap.cpp.

References ret, and Freestyle::FEdge::vertexA().

Referenced by pointsBegin().

◆ verticesEnd()

Interface0DIterator Freestyle::ViewEdge::verticesEnd ( )
virtual

Returns an Interface0DIterator to iterate over the SVertex constituting the embedding of this ViewEdge. The returned Interface0DIterator points after the last SVertex of the ViewEdge.

Reimplemented from Freestyle::Interface1D.

Definition at line 744 of file ViewMap.cpp.

References getLength2D(), ret, and Freestyle::FEdge::vertexA().

Referenced by pointsEnd().

◆ ViewEdge_iterator() [1/2]

ViewEdge::edge_iterator Freestyle::ViewEdge::ViewEdge_iterator ( )

view edge iterator

Definition at line 665 of file ViewMap.cpp.

◆ ViewEdge_iterator() [2/2]

ViewEdge::const_edge_iterator Freestyle::ViewEdge::ViewEdge_iterator ( ) const

Definition at line 670 of file ViewMap.cpp.

◆ viewShape()

ViewShape* Freestyle::ViewEdge::viewShape ( )
inline

Friends And Related Function Documentation

◆ ViewShape

friend class ViewShape
friend

Definition at line 921 of file ViewMap.h.

Member Data Documentation

◆ userdata

void* Freestyle::ViewEdge::userdata

A field that can be used by the user to store any data. This field must be reset afterwards using ResetUserData().

Definition at line 956 of file ViewMap.h.

Referenced by ViewEdge(), and Freestyle::ViewShape::ViewShape().


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