BALL::GraphTriangle< Vertex, Edge, Face > Class Template Reference

#include <BALL/STRUCTURE/graphFace.h>

List of all members.

Public Member Functions

Constructors and Destructors
 GraphTriangle ()
 GraphTriangle (const GraphTriangle< Vertex, Edge, Face > &face, bool deep=false)
 GraphTriangle (Vertex *vertex1, Vertex *vertex2, Vertex *vertex3, Edge *edge1, Edge *edge2, Edge *edge3, Index index)
virtual ~GraphTriangle ()
Assignment
void set (const GraphTriangle< Vertex, Edge, Face > &face, bool deep=false)
GraphTriangle< Vertex, Edge,
Face > & 
operator= (const GraphTriangle< Vertex, Edge, Face > &face)
void set (Vertex *vertex1, Vertex *vertex2, Vertex *vertex3, Edge *edge1, Edge *edge2, Edge *edge3, Index index)
Accessors
void setVertex (Position i, Vertex *vertex) throw (Exception::IndexOverflow)
VertexgetVertex (Position i) const throw (Exception::IndexOverflow)
void setEdge (Position i, Edge *edge) throw (Exception::IndexOverflow)
Edge * getEdge (Position i) const throw (Exception::IndexOverflow)
void setIndex (Index index)
Index getIndex () const
bool getEdges (const Vertex *vertex, Edge *&edge1, Edge *&edge2) const
bool getEdge (const Vertex *vertex1, const Vertex *vertex2, Edge *&edge) const
Index getSimilarEdge (const Edge *edge, Edge *&similar_edge) const
Index getRelativeIndex (const Vertex *vertex) const
Index getRelativeIndex (const Edge *edge) const
Vertexthird (const Vertex *v1, const Vertex *v2) const
Edge * third (const Edge *e1, const Edge *e2) const
Edge * getOppositeEdge (const Vertex *vertex) const
VertexgetOppositeVertex (const Edge *edge) const
bool substitute (const Vertex *old_vertex, Vertex *new_vertex)
bool substitute (const Edge *old_edge, Edge *new_edge)
Predicates
virtual bool operator== (const Face &) const
virtual bool operator!= (const Face &) const
virtual bool operator*= (const Face &) const
Vertexhas (Vertex *vertex) const
Edge * has (Edge *edge) const

Protected Attributes

Vertexvertex_ [3]
Edge * edge_ [3]
Index index_

Friends

Class friends
  • class GraphVertex<Vertex,Edge,Face>;
  • class GraphEdge<Vertex,Edge,Face>;
class GraphVertex< Vertex, Edge, Face >
class GraphEdge< Vertex, Edge, Face >

Detailed Description

template<typename Vertex, typename Edge, typename Face>
class BALL::GraphTriangle< Vertex, Edge, Face >

Generic GraphTriangle Class.


Constructor & Destructor Documentation

template<typename Vertex , typename Edge , typename Face >
BALL::GraphTriangle< Vertex, Edge, Face >::GraphTriangle ( )

Default constructor. This method creates a new GraphTriangle object.

template<typename Vertex, typename Edge, typename Face>
BALL::GraphTriangle< Vertex, Edge, Face >::GraphTriangle ( const GraphTriangle< Vertex, Edge, Face > &  face,
bool  deep = false 
)

Copy constructor. Create a new GraphTriangle object from another.

Parameters:
facethe GraphTriangle object to be copied
deepif deep = false, all pointers are set to NULL (default). Otherwise the new GraphTriangle object is linked to the neighbours of the old GraphTriangle object.

References BALL::GraphTriangle< Vertex, Edge, Face >::edge_, BALL::GraphFace< Vertex, Edge, Face >::edge_, BALL::GraphTriangle< Vertex, Edge, Face >::vertex_, and BALL::GraphFace< Vertex, Edge, Face >::vertex_.

template<typename Vertex, typename Edge, typename Face>
BALL::GraphTriangle< Vertex, Edge, Face >::GraphTriangle ( Vertex vertex1,
Vertex vertex2,
Vertex vertex3,
Edge *  edge1,
Edge *  edge2,
Edge *  edge3,
Index  index 
)

Detailled constructor. Create a new GraphTriangle object from some nice objects

Parameters:
vertex1assigned to the first vertex
vertex2assigned to the second vertex
vertex3assigned to the third vertex
edge1assigned to the first edge
edge2assigned to the second edge
edge3assigned to the third edge
indexassigned to the index

References BALL::GraphFace< Vertex, Edge, Face >::edge_, and BALL::GraphFace< Vertex, Edge, Face >::vertex_.

template<typename Vertex , typename Edge , typename Face >
BALL::GraphTriangle< Vertex, Edge, Face >::~GraphTriangle ( ) [virtual]

Destructor. Destructs the GraphTriangle object.


Member Function Documentation

template<typename Vertex , typename Edge , typename Face >
Edge * BALL::GraphTriangle< Vertex, Edge, Face >::getEdge ( Position  i) const throw (Exception::IndexOverflow)

Return one of the edges of the GraphTriangle.

Parameters:
ithe relative index of the edge which should be given back. If i is greater than three, an exception is thrown.
Returns:
Edge* a pointer to the asked vertex

References BALL::GraphFace< Vertex, Edge, Face >::edge_.

template<typename Vertex, typename Edge, typename Face >
bool BALL::GraphTriangle< Vertex, Edge, Face >::getEdge ( const Vertex vertex1,
const Vertex vertex2,
Edge *&  edge 
) const

Find the edge of the GraphTriangle that belongs to the two given vertices.

Parameters:
vertex1a pointer to the first given vertex
vertex2a pointer to the second given vertex
edgea pointer to the found edge
Returns:
bool true if the edge can be found, false otherwise

References BALL::GraphFace< Vertex, Edge, Face >::edge_, and BALL::GraphFace< Vertex, Edge, Face >::vertex_.

template<typename Vertex, typename Edge, typename Face >
bool BALL::GraphTriangle< Vertex, Edge, Face >::getEdges ( const Vertex vertex,
Edge *&  edge1,
Edge *&  edge2 
) const

Find the two edges of the GraphTriangle that belong to the given vertex.

Parameters:
vertexa pointer to the given vertex
edge1a pointer to the first found edge
edge2a pointer to the second found edge
Returns:
bool true if the edges can be found, false otherwise

References BALL::GraphFace< Vertex, Edge, Face >::edge_, and BALL::GraphFace< Vertex, Edge, Face >::vertex_.

template<typename Vertex , typename Edge , typename Face >
Index BALL::GraphTriangle< Vertex, Edge, Face >::getIndex ( ) const

Return the index of the GraphTriangle.

Returns:
Index the index of the GraphTriangle

References BALL::GraphFace< Vertex, Edge, Face >::index_.

template<typename Vertex, typename Edge , typename Face >
Edge * BALL::GraphTriangle< Vertex, Edge, Face >::getOppositeEdge ( const Vertex vertex) const

Get the edge of the GraphFace which lies on the opposite side of the given vertex.

Parameters:
vertexa pointer to a vertex of the GraphTriangle
Returns:
Edge* a pointer to the opposite Edge

References BALL::GraphFace< Vertex, Edge, Face >::edge_, and BALL::GraphFace< Vertex, Edge, Face >::vertex_.

template<typename Vertex , typename Edge, typename Face >
Vertex * BALL::GraphTriangle< Vertex, Edge, Face >::getOppositeVertex ( const Edge *  edge) const

Get the vertex of the GraphFace which lies on the opposite side of the given edge.

Parameters:
edgea pointer to an edge of the GraphTriangle
Returns:
Vertex* a pointer to the opposite vertex

References BALL::GraphFace< Vertex, Edge, Face >::vertex_.

template<typename Vertex, typename Edge , typename Face >
Index BALL::GraphTriangle< Vertex, Edge, Face >::getRelativeIndex ( const Vertex vertex) const

Return the relative index of a vertex in the GraphTriangle.

Returns:
Index the relative index of the vertex

References BALL::GraphFace< Vertex, Edge, Face >::vertex_.

template<typename Vertex, typename Edge, typename Face >
Index BALL::GraphTriangle< Vertex, Edge, Face >::getRelativeIndex ( const Edge *  edge) const

Return the relative index of an edge in the GraphTriangle.

Returns:
Index the relative index of the edge

References BALL::GraphFace< Vertex, Edge, Face >::edge_.

template<typename Vertex , typename Edge, typename Face >
Index BALL::GraphTriangle< Vertex, Edge, Face >::getSimilarEdge ( const Edge *  edge,
Edge *&  similar_edge 
) const

Find the edge of the GraphFace that is similar to the given edge.

Parameters:
edgea pointer to the given edge
similar_edgea pointer to the similar edge of te GraphFace if it can be found, otherwise NULL
Returns:
Index the relative index of the similar edge if it can be found, otherwise -1

References BALL::GraphFace< Vertex, Edge, Face >::edge_.

template<typename Vertex , typename Edge , typename Face >
Vertex * BALL::GraphTriangle< Vertex, Edge, Face >::getVertex ( Position  i) const throw (Exception::IndexOverflow)

Return one of the vertices of the GraphTriangle.

Parameters:
ithe relative index of the vertex which should be given back. If i is greater than three, an exception is thrown.
Returns:
Vertex* a pointer to the asked vertex

References BALL::GraphFace< Vertex, Edge, Face >::vertex_.

template<typename Vertex, typename Edge, typename Face >
Edge * BALL::GraphTriangle< Vertex, Edge, Face >::has ( Edge *  edge) const

Test whether an edge is meber of the face.

Parameters:
edgea pointer to the edge to test
Returns:
Edge* a pointer to the edge if it exists, otherwise NULL

References BALL::GraphFace< Vertex, Edge, Face >::edge_.

template<typename Vertex, typename Edge , typename Face >
Vertex * BALL::GraphTriangle< Vertex, Edge, Face >::has ( Vertex vertex) const

Test whether a vertex is meber of the face.

Parameters:
vertexa pointer to the the vertex to test
Returns:
Vertex* a pointer to the vertex if it exists, otherwise NULL

References BALL::GraphFace< Vertex, Edge, Face >::vertex_.

template<typename Vertex , typename Edge , typename Face>
bool BALL::GraphTriangle< Vertex, Edge, Face >::operator!= ( const Face &  ) const [virtual]

Inequality operator.

Returns:
bool false

Reimplemented in BALL::RSFace, and BALL::Triangle.

template<typename Vertex , typename Edge , typename Face>
bool BALL::GraphTriangle< Vertex, Edge, Face >::operator*= ( const Face &  ) const [virtual]

Similarity operator.

Returns:
bool true

Reimplemented in BALL::RSFace, and BALL::Triangle.

template<typename Vertex, typename Edge, typename Face>
GraphTriangle< Vertex, Edge, Face > & BALL::GraphTriangle< Vertex, Edge, Face >::operator= ( const GraphTriangle< Vertex, Edge, Face > &  face)
template<typename Vertex , typename Edge , typename Face>
bool BALL::GraphTriangle< Vertex, Edge, Face >::operator== ( const Face &  ) const [virtual]

Equality operator.

Returns:
bool true

Reimplemented in BALL::RSFace, and BALL::Triangle.

template<typename Vertex, typename Edge, typename Face>
void BALL::GraphTriangle< Vertex, Edge, Face >::set ( const GraphTriangle< Vertex, Edge, Face > &  face,
bool  deep = false 
)

Assign from another GraphTriangle.

Parameters:
facethe GraphTriangle object to assign from
deepif deep = false, all pointers are set to NULL (default). Otherwise the GraphTriangle object is linked to the neighbours of the GraphTriangle object to assign from.

References BALL::GraphTriangle< Vertex, Edge, Face >::edge_, BALL::GraphFace< Vertex, Edge, Face >::edge_, BALL::GraphTriangle< Vertex, Edge, Face >::index_, BALL::GraphFace< Vertex, Edge, Face >::index_, BALL::GraphTriangle< Vertex, Edge, Face >::vertex_, and BALL::GraphFace< Vertex, Edge, Face >::vertex_.

template<typename Vertex, typename Edge, typename Face>
void BALL::GraphTriangle< Vertex, Edge, Face >::set ( Vertex vertex1,
Vertex vertex2,
Vertex vertex3,
Edge *  edge1,
Edge *  edge2,
Edge *  edge3,
Index  index 
)

Assign to a lot of nice objects

Parameters:
vertex1assigned to the first vertex
vertex2assigned to the second vertex
vertex3assigned to the third vertex
edge1assigned to the first edge
edge2assigned to the second edge
edge3assigned to the third edge
indexassigned to the index

References BALL::GraphFace< Vertex, Edge, Face >::edge_, BALL::GraphFace< Vertex, Edge, Face >::index_, and BALL::GraphFace< Vertex, Edge, Face >::vertex_.

template<typename Vertex , typename Edge, typename Face >
void BALL::GraphTriangle< Vertex, Edge, Face >::setEdge ( Position  i,
Edge *  edge 
) throw (Exception::IndexOverflow)

Set one of the edges of the GraphTriangle.

Parameters:
ithe relative index of the edge which should be set. If i is greater than three, an exception is thrown.
edgea pointer to the new edge

References BALL::GraphFace< Vertex, Edge, Face >::edge_.

template<typename Vertex , typename Edge , typename Face >
void BALL::GraphTriangle< Vertex, Edge, Face >::setIndex ( Index  index)

Set the index of the GraphTriangle.

Parameters:
indexthe new index

References BALL::GraphFace< Vertex, Edge, Face >::index_.

template<typename Vertex, typename Edge , typename Face >
void BALL::GraphTriangle< Vertex, Edge, Face >::setVertex ( Position  i,
Vertex vertex 
) throw (Exception::IndexOverflow)

Set one of the vertices of the GraphTriangle.

Parameters:
ithe relative index of the vertex which should be set. If i is greater three, an exception is thrown.
vertexa pointer to the new vertex

References BALL::GraphFace< Vertex, Edge, Face >::vertex_.

template<typename Vertex, typename Edge , typename Face >
bool BALL::GraphTriangle< Vertex, Edge, Face >::substitute ( const Vertex old_vertex,
Vertex new_vertex 
)

Substitute a vertex by an other one.

Parameters:
old_vertexthe vertex that has to be substituted
new_vertexthe new vertex
Returns:
bool true, if the vertex can be substituted, false otherwise

References BALL::GraphFace< Vertex, Edge, Face >::vertex_.

template<typename Vertex, typename Edge, typename Face >
bool BALL::GraphTriangle< Vertex, Edge, Face >::substitute ( const Edge *  old_edge,
Edge *  new_edge 
)

Substitute an edge by an other one.

Parameters:
old_edgethe edge that has to be substituted
new_edgethe new edge
Returns:
bool true, if the edge can be substituted, false otherwise

References BALL::GraphFace< Vertex, Edge, Face >::edge_.

template<typename Vertex, typename Edge, typename Face >
Edge * BALL::GraphTriangle< Vertex, Edge, Face >::third ( const Edge *  e1,
const Edge *  e2 
) const

Return a pointer to the third edge of the GraphTriangle.

Parameters:
e1a pointer to the first edge
e2a pointer to the second edge
Returns:
Edge* a pointer to the third edge

References BALL::GraphFace< Vertex, Edge, Face >::edge_.

template<typename Vertex, typename Edge , typename Face >
Vertex * BALL::GraphTriangle< Vertex, Edge, Face >::third ( const Vertex v1,
const Vertex v2 
) const

Return a pointer to the third vertex of the GraphTriangle.

Parameters:
v1a pointer to the first vertex
v2a pointer to the second vertex
Returns:
Vertex* a pointer to the third vertex

References BALL::GraphFace< Vertex, Edge, Face >::vertex_.


Friends And Related Function Documentation

template<typename Vertex, typename Edge, typename Face>
friend class GraphEdge< Vertex, Edge, Face > [friend]
template<typename Vertex, typename Edge, typename Face>
friend class GraphVertex< Vertex, Edge, Face > [friend]

Member Data Documentation

template<typename Vertex, typename Edge, typename Face>
Index BALL::GraphTriangle< Vertex, Edge, Face >::index_ [protected]