trBase::Vec4b Class Reference

General purpose 3D byte Vector. More...

#include <Vec4b.h>

Public Types
using	value_type = signed char
	Data type of vector components. More...

Public Member Functions
	Vec4b ()
	Default constructor. More...
	Vec4b (value_type x, value_type y, value_type z, value_type w)
	Constructor. More...
	Vec4b (const osg::Vec4b &v)
	Copy Constructor from osg::Vec to trBase::Vec. More...
const osg::Vec4b &	GetOSGVector () const
	Returns the internal OSG vector. More...
value_type	Length () const
	Length of the vector = sqrt( vec . More...
value_type	Length2 () const
	Length squared of the vector = vec . More...
value_type	Normalize ()
	Normalize the vector so that it has length unity. More...
value_type &	X ()
	Returns the X component of the vector. More...
value_type &	Y ()
	Returns the Y component of the vector. More...
value_type &	Z ()
	Returns the Z component of the vector. More...
value_type &	W ()
	Returns the W component of the vector. More...
value_type	X () const
	Returns the X component of the vector. More...
value_type	Y () const
	Returns the Y component of the vector. More...
value_type	Z () const
	Returns the Z component of the vector. More...
value_type	W () const
	Returns the W component of the vector. More...
value_type &	R ()
	Returns the R component of the vector. More...
value_type &	G ()
	Returns the G component of the vector. More...
value_type &	B ()
	Returns the B component of the vector. More...
value_type &	A ()
	Returns the A component of the vector. More...
value_type	R () const
	Returns the R component of the vector. More...
value_type	G () const
	Returns the G component of the vector. More...
value_type	B () const
	Returns the B component of the vector. More...
value_type	A () const
	Returns the A component of the vector. More...
void	Set (value_type x, value_type y, value_type z, value_type w)
	Sets the initial values of the vector. More...
void	Set (const Vec4b &v)
	Sets the initial values of the vector. More...
void	SetRGBA (value_type r, value_type g, value_type b, value_type a)
	Sets the initial values of the vector. More...
void	Lerp (const Vec4b &to, value_type alpha)
	Linear interpolation of this vector to a passed in vector. More...
Vec4b	Lerp (const Vec4b &from, const Vec4b &to, value_type alpha)
	Linear interpolation of two vectors. More...
std::string	ToString (int precision=-1)
	Convert this object into a string representation. More...
value_type *	Ptr ()
	Pointer to the internal Vector array. More...
const value_type *	Ptr () const
	Pointer to the internal Vector array. More...
value_type &	operator[] (int i)
	Index operator. More...
value_type	operator[] (int i) const
	Index operator. More...
void	operator= (const Vec4b &v)
	Set operator. More...
void	operator= (const osg::Vec4b &v)
	Set operator. More...
bool	operator== (const Vec4b &v) const
	Equality operator. More...
bool	operator!= (const Vec4b &v) const
	Inequality operator. More...
bool	operator< (const Vec4b &v) const
	Less than operator. More...
bool	operator> (const Vec4b &v) const
	Greater than operator. More...
value_type	operator* (const Vec4b &rhs) const
	Dot product operator. More...
const Vec4b	operator* (value_type rhs) const
	Scalar multiplication operator. More...
Vec4b &	operator*= (value_type rhs)
	Unary scalar multiplication operator. More...
const Vec4b	operator/ (value_type rhs) const
	Divide by scalar operator. More...
Vec4b &	operator/= (value_type rhs)
	Unary divide by scalar operator. More...
const Vec4b	operator+ (const Vec4b &rhs) const
	Binary vector add operator. More...
Vec4b &	operator+= (const Vec4b &rhs)
	Unary vector add operator. More...
const Vec4b	operator- (const Vec4b &rhs) const
	Binary vector subtraction operator. More...
Vec4b &	operator-= (const Vec4b &rhs)
	Unary vector subtraction operator. More...
const Vec4b	operator- () const
	Negation operator. More...
	operator osg::Vec4b () const
	Implicit conversion operator to OSG Vector. More...
	operator osg::Vec4b & ()
	Implicit conversion operator to OSG Vector. More...
	operator const osg::Vec4b & () const
	Implicit conversion operator to OSG Vector. More...
	operator osg::Vec4b * ()
	Implicit conversion operator to OSG Vector. More...

Static Public Attributes
static const int	NUM_OF_COMPONENTS

Protected Attributes
osg::Vec4b	mVec

Detailed Description

General purpose 3D byte Vector.

Definition at line 38 of file Vec4b.h.

Member Typedef Documentation

value_type

using trBase::Vec4b::value_type = signed char

Data type of vector components.

Definition at line 43 of file Vec4b.h.

Constructor & Destructor Documentation

Vec4b() [1/3]

trBase::Vec4b::Vec4b

(

)

Default constructor.

Vec4b() [2/3]

trBase::Vec4b::Vec4b	(	value_type	x,
		value_type	y,
		value_type	z,
		value_type	w
	)

Constructor.

Parameters

x	The x component of the vector.
y	The y component of the vector.
z	The z component of the vector.
w	The w component of the vector.

Vec4b() [3/3]

trBase::Vec4b::Vec4b

(

const osg::Vec4b &

v

)

Copy Constructor from osg::Vec to trBase::Vec.

Parameters

v	The osg::Vec4b to process.

Member Function Documentation

A() [1/2]

value_type& trBase::Vec4b::A

(

)

Returns the A component of the vector.

A() [2/2]

value_type trBase::Vec4b::A

(

)

const

Returns the A component of the vector.

B() [1/2]

value_type& trBase::Vec4b::B

(

)

Returns the B component of the vector.

B() [2/2]

value_type trBase::Vec4b::B

(

)

const

Returns the B component of the vector.

G() [1/2]

value_type& trBase::Vec4b::G

(

)

Returns the G component of the vector.

G() [2/2]

value_type trBase::Vec4b::G

(

)

const

Returns the G component of the vector.

GetOSGVector()

const osg::Vec4b& trBase::Vec4b::GetOSGVector

(

)

const

Returns the internal OSG vector.

Length()

value_type trBase::Vec4b::Length

(

)

const

Length of the vector = sqrt( vec .

vec )

Length2()

value_type trBase::Vec4b::Length2

(

)

const

Length squared of the vector = vec .

vec

Lerp() [1/2]

void trBase::Vec4b::Lerp	(	const Vec4b &	to,
		value_type	alpha
	)

Linear interpolation of this vector to a passed in vector.

Parameters

to	The vector that we are interpolating to.
alpha	Amount of change (0-1).

Lerp() [2/2]

Vec4b trBase::Vec4b::Lerp	(	const Vec4b &	from,
		const Vec4b &	to,
		value_type	alpha
	)

Linear interpolation of two vectors.

Parameters

from	The vector that we are interpolating from.
to	The vector that we are interpolating to.
alpha	Amount of change (0-1).

Returns

An interpolated vector.

Normalize()

value_type trBase::Vec4b::Normalize

(

)

Normalize the vector so that it has length unity.

Returns the previous length of the vector.

operator const osg::Vec4b &()

trBase::Vec4b::operator const osg::Vec4b &

(

)

const

Implicit conversion operator to OSG Vector.

operator osg::Vec4b()

trBase::Vec4b::operator osg::Vec4b

(

)

const

Implicit conversion operator to OSG Vector.

operator osg::Vec4b &()

trBase::Vec4b::operator osg::Vec4b &

(

)

Implicit conversion operator to OSG Vector.

operator osg::Vec4b *()

trBase::Vec4b::operator osg::Vec4b *

(

)

Implicit conversion operator to OSG Vector.

operator!=()

bool trBase::Vec4b::operator!=

(

const Vec4b &

v

)

const

Inequality operator.

operator*() [1/2]

value_type trBase::Vec4b::operator*

(

const Vec4b &

rhs

)

const

Dot product operator.

operator*() [2/2]

const Vec4b trBase::Vec4b::operator*

(

value_type

rhs

)

const

Scalar multiplication operator.

operator*=()

Vec4b& trBase::Vec4b::operator*=

(

value_type

rhs

)

Unary scalar multiplication operator.

operator+()

const Vec4b trBase::Vec4b::operator+

(

const Vec4b &

rhs

)

const

Binary vector add operator.

operator+=()

Vec4b& trBase::Vec4b::operator+=

(

const Vec4b &

rhs

)

Unary vector add operator.

Slightly more efficient because it has no temporary intermediate objects.

operator-() [1/2]

const Vec4b trBase::Vec4b::operator-

(

const Vec4b &

rhs

)

const

Binary vector subtraction operator.

operator-() [2/2]

const Vec4b trBase::Vec4b::operator-

(

)

const

Negation operator.

Returns the negative of the Vec4b.

operator-=()

Vec4b& trBase::Vec4b::operator-=

(

const Vec4b &

rhs

)

Unary vector subtraction operator.

operator/()

const Vec4b trBase::Vec4b::operator/

(

value_type

rhs

)

const

Divide by scalar operator.

operator/=()

Vec4b& trBase::Vec4b::operator/=

(

value_type

rhs

)

Unary divide by scalar operator.

operator<()

bool trBase::Vec4b::operator<

(

const Vec4b &

v

)

const

Less than operator.

operator=() [1/2]

void trBase::Vec4b::operator=

(

const Vec4b &

v

)

Set operator.

operator=() [2/2]

void trBase::Vec4b::operator=

(

const osg::Vec4b &

v

)

Set operator.

operator==()

bool trBase::Vec4b::operator==

(

const Vec4b &

v

)

const

Equality operator.

operator>()

bool trBase::Vec4b::operator>

(

const Vec4b &

v

)

const

Greater than operator.

operator[]() [1/2]

value_type& trBase::Vec4b::operator[]

(

int

i

)

Index operator.

operator[]() [2/2]

value_type trBase::Vec4b::operator[]

(

int

i

)

const

Index operator.

Ptr() [1/2]

value_type* trBase::Vec4b::Ptr

(

)

Pointer to the internal Vector array.

Ptr() [2/2]

const value_type* trBase::Vec4b::Ptr

(

)

const

Pointer to the internal Vector array.

R() [1/2]

value_type& trBase::Vec4b::R

(

)

Returns the R component of the vector.

R() [2/2]

value_type trBase::Vec4b::R

(

)

const

Returns the R component of the vector.

Set() [1/2]

void trBase::Vec4b::Set	(	value_type	x,
		value_type	y,
		value_type	z,
		value_type	w
	)

Sets the initial values of the vector.

Set() [2/2]

void trBase::Vec4b::Set

(

const Vec4b &

v

)

Sets the initial values of the vector.

SetRGBA()

void trBase::Vec4b::SetRGBA	(	value_type	r,
		value_type	g,
		value_type	b,
		value_type	a
	)

Sets the initial values of the vector.

ToString()

std::string trBase::Vec4b::ToString

(

int

precision = -1

)

Convert this object into a string representation.

Parameters

precision

(Optional) The precision.

Returns

A std::string that represents this object.

W() [1/2]

value_type& trBase::Vec4b::W

(

)

Returns the W component of the vector.

W() [2/2]

value_type trBase::Vec4b::W

(

)

const

Returns the W component of the vector.

X() [1/2]

value_type& trBase::Vec4b::X

(

)

Returns the X component of the vector.

X() [2/2]

value_type trBase::Vec4b::X

(

)

const

Returns the X component of the vector.

Y() [1/2]

value_type& trBase::Vec4b::Y

(

)

Returns the Y component of the vector.

Y() [2/2]

value_type trBase::Vec4b::Y

(

)

const

Returns the Y component of the vector.

Z() [1/2]

value_type& trBase::Vec4b::Z

(

)

Returns the Z component of the vector.

Z() [2/2]

value_type trBase::Vec4b::Z

(

)

const

Returns the Z component of the vector.

Member Data Documentation

mVec

osg::Vec4b trBase::Vec4b::mVec

protected

Definition at line 338 of file Vec4b.h.

NUM_OF_COMPONENTS

const int trBase::Vec4b::NUM_OF_COMPONENTS

static

Definition at line 45 of file Vec4b.h.

---

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

• Vec4b.h