BALL::VIEW::Vertex Class Reference
[Helper Base Classes for derived GeometricObject 's]

Vertex is a base class for all GeometricObject 's that have a single vertex. More...

#include <vertex1.h>

Inheritance diagram for BALL::VIEW::Vertex:

[legend]

List of all members.

Public Member Functions
Constructors
	Vertex ()
	Default Constructor.
	Vertex (const Vertex &vertex)
	Copy constructor.
Destructors
virtual	~Vertex ()
	Destructor.
virtual void	clear ()
	Explicit default initialization.
Assignment methods
void	set (const Vertex &v)
	Assignment.
const Vertex &	operator= (const Vertex &v)
	Assignment operator.
void	swap (Vertex &v)
	Swapping of vertices.
Accessors: inspectors and mutators
void	setVertex (const Vector3 &v)
	Change the vector of this vertex.
void	setVertex (const float x, const float y, const float z)
	Change the vector of this vertex.
Vector3 &	getVertex ()
	Mutable inspection of the vector of this vertex.
const Vector3 &	getVertex () const
	Non-mutable inspection of the vector of this vertex.
void	getVertex (Vector3 &v) const
	Inspection of the vector of this vertex.
void	getVertex (float &x, float &y, float &z) const
	Access the components of the vector of this vertex by using float.
void	setVertexAddress (const Vector3 &v)
	Change the vector address of this vertex to the vector address represented by the parameter v.
void	setDefaultVertexAddress ()
	Change the vector address of this vertex to the default address.
Vector3 *	getVertexAddress () const
	Access the pointer of the vector that contains the value of this vertex.
Predicates
bool	isDefaultVertexAddress () const
	Vertex address test.
debuggers and diagnostics
virtual bool	isValid () const
	Internal state and consistency self-validation.
virtual void	dump (std::ostream &s=std::cout, Size depth=0) const
	Internal value dump.

---

Detailed Description

Vertex is a base class for all GeometricObject 's that have a single vertex.

It provides the derived class with methods for accessing that vertex. Further there is the possibility to give an address to a vector Vector3 as vertex. So if the value of that given vector changes the value of this vertex changes as well. To avoid segmentation faults this vector address must be valid as long as this vertex exists.

---

Constructor & Destructor Documentation

BALL::VIEW::Vertex::Vertex

(

)

Default Constructor.

The vector of this vertex is set to (0.0, 0.0, 0.0). The vertex address is set to the address of the own vector of this vertex.

BALL::VIEW::Vertex::Vertex

(

const Vertex &

vertex

)

Copy constructor.

The vector of vertex is copied to the vector of this vertex. The vertex address of this vertex is set to the value of the vertex address of vertex vertex.

---

Member Function Documentation

virtual void BALL::VIEW::Vertex::clear

(

)

[virtual]

Explicit default initialization.

Set the vector of this vertex to the vector (0.0, 0.0, 0.0). The vertex address of this vertex is set to the address of the own vector of this vertex.

Reimplemented in BALL::VIEW::Label, and BALL::VIEW::Point.

virtual void BALL::VIEW::Vertex::dump	(	std::ostream &	s = std::cout,
		Size	depth = 0
	)			const [virtual]

Internal value dump.

Dump the current state of this vertex to the output ostream s with dumping depth depth.

Parameters:

	s	output stream where to output the state of this vertex
	depth	the dumping depth

See also:

Vector3::operator <<

Reimplemented in BALL::VIEW::Label, and BALL::VIEW::Point.

void BALL::VIEW::Vertex::getVertex	(	float &	x,
		float &	y,
		float &	z
	)			const

Access the components of the vector of this vertex by using float.

See also:

setVertex

void BALL::VIEW::Vertex::getVertex

(

Vector3 &

v

)

const

Inspection of the vector of this vertex.

See also:

setVertex

const Vector3& BALL::VIEW::Vertex::getVertex

(

)

const

Non-mutable inspection of the vector of this vertex.

For further information see getVertex.

Vector3& BALL::VIEW::Vertex::getVertex

(

)

Mutable inspection of the vector of this vertex.

See also:

setVertex

Vector3* BALL::VIEW::Vertex::getVertexAddress

(

)

const

Access the pointer of the vector that contains the value of this vertex.

See also:

setVertexAddress

bool BALL::VIEW::Vertex::isDefaultVertexAddress

(

)

const

Vertex address test.

Tests if the vertex address of this vertex points to the vector of this vertex.

See also:

setVertexAddress

getVertexAddress

setDefaultVertexAddress

virtual bool BALL::VIEW::Vertex::isValid

(

)

const [virtual]

Internal state and consistency self-validation.

Calls Vector3::isValid

Reimplemented in BALL::VIEW::Label, and BALL::VIEW::Point.

const Vertex& BALL::VIEW::Vertex::operator=

(

const Vertex &

v

)

Assignment operator.

Calls set. The vector and the vertex address of this vertex is initialized to the vector and the vertex address of the vertex v.

void BALL::VIEW::Vertex::set

(

const Vertex &

v

)

Assignment.

The vector and the vertex address of this vertex is initialized to the vector and vertex address of the vertex v.

void BALL::VIEW::Vertex::setDefaultVertexAddress

(

)

Change the vector address of this vertex to the default address.

This method resets the vertex address to the vector address of this vertex. So the value of the vector of this vertex will no longer be ignored and all access methods will return it again. This method unhooks the object from any other objects prio connected with setVertexAddress.

See also:

setVertexAddress

void BALL::VIEW::Vertex::setVertex	(	const float	x,
		const float	y,
		const float	z
	)

Change the vector of this vertex.

See also:

getVertex

void BALL::VIEW::Vertex::setVertex

(

const Vector3 &

v

)

Change the vector of this vertex.

See also:

getVertex

void BALL::VIEW::Vertex::setVertexAddress

(

const Vector3 &

v

)

Change the vector address of this vertex to the vector address represented by the parameter v.

If a vector address is given the value of the vector of this vertex is ignored. Instead if the method getVertex (or any other access method) is called the value of the vector given by the vertex address is returned. The vector to which the vertex address points must exist and be valid as long as this vertex exists. An object that uses this method can hook itself onto another object (speaking in terms of position). If the object changes its position so the object derived from this vertex changes its position.

Parameters:

v

the new vector address of this vertex

See also:

getVertexAddress

void BALL::VIEW::Vertex::swap

(

Vertex &

v

)

Swapping of vertices.

Swap the vector and vertex address of this vertex with the vector and vertex address of the vertex v.