VizKit::VisualVertex Class Reference

#include <VisualVertex.h>

List of all members.

Public Member Functions
	VisualVertex (Coord coordPoint)
	VisualVertex (Coord coordPoint, VertexColor anRGBAColor)
	VisualVertex (Coord coordPoint, Coord relativeCoordPoint, VertexColor anRGBAColor)
	VisualVertex (Coord coordPoint, TexCoord texCoordPoint, VertexColor anRGBAColor)
	VisualVertex (Coord coordPoint, Coord relativeCoordPoint, TexCoord texCoordPoint, VertexColor anRGBAColor)
	VisualVertex (Coord coordPoint, Coord relativeCoordPoint, TexCoord texCoordPoint, TexCoord relTexCoordPoint, VertexColor anRGBAColor)
	VisualVertex (VertexPosition aVertexPosition, VertexColor anRGBAColor)
	~VisualVertex ()
	VisualVertex (const VisualVertex &other)
VisualVertex &	operator= (const VisualVertex &other)
void	setRelativeVertexPosition (Coord coordPoint)
void	setRelativeTexCoordPosition (TexCoord aTexCoord)
bool	colorHasBeenSet (void)
Public Attributes
VertexColor	vertexColor
VertexPosition	vertexPosition
TexCoordPosition	texCoordPosition
Private Member Functions
void	copy (const VisualVertex &other)
Private Attributes
bool	colorIsSet

---

Detailed Description

A vertex is coord position information, incl. color information and coord position. Texture position belongs to vertex data, too.

---

Constructor & Destructor Documentation

VisualVertex::VisualVertex

(

Coord

coordPoint

)

Constructor that creates and returns a vertex at the specified position.

Parameters:

coordPoint

Coord position.

VisualVertex::VisualVertex	(	Coord	coordPoint,
		VertexColor	anRGBAColor
	)

Constructor that creates and returns a vertex at the specified position.

Parameters:

coordPoint	Coord position.
anRGBAColor	RGBA color associated with the vertex.

VisualVertex::VisualVertex	(	Coord	coordPoint,
		Coord	relativeCoordPoint,
		VertexColor	anRGBAColor
	)

Constructor that creates and returns a vertex at the specified position.

Parameters:

coordPoint	Coord position.
relativeCoordPoint	Relative coord position. x: 0.0 means: left, 1.0 means: right; y: 0.0 means: bottom, 1.0 means: top; z: 0.0 means: front, 1.0 means: back.
anRGBAColor	RGBA color associated with the vertex.

VisualVertex::VisualVertex	(	Coord	coordPoint,
		TexCoord	texCoordPoint,
		VertexColor	anRGBAColor
	)

Constructor that creates and returns a vertex at the specified position.

Parameters:

coordPoint	Coord position.
texCoordPoint	A position of a texture.
anRGBAColor	RGBA color associated with the vertex.

VisualVertex::VisualVertex	(	Coord	coordPoint,
		Coord	relativeCoordPoint,
		TexCoord	texCoordPoint,
		VertexColor	anRGBAColor
	)

Constructor that creates and returns a vertex at the specified position.

Parameters:

coordPoint	Coord position.
relativeCoordPoint	Relative coord position. x: 0.0 means: left, 1.0 means: right; y: 0.0 means: bottom, 1.0 means: top; z: 0.0 means: front, 1.0 means: back.
texCoordPoint	A position of a texture.
anRGBAColor	RGBA color associated with the vertex.

VisualVertex::VisualVertex	(	Coord	coordPoint,
		Coord	relativeCoordPoint,
		TexCoord	texCoordPoint,
		TexCoord	relTexCoordPoint,
		VertexColor	anRGBAColor
	)

Constructor that creates and returns a vertex at the specified position.

Parameters:

coordPoint	Coord position.
relativeCoordPoint	Relative coord position. x: 0.0 means: left, 1.0 means: right; y: 0.0 means: bottom, 1.0 means: top; z: 0.0 means: front, 1.0 means: back.
texCoordPoint	A position of a texture.
relTexCoordPoint	A relative position of a texture.
anRGBAColor	RGBA color associated with the vertex.

VisualVertex::VisualVertex	(	VertexPosition	aVertexPosition,
		VertexColor	anRGBAColor
	)

Constructor that creates and returns a vertex at the specified position.

Parameters:

aVertexPosition	A vertex position.
anRGBAColor	RGBA color associated with the vertex.

VisualVertex::~VisualVertex

(

)

The destructor.

VisualVertex::VisualVertex

(

const VisualVertex &

other

)

Copy constructor.

Parameters:

other

Reference to another VisualVertex.

---

Member Function Documentation

bool VisualVertex::colorHasBeenSet

(

void

)

True if vertex contains a valid color.

Returns:

True if vertex contains a valid color.

void VisualVertex::copy

(

const VisualVertex &

other

)

[private]

Copy method for assignment operator and copy constructor.

Parameters:

other

Another VisualVertex.

VisualVertex & VisualVertex::operator=

(

const VisualVertex &

other

)

Assignment operator.

Parameters:

other

Reference to another VisualVertex.

void VisualVertex::setRelativeTexCoordPosition

(

TexCoord

aTexCoord

)

Updates the relative tex coord position of the vertex.

Parameters:

aTexCoord

The requested relative tex coord position of the vertex.

void VisualVertex::setRelativeVertexPosition

(

Coord

coordPoint

)

Updates the relative position values of the vertex.

Parameters:

coordPoint

The requested relative position values of the vertex.

---

Member Data Documentation

bool VizKit::VisualVertex::colorIsSet [private]

True if color of vertex is set.

TexCoordPosition VizKit::VisualVertex::texCoordPosition

Texture position at the vertex.

VertexColor VizKit::VisualVertex::vertexColor

The color of the vertex.

VertexPosition VizKit::VisualVertex::vertexPosition

The coord position of the vertex.

---

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

• source/VisualVertex.h
• source/VisualVertex.cpp