rename get_tds_data=>tds_data + more detail in the doc

This commit is contained in:
Clement Jamin 2014-03-26 16:54:14 +01:00
parent 737215505a
commit b7cfd3928f
3 changed files with 18 additions and 7 deletions

View File

@ -153,18 +153,29 @@ a vertex of the `c`.
*/ */
int index(Vertex_handle v) const; int index(Vertex_handle v) const;
/// \name Internal
/// \cgalAdvancedBegin
/// These functions are used internally by the triangulation data
/// structure. The user is not encouraged to use them directly as they
/// may change in the future.
/// \cgalAdvancedEnd
/// @{
/*! /*!
Returns the data member of Returns the data member of
type `TDS_data`. It is typically used to mark the full cell as <I>visited</I> type `TDS_data`. It is typically used to mark the full cell as <I>visited</I>
during operations on a `TriangulationDataStructure`. during operations on a `TriangulationDataStructure`.
*/ */
const TDS_data & get_tds_data() const; const TDS_data & tds_data() const;
/*! /*!
Same as above, but returns a reference to Same as above, but returns a reference to
a non-`const` object. a non-`const` object.
*/ */
TDS_data & get_tds_data(); TDS_data & tds_data();
/// @}
/*! /*!
\cgalAdvanced Returns a handle to the mirror vertex of the `i`-th vertex of full cell \cgalAdvanced Returns a handle to the mirror vertex of the `i`-th vertex of full cell

View File

@ -398,7 +398,7 @@ private:
template< typename FCH > // FCH = Full_cell_[const_]handle template< typename FCH > // FCH = Full_cell_[const_]handle
bool get_visited(FCH c) const bool get_visited(FCH c) const
{ {
return c->get_tds_data().is_visited(); return c->tds_data().is_visited();
} }
// NOT DOCUMENTED // NOT DOCUMENTED
@ -406,9 +406,9 @@ private:
void set_visited(FCH c, bool m) const void set_visited(FCH c, bool m) const
{ {
if( m ) if( m )
c->get_tds_data().mark_visited(); c->tds_data().mark_visited();
else else
c->get_tds_data().clear_visited(); c->tds_data().clear_visited();
} }
public: public:

View File

@ -201,8 +201,8 @@ public:
combinatorics_.swap_vertices(d1, d2); combinatorics_.swap_vertices(d1, d2);
} }
const TDS_data & get_tds_data() const { return tds_data_; } /* Concept */ const TDS_data & tds_data() const { return tds_data_; } /* Concept */
TDS_data & get_tds_data() { return tds_data_; } /* Concept */ TDS_data & tds_data() { return tds_data_; } /* Concept */
void* for_compact_container() const { return combinatorics_.for_compact_container(); } void* for_compact_container() const { return combinatorics_.for_compact_container(); }
void* & for_compact_container() { return combinatorics_.for_compact_container(); } void* & for_compact_container() { return combinatorics_.for_compact_container(); }