Vector3D Class Reference

Used to coordinates of the vectors that make up the cells models Stores data about the the vector: its x,y,z position. More...

#include <3D_Vector.h>

Public Member Functions
	Vector3D (float a, float b, float c)
	Vector3D (float a, float b)
	Vector3D (float a)
	Vector3D ()
	~Vector3D ()
	Vector3D (const Vector3D &a)
Vector3D	operator+ (const Vector3D &a)
Vector3D	operator- (const Vector3D &a)
Vector3D	operator* (const Vector3D &a)
Vector3D	operator* (float a)
Vector3D	operator^ (const Vector3D &a)
const Vector3D &	operator= (const Vector3D &a)
Vector3D	operator+= (const Vector3D &a)
float	Get_x ()
float	Get_y ()
float	Get_z ()
void	Set_x (float a)
void	Set_y (float a)
void	Set_z (float a)

Friends
istream &	operator>> (istream &in, Vector3D &a)
ostream &	operator<< (ostream &out, Vector3D &a)

Detailed Description

Used to coordinates of the vectors that make up the cells models Stores data about the the vector: its x,y,z position.

Constructor & Destructor Documentation

Vector3D() [1/5]

Vector3D::Vector3D	(	float	a,
		float	b,
		float	c
	)

Constructor with parameters for 3 dimensions

Parameters

(float)	x coordinate
(float)	y coordinate
(float)	z coordinate

Vector3D() [2/5]

Vector3D::Vector3D	(	float	a,
		float	b
	)

Constructor with parameters for 2 dimensions Other axis can be manipulated later

Parameters

(float)	x coordinate
(float)	y coordinate

Vector3D() [3/5]

Vector3D::Vector3D

(

float

a

)

Constructor with parameters for 1 dimension Other axis can be manipulated later

Parameters

(float)

x coordinate

Vector3D() [4/5]

Vector3D::Vector3D

(

)

Constructor with no parameters

~Vector3D()

Vector3D::~Vector3D

(

)

Destructor

Vector3D() [5/5]

Vector3D::Vector3D

(

const Vector3D &

a

)

Copy Constructor

Parameters

(Vector3D)

input vector

Member Function Documentation

Get_x()

float Vector3D::Get_x

(

)

Return x value of vector

Returns

(float) x value

Get_y()

float Vector3D::Get_y

(

)

Return y value of vector

Returns

(float) y value

Get_z()

float Vector3D::Get_z

(

)

Return z value of vector

Returns

(float) z value

operator*() [1/2]

Vector3D Vector3D::operator*

(

const Vector3D &

a

)

Overloaded '*' operator

Parameters

(Vector3D)

Returns

(Vector3D)

operator*() [2/2]

Vector3D Vector3D::operator*

(

float

a

)

Overloaded '*' operator to mulitply all values by a float

Parameters

(float)

Returns

(Vector3D)

operator+()

Vector3D Vector3D::operator+

(

const Vector3D &

a

)

Overloaded '+' operator

Parameters

(Vector3D)

Returns

(Vector3D)

operator+=()

Vector3D Vector3D::operator+=

(

const Vector3D &

a

)

Overloaded '+=' operator

Parameters

(Vector3D)

Returns

(Vector3D)

operator-()

Vector3D Vector3D::operator-

(

const Vector3D &

a

)

Overloaded '-' operator

Parameters

(Vector3D)

Returns

(Vector3D)

operator=()

const Vector3D & Vector3D::operator=

(

const Vector3D &

a

)

Overloaded '=' operator

Parameters

(Vector3D)

Returns

(Vector3D)

operator^()

Vector3D Vector3D::operator^

(

const Vector3D &

a

)

Overloaded '^' operator to add exponent

Parameters

(Vector3D)

Returns

(Vector3D)

Set_x()

void Vector3D::Set_x

(

float

a

)

Set x value of vector

Parameters

(float)

x value

Set_y()

void Vector3D::Set_y

(

float

a

)

Set x value of vector

Parameters

(float)

y value

Set_z()

void Vector3D::Set_z

(

float

a

)

Set z value of vector

Parameters

(float)

z value

Friends And Related Function Documentation

operator<<

ostream& operator<< ( ostream &  out, Vector3D &  a  )

friend

Overloaded '<<' operator to output vector values

Parameters

(Vector3D)

operator>>

istream& operator>> ( istream &  in, Vector3D &  a  )

friend

Overloaded '>>' operator to output vector values

Parameters

(Vector3D)

---

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

• /home/runner/work/2021_Group_3/2021_Group_3/Custom_Mod_Library/include/3D_Vector.h
• /home/runner/work/2021_Group_3/2021_Group_3/Custom_Mod_Library/src/3D_Vector.cpp