syBR::map2syBR::BrushFace Class Reference

Face of a brush. More...

#include <Brush.hpp>

List of all members.

Public Member Functions
	BrushFace ()
	Constructor.
	~BrushFace ()
	Destructor.
void	setPlaneVectors (const Vector3 &vector1, const Vector3 &vector2, const Vector3 &vector3)
	Set three vectors defining the plane of the face.
const Vector3 &	getPlaneVector1 () const
	Get the first vector defining the plane of the face.
const Vector3 &	getPlaneVector2 () const
	Get the second vector defining the plane of the face.
const Vector3 &	getPlaneVector3 () const
	Get the third vector defining the plane of the face.
const Plane &	getPlane () const
	Get the plane of the face.
void	setTexture (const std::string &name, const Vector3 &axisU, const Vector3 &axisV, const double shiftU, const double shiftV, const double scaleU, const double scaleV)
	Set the texture and its settings.
const std::string &	getTextureName () const
	Get the texture name.
const Vector3 &	getTextureUAxis () const
	Get the texture u axis.
const Vector3 &	getTextureVAxis () const
	Get the texture v axis.
const double	getTextureUShift () const
	Get the texture u shift.
const double	getTextureVShift () const
	Get the texture v shift.
const double	getTextureUScale () const
	Get the texture u scale.
const double	getTextureVScale () const
	Get the texture v scale.
Private Attributes
Vector3	m_planeVector1
	First vector defining the plane of the face.
Vector3	m_planeVector2
	Second vector defining the plane of the face.
Vector3	m_planeVector3
	Third vector defining the plane of the face.
Plane	m_plane
	Plane of the face.
std::string	m_textureName
	Texture name.
Vector3	m_textureAxisU
	Texture U axis.
Vector3	m_textureAxisV
	Texture V axis.
double	m_textureShiftU
	Texture U shift.
double	m_textureShiftV
	Texture V shift.
double	m_textureScaleU
	Texture U scale.
double	m_textureScaleV
	Texture V scale.

---

Detailed Description

Face of a brush.

---

Constructor & Destructor Documentation

syBR::map2syBR::BrushFace::BrushFace

(

)

Constructor.

syBR::map2syBR::BrushFace::~BrushFace

(

)

Destructor.

---

Member Function Documentation

void syBR::map2syBR::BrushFace::setPlaneVectors	(	const Vector3 &	vector1,
		const Vector3 &	vector2,
		const Vector3 &	vector3
	)

Set three vectors defining the plane of the face.

Parameters:

	vector1	First vector defining the plane of the face
	vector2	Second vector defining the plane of the face
	vector3	Third vector defining the plane of the face

const Vector3 & syBR::map2syBR::BrushFace::getPlaneVector1

(

)

const

Get the first vector defining the plane of the face.

Returns:

First vector defining the plane of the face

const Vector3 & syBR::map2syBR::BrushFace::getPlaneVector2

(

)

const

Get the second vector defining the plane of the face.

Returns:

Second vector defining the plane of the face

const Vector3 & syBR::map2syBR::BrushFace::getPlaneVector3

(

)

const

Get the third vector defining the plane of the face.

Returns:

Third vector defining the plane of the face

const Plane & syBR::map2syBR::BrushFace::getPlane

(

)

const

Get the plane of the face.

Returns:

Plane of the face

void syBR::map2syBR::BrushFace::setTexture	(	const std::string &	name,
		const Vector3 &	axisU,
		const Vector3 &	axisV,
		const double	shiftU,
		const double	shiftV,
		const double	scaleU,
		const double	scaleV
	)

Set the texture and its settings.

Parameters:

	name	Name of the texture
	axisU	Texture coordinates u axis
	axisV	Texture coordinates v axis
	shiftU	Texture coordinates u shift
	shiftV	Texture coordinates v shift
	scaleU	Texture coordinates u scale
	scaleV	Texture coordinates v scale

const std::string & syBR::map2syBR::BrushFace::getTextureName

(

)

const

Get the texture name.

Returns:

Name of the texture

const Vector3 & syBR::map2syBR::BrushFace::getTextureUAxis

(

)

const

Get the texture u axis.

Returns:

Texture coordinates u axis

const Vector3 & syBR::map2syBR::BrushFace::getTextureVAxis

(

)

const

Get the texture v axis.

Returns:

Texture coordinates v axis

const double syBR::map2syBR::BrushFace::getTextureUShift

(

)

const

Get the texture u shift.

Returns:

Texture coordinates u shift

const double syBR::map2syBR::BrushFace::getTextureVShift

(

)

const

Get the texture v shift.

Returns:

Texture coordinates v shift

const double syBR::map2syBR::BrushFace::getTextureUScale

(

)

const

Get the texture u scale.

Returns:

Texture coordinates u scale

const double syBR::map2syBR::BrushFace::getTextureVScale

(

)

const

Get the texture v scale.

Returns:

Texture coordinates v scale

---

Member Data Documentation

Vector3 syBR::map2syBR::BrushFace::m_planeVector1 [private]

First vector defining the plane of the face.

Vector3 syBR::map2syBR::BrushFace::m_planeVector2 [private]

Second vector defining the plane of the face.

Vector3 syBR::map2syBR::BrushFace::m_planeVector3 [private]

Third vector defining the plane of the face.

Plane syBR::map2syBR::BrushFace::m_plane [private]

Plane of the face.

std::string syBR::map2syBR::BrushFace::m_textureName [private]

Texture name.

Vector3 syBR::map2syBR::BrushFace::m_textureAxisU [private]

Texture U axis.

Vector3 syBR::map2syBR::BrushFace::m_textureAxisV [private]

Texture V axis.

double syBR::map2syBR::BrushFace::m_textureShiftU [private]

Texture U shift.

double syBR::map2syBR::BrushFace::m_textureShiftV [private]

Texture V shift.

double syBR::map2syBR::BrushFace::m_textureScaleU [private]

Texture U scale.

double syBR::map2syBR::BrushFace::m_textureScaleV [private]

Texture V scale.

---

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

• /home/seb/syBR/map2syBR/src/map/Brush.hpp
• /home/seb/syBR/map2syBR/src/map/Brush.cpp

---

Copyright © 2008 by Sebastien Frippiat

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 License.
Last modified Tue Dec 30 17:57:34 2008