ParticleEdge Class Reference

#include <ParticleEdge.h>

Inheritance diagram for ParticleEdge:

[legend]Collaboration diagram for ParticleEdge:

[legend]List of all members.

---

Detailed Description

The ParticleEdge class represents an edge between particle vertices.

Definition at line 17 of file ParticleEdge.h.

Public Member Functions
overloaded for ParticleVertex and ParticleEdge
ParticleVertex *	getVertexA () const
	get the "from" vertex of the edge
ParticleVertex *	getVertexB () const
	get the "to" vertex of the edge
ParticleEdge *	getOpposite () const
	get the opposite for the edge
ParticleEdge *	getNext () const
	get the next for the edge
ParticleEdge *	getPrevious () const
	get the previous for the edge

---

Member Function Documentation

ParticleEdge* ParticleEdge::getNext (   )  const [inline]

get the next for the edge the edge that is next in the "ring" in clockwise order Note: edge edge MUST half a next.. otherwise the mesh is invaid/non manifold example: if "this" is edge A then getNext() returns a pointer to edge B example: if "this" is edge D then getNext() returns a pointer to edge E See also: setNext() getOpposite() setOpposite() Returns: returns a pointer to the next edge Reimplemented from gmEdge. Definition at line 35 of file ParticleEdge.h. References NhalfEdge::getNext().

ParticleEdge* ParticleEdge::getOpposite (   )  const [inline]

get the opposite for the edge Note: every edge has at most one opposite. hence this structure does not support non-manifold meshes. example: if "this" is edge C then getOpposite() returns a pointer to edge D example: if "this" is edge A then getOpposite() returns NULL See also: getNext() setNext() setOpposite() Returns: returns a pointer to the Opposite edge Reimplemented from gmEdge. Definition at line 31 of file ParticleEdge.h. References NhalfEdge::getOpposite().

ParticleEdge* ParticleEdge::getPrevious (   )  const [inline]

get the previous for the edge the edge that is previous in the "ring" in clockwise order slow.. method traverses ring to get edge... Note: edge edge MUST half a previous.. otherwise the mesh is invaid/non manifold. each edge does not explicity store a pointer to its previous.. it only knows what its next is. Hence get previous is implemented by performing a series of getNext() operations, traversing around the ring of half edges example: if "this" is edge A then getNext() returns a pointer to edge C example: if "this" is edge D then getNext() returns a pointer to edge F See also: setNext() getNext() Returns: returns a pointer to the previoius edge if complete ring of clockwise edges exist Reimplemented from gmEdge. Definition at line 39 of file ParticleEdge.h. References NhalfEdge::getPrevious().

ParticleVertex* ParticleEdge::getVertexA (   )  const [inline]

get the "from" vertex of the edge Note: every edge must be connected to two vertices.. a "from" vertex (e.g. vertexA) and a "to" vertex (e.g. vertexB ) example: if "this" is edge A then getVertexA() returns a pointer to vertex 3 See also: getVertexB(); Returns: returns vertex that the edge is leaving from Reimplemented from gmEdge. Definition at line 23 of file ParticleEdge.h. References NhalfEdge::getVertexA().

ParticleVertex* ParticleEdge::getVertexB (   )  const [inline]

get the "to" vertex of the edge Note: every edge must be connected to two vertices.. a "from" vertex (e.g. vertexA) and a "to" vertex (e.g. vertexB ) example: if "this" is edge A then getVertexB() returns a pointer to vertex 1 See also: getVertexA(); Returns: returns vertex that the edge is going to Reimplemented from gmEdge. Definition at line 27 of file ParticleEdge.h. References NhalfEdge::getVertexB().

---

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

• ParticleEdge.h

---