vcg::tri::PolychordCollapse< PolyMeshType >::PC_Chords Class Reference

The PC_Chords class gives efficient access to each coord (relative to a face). More...

#include <polygon_polychord_collapse.h>

List of all members.

Public Member Functions
bool	End ()
	End says if an end has been reached.
void	GetCurrent (std::pair< size_t, unsigned char > &face_edge)
	GetCurrent returns the current FaceType pointer and edge.
void	Next ()
	Next, if it's not at the end, it goes to the next coord.
PC_Chord &	operator[] (const std::pair< size_t, unsigned char > &face_edge)
	operator [], given a face index and an offset, it returns (a reference to) its corresponding PC_Chord.
const PC_Chord &	operator[] (const std::pair< size_t, unsigned char > &face_edge) const
	operator [], given a face index and an offset, it returns (a const reference to) its corresponding PC_Chord.
std::pair< size_t, unsigned char >	operator[] (PC_Chord const *const coord)
	operator [], given a coord, it returns its corresponding face index and edge.
	PC_Chords (const PolyMeshType &mesh)
	PC_Chords constructor.
void	Reset (const PolyMeshType &mesh)
	Reset rearrages the container.
void	ResetMarks ()
	ResetMarks.
void	UpdateCoord (PC_Chord &coord, const unsigned long mark, const PC_ResultCode resultCode)
	UpdateCoord updates the coord information and links.
Private Attributes
std::vector< PC_Chord >	_Chords
PC_Chord *	_currentChord

---

Detailed Description

template<typename PolyMeshType>
class vcg::tri::PolychordCollapse< PolyMeshType >::PC_Chords

The PC_Chords class gives efficient access to each coord (relative to a face).

Definition at line 103 of file polygon_polychord_collapse.h.

---

Constructor & Destructor Documentation

template<typename PolyMeshType >

vcg::tri::PolychordCollapse< PolyMeshType >::PC_Chords::PC_Chords

(

const PolyMeshType &

mesh

)

[inline]

PC_Chords constructor.

Note:

Since each face corresponds to two chords, the actual size of the vector of chords is 2*mesh.face.size().

Parameters:

mesh

Definition at line 110 of file polygon_polychord_collapse.h.

---

Member Function Documentation

template<typename PolyMeshType >

bool vcg::tri::PolychordCollapse< PolyMeshType >::PC_Chords::End

(

)

[inline]

End says if an end has been reached.

Returns:

true if an end has been reached, false otherwise.

Definition at line 249 of file polygon_polychord_collapse.h.

template<typename PolyMeshType >

void vcg::tri::PolychordCollapse< PolyMeshType >::PC_Chords::GetCurrent

(

std::pair< size_t, unsigned char > &

face_edge

)

[inline]

GetCurrent returns the current FaceType pointer and edge.

Parameters:

face_edge

A std::pair where to store the FaceType pointer and the edge index.

Definition at line 235 of file polygon_polychord_collapse.h.

template<typename PolyMeshType >

void vcg::tri::PolychordCollapse< PolyMeshType >::PC_Chords::Next

(

)

[inline]

Next, if it's not at the end, it goes to the next coord.

Definition at line 226 of file polygon_polychord_collapse.h.

template<typename PolyMeshType >

PC_Chord& vcg::tri::PolychordCollapse< PolyMeshType >::PC_Chords::operator[]

(

const std::pair< size_t, unsigned char > &

face_edge

)

[inline]

operator [], given a face index and an offset, it returns (a reference to) its corresponding PC_Chord.

Parameters:

face_edge

A std::pair<size_t, unsigned char>(face_index, offset). The offset should be 0 or 1.

Returns:

A reference to the corresponding PC_Chord.

Definition at line 181 of file polygon_polychord_collapse.h.

template<typename PolyMeshType >

const PC_Chord& vcg::tri::PolychordCollapse< PolyMeshType >::PC_Chords::operator[]

(

const std::pair< size_t, unsigned char > &

face_edge

)

const [inline]

operator [], given a face index and an offset, it returns (a const reference to) its corresponding PC_Chord.

Parameters:

face_edge

A std::pair<size_t, unsigned char>(face_index, offset). The offset should be 0 or 1.

Returns:

A reference to the corresponding PC_Chord.

Definition at line 190 of file polygon_polychord_collapse.h.

template<typename PolyMeshType >

std::pair<size_t, unsigned char> vcg::tri::PolychordCollapse< PolyMeshType >::PC_Chords::operator[]

(

PC_Chord const *const

coord

)

[inline]

operator [], given a coord, it returns its corresponding face index and edge.

Parameters:

coord

The coord pointer.

Returns:

A std::pair <size_t, unsigned char>(face_index, offset) with offset being 0 or 1.

Definition at line 200 of file polygon_polychord_collapse.h.

template<typename PolyMeshType >

void vcg::tri::PolychordCollapse< PolyMeshType >::PC_Chords::Reset

(

const PolyMeshType &

mesh

)

[inline]

Reset rearrages the container.

Note:

Since each face corresponds to two chords, the actual size of the vector of chords is 2*mesh.face.size().

Parameters:

mesh

Definition at line 127 of file polygon_polychord_collapse.h.

template<typename PolyMeshType >

void vcg::tri::PolychordCollapse< PolyMeshType >::PC_Chords::ResetMarks

(

)

[inline]

ResetMarks.

Definition at line 117 of file polygon_polychord_collapse.h.

template<typename PolyMeshType >

void vcg::tri::PolychordCollapse< PolyMeshType >::PC_Chords::UpdateCoord	(	PC_Chord &	coord,
		const unsigned long	mark,
		const PC_ResultCode	resultCode
	)		[inline]

UpdateCoord updates the coord information and links.

Parameters:

coord	The coord to update.
mark	The mark of the polychord.
resultCode	The code for the type of the polychord.

Definition at line 211 of file polygon_polychord_collapse.h.

---

Member Data Documentation

template<typename PolyMeshType >

std::vector<PC_Chord> vcg::tri::PolychordCollapse< PolyMeshType >::PC_Chords::_Chords [private]

Definition at line 254 of file polygon_polychord_collapse.h.

template<typename PolyMeshType >

PC_Chord* vcg::tri::PolychordCollapse< PolyMeshType >::PC_Chords::_currentChord [private]

Definition at line 255 of file polygon_polychord_collapse.h.

---

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

• polygon_polychord_collapse.h