General purpose 3D unsigned byte Vector. More...

#include <Vec3ub.h>

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

Public Member Functions
	Vec3ub ()
	Default constructor. More...

	Vec3ub (value_type x, value_type y, value_type z)
	Constructor. More...

	Vec3ub (const osg::Vec3ub &v)
	Copy Constructor from osg::Vec to trBase::Vec. More...

const osg::Vec3ub &	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	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 &	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	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...

void	Set (value_type x, value_type y, value_type z)
	Sets the initial values of the vector. More...

void	Set (const Vec3ub &v)
	Sets the initial values of the vector. More...

void	SetRGB (value_type r, value_type g, value_type b)
	Sets the initial values of the vector. More...

void	Lerp (const Vec3ub &to, value_type alpha)
	Linear interpolation of this vector to a passed in vector. More...

Vec3ub	Lerp (const Vec3ub &from, const Vec3ub &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 Vec3ub &v)
	Set operator. More...

void	operator= (const osg::Vec3ub &v)
	Set operator. More...

bool	operator== (const Vec3ub &v) const
	Equality operator. More...

bool	operator!= (const Vec3ub &v) const
	Inequality operator. More...

bool	operator< (const Vec3ub &v) const
	Less than operator. More...

bool	operator> (const Vec3ub &v) const
	Greater than operator. More...

value_type	operator* (const Vec3ub &rhs) const
	Dot product operator. More...

const Vec3ub	operator* (value_type rhs) const
	Scalar multiplication operator. More...

Vec3ub &	operator*= (value_type rhs)
	Unary scalar multiplication operator. More...

const Vec3ub	operator/ (value_type rhs) const
	Divide by scalar operator. More...

Vec3ub &	operator/= (value_type rhs)
	Unary divide by scalar operator. More...

const Vec3ub	operator+ (const Vec3ub &rhs) const
	Binary vector add operator. More...

Vec3ub &	operator+= (const Vec3ub &rhs)
	Unary vector add operator. More...

const Vec3ub	operator- (const Vec3ub &rhs) const
	Binary vector subtraction operator. More...

Vec3ub &	operator-= (const Vec3ub &rhs)
	Unary vector subtraction operator. More...

const Vec3ub	operator- () const
	Negation operator. More...

const Vec3ub	operator^ (const Vec3ub &rhs) const
	Cross product operator. More...

	operator osg::Vec3ub () const
	Implicit conversion operator to OSG Vector. More...

	operator osg::Vec3ub & ()
	Implicit conversion operator to OSG Vector. More...

	operator const osg::Vec3ub & () const
	Implicit conversion operator to OSG Vector. More...

	operator osg::Vec3ub * ()
	Implicit conversion operator to OSG Vector. More...

Static Public Attributes
static const int	NUM_OF_COMPONENTS

Protected Attributes
osg::Vec3ub	mVec

Detailed Description

General purpose 3D unsigned byte Vector.

Definition at line 38 of file Vec3ub.h.

Member Typedef Documentation

◆ value_type

using trBase::Vec3ub::value_type = unsigned char

Data type of vector components.

Definition at line 43 of file Vec3ub.h.

Constructor & Destructor Documentation

◆ Vec3ub() [1/3]

trBase::Vec3ub::Vec3ub ( )

Default constructor.

◆ Vec3ub() [2/3]

trBase::Vec3ub::Vec3ub	(	value_type	x,
		value_type	y,
		value_type	z
	)

Constructor.

Parameters

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

◆ Vec3ub() [3/3]

trBase::Vec3ub::Vec3ub ( const osg::Vec3ub & v )

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

Parameters

v	The osg::Vec3ub to process.

Member Function Documentation

◆ B() [1/2]

value_type& trBase::Vec3ub::B ( )

Returns the B component of the vector.

◆ B() [2/2]

value_type trBase::Vec3ub::B ( ) const

Returns the B component of the vector.

◆ G() [1/2]

value_type& trBase::Vec3ub::G ( )

Returns the G component of the vector.

◆ G() [2/2]

value_type trBase::Vec3ub::G ( ) const

Returns the G component of the vector.

◆ GetOSGVector()

const osg::Vec3ub& trBase::Vec3ub::GetOSGVector ( ) const

Returns the internal OSG vector.

◆ Length()

value_type trBase::Vec3ub::Length ( ) const

Length of the vector = sqrt( vec .

vec )

◆ Length2()

value_type trBase::Vec3ub::Length2 ( ) const

Length squared of the vector = vec .

vec

◆ Lerp() [1/2]

void trBase::Vec3ub::Lerp	(	const Vec3ub &	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]

Vec3ub trBase::Vec3ub::Lerp	(	const Vec3ub &	from,
		const Vec3ub &	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::Vec3ub::Normalize ( )

Normalize the vector so that it has length unity.

Returns the previous length of the vector.

◆ operator const osg::Vec3ub &()

trBase::Vec3ub::operator const osg::Vec3ub & ( ) const

Implicit conversion operator to OSG Vector.

◆ operator osg::Vec3ub()

trBase::Vec3ub::operator osg::Vec3ub ( ) const

Implicit conversion operator to OSG Vector.

◆ operator osg::Vec3ub &()

trBase::Vec3ub::operator osg::Vec3ub & ( )

Implicit conversion operator to OSG Vector.

◆ operator osg::Vec3ub *()

trBase::Vec3ub::operator osg::Vec3ub * ( )

Implicit conversion operator to OSG Vector.

◆ operator!=()

bool trBase::Vec3ub::operator!= ( const Vec3ub & v ) const

Inequality operator.

◆ operator*() [1/2]

value_type trBase::Vec3ub::operator* ( const Vec3ub & rhs ) const

Dot product operator.

◆ operator*() [2/2]

const Vec3ub trBase::Vec3ub::operator* ( value_type rhs ) const

Scalar multiplication operator.

◆ operator*=()

Vec3ub& trBase::Vec3ub::operator*= ( value_type rhs )

Unary scalar multiplication operator.

◆ operator+()

const Vec3ub trBase::Vec3ub::operator+ ( const Vec3ub & rhs ) const

Binary vector add operator.

◆ operator+=()

Vec3ub& trBase::Vec3ub::operator+= ( const Vec3ub & rhs )

Unary vector add operator.

Slightly more efficient because it has no temporary intermediate objects.

◆ operator-() [1/2]

const Vec3ub trBase::Vec3ub::operator- ( const Vec3ub & rhs ) const

Binary vector subtraction operator.

◆ operator-() [2/2]

const Vec3ub trBase::Vec3ub::operator- ( ) const

Negation operator.

Returns the negative of the Vec3ub.

◆ operator-=()

Vec3ub& trBase::Vec3ub::operator-= ( const Vec3ub & rhs )

Unary vector subtraction operator.

◆ operator/()

const Vec3ub trBase::Vec3ub::operator/ ( value_type rhs ) const

Divide by scalar operator.

◆ operator/=()

Vec3ub& trBase::Vec3ub::operator/= ( value_type rhs )

Unary divide by scalar operator.

◆ operator<()

bool trBase::Vec3ub::operator< ( const Vec3ub & v ) const

Less than operator.

◆ operator=() [1/2]

void trBase::Vec3ub::operator= ( const Vec3ub & v )

Set operator.

◆ operator=() [2/2]

void trBase::Vec3ub::operator= ( const osg::Vec3ub & v )

Set operator.

◆ operator==()

bool trBase::Vec3ub::operator== ( const Vec3ub & v ) const

Equality operator.

◆ operator>()

bool trBase::Vec3ub::operator> ( const Vec3ub & v ) const

Greater than operator.

◆ operator[]() [1/2]

value_type& trBase::Vec3ub::operator[] ( int i )

Index operator.

◆ operator[]() [2/2]

value_type trBase::Vec3ub::operator[] ( int i ) const

Index operator.

◆ operator^()

const Vec3ub trBase::Vec3ub::operator^ ( const Vec3ub & rhs ) const

Cross product operator.

◆ Ptr() [1/2]

value_type* trBase::Vec3ub::Ptr ( )

Pointer to the internal Vector array.

◆ Ptr() [2/2]

const value_type* trBase::Vec3ub::Ptr ( ) const

Pointer to the internal Vector array.

◆ R() [1/2]

value_type& trBase::Vec3ub::R ( )

Returns the R component of the vector.

◆ R() [2/2]

value_type trBase::Vec3ub::R ( ) const

Returns the R component of the vector.

◆ Set() [1/2]

void trBase::Vec3ub::Set	(	value_type	x,
		value_type	y,
		value_type	z
	)

Sets the initial values of the vector.

◆ Set() [2/2]

void trBase::Vec3ub::Set ( const Vec3ub & v )

Sets the initial values of the vector.

◆ SetRGB()

void trBase::Vec3ub::SetRGB	(	value_type	r,
		value_type	g,
		value_type	b
	)

Sets the initial values of the vector.

◆ ToString()

std::string trBase::Vec3ub::ToString ( int precision = -1 )

Convert this object into a string representation.

Parameters

precision (Optional) The precision.

Returns: A std::string that represents this object.

◆ X() [1/2]

value_type& trBase::Vec3ub::X ( )

Returns the X component of the vector.

◆ X() [2/2]

value_type trBase::Vec3ub::X ( ) const

Returns the X component of the vector.

◆ Y() [1/2]

value_type& trBase::Vec3ub::Y ( )

Returns the Y component of the vector.

◆ Y() [2/2]

value_type trBase::Vec3ub::Y ( ) const

Returns the Y component of the vector.

◆ Z() [1/2]

value_type& trBase::Vec3ub::Z ( )

Returns the Z component of the vector.

◆ Z() [2/2]

value_type trBase::Vec3ub::Z ( ) const

Returns the Z component of the vector.

Member Data Documentation

◆ mVec

osg::Vec3ub trBase::Vec3ub::mVec

protected

Definition at line 322 of file Vec3ub.h.

◆ NUM_OF_COMPONENTS

const int trBase::Vec3ub::NUM_OF_COMPONENTS

static

Definition at line 45 of file Vec3ub.h.

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

Vec3ub.h

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ value_type

Constructor & Destructor Documentation

◆ Vec3ub() [1/3]

◆ Vec3ub() [2/3]

◆ Vec3ub() [3/3]

Member Function Documentation

◆ B() [1/2]

◆ B() [2/2]

◆ G() [1/2]

◆ G() [2/2]

◆ GetOSGVector()

◆ Length()

◆ Length2()

◆ Lerp() [1/2]

◆ Lerp() [2/2]

◆ Normalize()

◆ operator const osg::Vec3ub &()

◆ operator osg::Vec3ub()

◆ operator osg::Vec3ub &()

◆ operator osg::Vec3ub *()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator<()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ operator^()

◆ Ptr() [1/2]

◆ Ptr() [2/2]

◆ R() [1/2]

◆ R() [2/2]

◆ Set() [1/2]

◆ Set() [2/2]

◆ SetRGB()

◆ ToString()

◆ X() [1/2]

◆ X() [2/2]

◆ Y() [1/2]

◆ Y() [2/2]

◆ Z() [1/2]

◆ Z() [2/2]

Member Data Documentation

◆ mVec

◆ NUM_OF_COMPONENTS