vector_3 Struct Reference

#include <vector_3.h>

Inheritance diagram for vector_3:

Collaboration diagram for vector_3:

Public Member Functions
	vector_3 (const float &_x, const float &_y, const float &_z)
	vector_3 (const xy_float_t &in)
	vector_3 (const xyz_float_t &in)
	vector_3 (const xyze_float_t &in)
void	normalize ()
void	apply_rotation (const matrix_3x3 &matrix)
float	get_length () const
vector_3	get_normal () const
FORCE_INLINE vector_3	operator+ (const vector_3 &v) const
FORCE_INLINE vector_3	operator- (const vector_3 &v) const
FORCE_INLINE vector_3	operator* (const float &v) const
void	debug (PGM_P const title)
Public Member Functions inherited from XYZval< float >
FI void	set (const float px)
FI void	set (const float px, const float py)
FI void	set (const float px, const float py, const float pz)
FI void	set (const XYval< float > pxy, const float pz)
FI void	reset ()
FI float	magnitude () const
FI	operator float * ()
FI	operator bool ()
FI XYZval< float >	copy () const
FI XYZval< float >	ABS () const
FI XYZval< int16_t >	asInt ()
FI XYZval< int16_t >	asInt () const
FI XYZval< int32_t >	asLong ()
FI XYZval< int32_t >	asLong () const
FI XYZval< float >	asFloat ()
FI XYZval< float >	asFloat () const
FI XYZval< float >	reciprocal () const
FI XYZval< float >	asLogical () const
FI XYZval< float >	asNative () const
FI	operator XYval< float > & ()
FI	operator const XYval< float > & () const
FI	operator XYZEval< float > () const
FI float &	operator[] (const int i)
const FI float &	operator[] (const int i) const
FI XYZval< float > &	operator= (const float v)
FI XYZval< float > &	operator= (const XYval< float > &rs)
FI XYZval< float > &	operator= (const XYZEval< float > &rs)
FI XYZval< float >	operator+ (const XYval< float > &rs) const
FI XYZval< float >	operator+ (const XYval< float > &rs)
FI XYZval< float >	operator+ (const XYZval< float > &rs) const
FI XYZval< float >	operator+ (const XYZval< float > &rs)
FI XYZval< float >	operator+ (const XYZEval< float > &rs) const
FI XYZval< float >	operator+ (const XYZEval< float > &rs)
FI XYZval< float >	operator- (const XYval< float > &rs) const
FI XYZval< float >	operator- (const XYval< float > &rs)
FI XYZval< float >	operator- (const XYZval< float > &rs) const
FI XYZval< float >	operator- (const XYZval< float > &rs)
FI XYZval< float >	operator- (const XYZEval< float > &rs) const
FI XYZval< float >	operator- (const XYZEval< float > &rs)
FI XYZval< float >	operator- ()
const FI XYZval< float >	operator- () const
FI XYZval< float >	operator* (const XYval< float > &rs) const
FI XYZval< float >	operator* (const XYval< float > &rs)
FI XYZval< float >	operator* (const XYZval< float > &rs) const
FI XYZval< float >	operator* (const XYZval< float > &rs)
FI XYZval< float >	operator* (const XYZEval< float > &rs) const
FI XYZval< float >	operator* (const XYZEval< float > &rs)
FI XYZval< float >	operator* (const float &v) const
FI XYZval< float >	operator* (const float &v)
FI XYZval< float >	operator* (const int &v) const
FI XYZval< float >	operator* (const int &v)
FI XYZval< float >	operator/ (const XYval< float > &rs) const
FI XYZval< float >	operator/ (const XYval< float > &rs)
FI XYZval< float >	operator/ (const XYZval< float > &rs) const
FI XYZval< float >	operator/ (const XYZval< float > &rs)
FI XYZval< float >	operator/ (const XYZEval< float > &rs) const
FI XYZval< float >	operator/ (const XYZEval< float > &rs)
FI XYZval< float >	operator/ (const float &v) const
FI XYZval< float >	operator/ (const float &v)
FI XYZval< float >	operator/ (const int &v) const
FI XYZval< float >	operator/ (const int &v)
FI XYZval< float >	operator>> (const int &v) const
FI XYZval< float >	operator>> (const int &v)
FI XYZval< float >	operator<< (const int &v) const
FI XYZval< float >	operator<< (const int &v)
FI XYZval< float > &	operator+= (const XYval< float > &rs)
FI XYZval< float > &	operator+= (const XYZval< float > &rs)
FI XYZval< float > &	operator+= (const XYZEval< float > &rs)
FI XYZval< float > &	operator-= (const XYval< float > &rs)
FI XYZval< float > &	operator-= (const XYZval< float > &rs)
FI XYZval< float > &	operator-= (const XYZEval< float > &rs)
FI XYZval< float > &	operator*= (const XYval< float > &rs)
FI XYZval< float > &	operator*= (const XYZval< float > &rs)
FI XYZval< float > &	operator*= (const XYZEval< float > &rs)
FI XYZval< float > &	operator*= (const float &v)
FI XYZval< float > &	operator*= (const int &v)
FI XYZval< float > &	operator/= (const XYval< float > &rs)
FI XYZval< float > &	operator/= (const XYZval< float > &rs)
FI XYZval< float > &	operator/= (const XYZEval< float > &rs)
FI XYZval< float > &	operator>>= (const int &v)
FI XYZval< float > &	operator<<= (const int &v)
FI bool	operator== (const XYZEval< float > &rs)
FI bool	operator== (const XYZEval< float > &rs) const
FI bool	operator!= (const XYZEval< float > &rs)
FI bool	operator!= (const XYZEval< float > &rs) const

Static Public Member Functions
static vector_3	cross (const vector_3 &a, const vector_3 &b)

Additional Inherited Members
Public Attributes inherited from XYZval< float >
float	x
float	y
float	z
float	a
float	b
float	c
float	pos [3]
union {
struct {
T   x
T   y
T   z
}
struct {
T   a
T   b
T   c
}
T   pos [3]
};

Constructor & Destructor Documentation

vector_3() [1/4]

vector_3::vector_3	(	const float &	_x,
		const float &	_y,
		const float &	_z
	)

{ set(_x, _y, _z); }

Here is the call graph for this function:

Here is the caller graph for this function:

vector_3() [2/4]

vector_3::vector_3

(

const xy_float_t &

in

)

{ set(in.x, in.y); }

Here is the call graph for this function:

vector_3() [3/4]

vector_3::vector_3

(

const xyz_float_t &

in

)

{ set(in.x, in.y, in.z); }

Here is the call graph for this function:

vector_3() [4/4]

vector_3::vector_3

(

const xyze_float_t &

in

)

{ set(in.x, in.y, in.z); }

Here is the call graph for this function:

Member Function Documentation

cross()

vector_3 vector_3::cross ( const vector_3 &  left, const vector_3 &  right  )

static

Marlin 3D Printer Firmware Copyright (c) 2019 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]

Based on Sprinter and grbl. Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/. vector_3.cpp - Vector library for bed leveling Copyright (c) 2012 Lars Brubaker. All right reserved.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA vector_3

                                                                    {
  const xyz_float_t &lv = left, &rv = right;
  return vector_3(lv.y * rv.z - lv.z * rv.y,      // YZ cross
                  lv.z * rv.x - lv.x * rv.z,      // ZX cross
                  lv.x * rv.y - lv.y * rv.x);     // XY cross
}

Here is the call graph for this function:

Here is the caller graph for this function:

normalize()

void vector_3::normalize

(

)

                         {
  *this *= RSQRT(sq(x) + sq(y) + sq(z));
}

Here is the caller graph for this function:

apply_rotation()

void vector_3::apply_rotation

(

const matrix_3x3 &

matrix

)

                                                      {
  const float _x = x, _y = y, _z = z;
  *this = matrix.vectors[0] * _x + matrix.vectors[1] * _y + matrix.vectors[2] * _z;
}

Here is the caller graph for this function:

get_length()

float vector_3::get_length

(

)

const

get_normal()

vector_3 vector_3::get_normal

(

)

const

                                    {
  vector_3 normalized = *this;
  normalized.normalize();
  return normalized;
}

Here is the call graph for this function:

Here is the caller graph for this function:

operator+()

FORCE_INLINE vector_3 vector_3::operator+

(

const vector_3 &

v

)

const

{ vector_3 o = *this; o += v; return o; }

operator-()

FORCE_INLINE vector_3 vector_3::operator-

(

const vector_3 &

v

)

const

{ vector_3 o = *this; o -= v; return o; }

operator*()

FORCE_INLINE vector_3 vector_3::operator*

(

const float &

v

)

const

{ vector_3 o = *this; o *= v; return o; }

debug()

void vector_3::debug

(

PGM_P const

title

)

                                      {
  serialprintPGM(title);
  SERIAL_ECHOPAIR_F(" X", x, 6);
  SERIAL_ECHOPAIR_F(" Y", y, 6);
  SERIAL_ECHOLNPAIR_F(" Z", z, 6);
}

Here is the call graph for this function: