ON_2fVector Class Reference

#include <opennurbs_fpoint.h>

Public Member Functions
	ON_2fVector ()=default
	x,y not initialized More...
	ON_2fVector (const ON_2fVector &)=default
	ON_2fVector (float x, float y)
	ON_2fVector (const ON_2fPoint &)
	ON_2fVector (const ON_3fPoint &)
	ON_2fVector (const ON_3fVector &)
	ON_2fVector (const float *)
	ON_2fVector (const ON_2dPoint &)
	ON_2fVector (const ON_3dPoint &)
	ON_2fVector (const ON_2dVector &)
	ON_2fVector (const ON_3dVector &)
	ON_2fVector (const double *)
	~ON_2fVector ()=default
ON__UINT32	DataCRC (ON__UINT32 current_remainder) const
bool	Decompose (const ON_2fVector &, const ON_2fVector &, double *, double *) const
bool	IsNotZero () const
int	IsParallelTo (const ON_2fVector &, double=ON_DEFAULT_ANGLE_TOLERANCE) const
bool	IsPerpendicularTo (const ON_2fVector &, double=ON_DEFAULT_ANGLE_TOLERANCE) const
bool	IsTiny (double=ON_ZERO_TOLERANCE) const
	Test a vector to see if it is very short More...
bool	IsUnitVector () const
bool	IsUnset () const
bool	IsValid () const
bool	IsZero () const
double	Length () const
double	LengthSquared () const
double	MaximumCoordinate () const
int	MaximumCoordinateIndex () const
	operator const float * () const
	operator float * ()
	(float*) conversion operators More...
bool	operator!= (const ON_2fVector &) const
float	operator* (const ON_2fVector &) const
float	operator* (const ON_2fPoint &) const
double	operator* (const ON_2dVector &) const
ON_2fVector	operator* (int) const
ON_2fVector	operator* (float) const
ON_2dVector	operator* (double) const
ON_2fVector &	operator*= (float)
ON_2fVector	operator+ (const ON_2fVector &) const
ON_2fPoint	operator+ (const ON_2fPoint &) const
ON_3fVector	operator+ (const ON_3fVector &) const
ON_3fPoint	operator+ (const ON_3fPoint &) const
ON_2dVector	operator+ (const ON_2dVector &) const
ON_2dPoint	operator+ (const ON_2dPoint &) const
ON_3dVector	operator+ (const ON_3dVector &) const
ON_3dPoint	operator+ (const ON_3dPoint &) const
ON_2fVector &	operator+= (const ON_2fVector &)
ON_2fVector	operator- () const
ON_2fVector	operator- (const ON_2fVector &) const
ON_2fPoint	operator- (const ON_2fPoint &) const
ON_3fVector	operator- (const ON_3fVector &) const
ON_3fPoint	operator- (const ON_3fPoint &) const
ON_2dVector	operator- (const ON_2dVector &) const
ON_2dPoint	operator- (const ON_2dPoint &) const
ON_3dVector	operator- (const ON_3dVector &) const
ON_3dPoint	operator- (const ON_3dPoint &) const
ON_2fVector &	operator-= (const ON_2fVector &)
ON_2fVector	operator/ (int) const
ON_2fVector	operator/ (float) const
ON_2dVector	operator/ (double) const
ON_2fVector &	operator/= (float)
bool	operator< (const ON_2fVector &) const
bool	operator<= (const ON_2fVector &) const
	dictionary order comparisons More...
ON_2fVector &	operator= (const ON_2fVector &)=default
ON_2fVector &	operator= (const ON_2fPoint &)
	use implicit operator=(const ON_2fVector&) More...
ON_2fVector &	operator= (const ON_3fPoint &)
ON_2fVector &	operator= (const ON_3fVector &)
ON_2fVector &	operator= (const float *)
ON_2fVector &	operator= (const ON_2dPoint &)
ON_2fVector &	operator= (const ON_3dPoint &)
ON_2fVector &	operator= (const ON_2dVector &)
ON_2fVector &	operator= (const ON_3dVector &)
ON_2fVector &	operator= (const double *)
bool	operator== (const ON_2fVector &) const
bool	operator> (const ON_2fVector &) const
bool	operator>= (const ON_2fVector &) const
float &	operator[] (int)
	index operators mimic float[2] behavior More...
float	operator[] (int) const
float &	operator[] (unsigned int)
float	operator[] (unsigned int) const
bool	PerpendicularTo (const ON_2fVector &)
	set this vector to be perpendicular to another vector More...
bool	PerpendicularTo (const ON_2fPoint &, const ON_2fPoint &)
	set this vector to be perpendicular to a line defined by 2 points More...
void	Reverse ()
void	Set (float, float)
	set 2d vector value More...
bool	Unitize ()
ON_2fVector	UnitVector () const
void	Zero ()

Static Public Member Functions
static int	Compare (const ON_2fVector &lhs, const ON_2fVector &rhs)
	A well ordered dictionary compare function that is nan aware and can be used for robust sorting. More...
static const ON_2fVector &	UnitVector (int)
	A index driven function to get unit axis vectors. More...

Public Attributes
float	x
float	y

Static Public Attributes
static const ON_2fVector	NanVector
static const ON_2fVector	XAxis
static const ON_2fVector	YAxis
static const ON_2fVector	ZeroVector

Constructor & Destructor Documentation

ON_2fVector() [1/12]

ON_2fVector::ON_2fVector ( )

default

x,y not initialized

~ON_2fVector()

ON_2fVector::~ON_2fVector ( )

default

ON_2fVector() [2/12]

ON_2fVector::ON_2fVector ( const ON_2fVector &  )

default

ON_2fVector() [3/12]

ON_2fVector::ON_2fVector ( float  x, float  y  )

explicit

ON_2fVector() [4/12]

ON_2fVector::ON_2fVector ( const ON_2fPoint &  )

explicit

ON_2fVector() [5/12]

ON_2fVector::ON_2fVector ( const ON_3fPoint &  )

explicit

ON_2fVector() [6/12]

ON_2fVector::ON_2fVector ( const ON_3fVector &  )

explicit

ON_2fVector() [7/12]

ON_2fVector::ON_2fVector ( const float *  )

explicit

ON_2fVector() [8/12]

ON_2fVector::ON_2fVector ( const ON_2dPoint &  )

explicit

ON_2fVector() [9/12]

ON_2fVector::ON_2fVector ( const ON_3dPoint &  )

explicit

ON_2fVector() [10/12]

ON_2fVector::ON_2fVector ( const ON_2dVector &  )

explicit

ON_2fVector() [11/12]

ON_2fVector::ON_2fVector ( const ON_3dVector &  )

explicit

ON_2fVector() [12/12]

ON_2fVector::ON_2fVector ( const double *  )

explicit

Member Function Documentation

Compare()

static int ON_2fVector::Compare ( const ON_2fVector &  lhs, const ON_2fVector &  rhs  )

static

A well ordered dictionary compare function that is nan aware and can be used for robust sorting.

DataCRC()

ON__UINT32 ON_2fVector::DataCRC

(

ON__UINT32

current_remainder

)

const

Decompose()

bool ON_2fVector::Decompose	(	const ON_2fVector &	,
		const ON_2fVector &	,
		double *	,
		double *
	)		const

IsNotZero()

bool ON_2fVector::IsNotZero

(

)

const

Returns

true if at lease one coordinate is not zero and no coordinates are nans.

IsParallelTo()

int ON_2fVector::IsParallelTo	(	const ON_2fVector &	,
		double	= ON_DEFAULT_ANGLE_TOLERANCE
	)		const

IsPerpendicularTo()

bool ON_2fVector::IsPerpendicularTo	(	const ON_2fVector &	,
		double	= ON_DEFAULT_ANGLE_TOLERANCE
	)		const

IsTiny()

bool ON_2fVector::IsTiny

(

double

= ON_ZERO_TOLERANCE

)

const

Test a vector to see if it is very short

Parameters

tiny_tol

[in] (default = ON_ZERO_TOLERANCE) a nonzero value used as the coordinate zero tolerance.

Returns

( fabs(x) <= tiny_tol && fabs(y) <= tiny_tol )

IsUnitVector()

bool ON_2fVector::IsUnitVector

(

)

const

IsUnset()

bool ON_2fVector::IsUnset

(

)

const

Returns

True if any coordinate is ON_UNSET_FLOAT or ON_UNSET_POSITIVE_FLOAT

IsValid()

bool ON_2fVector::IsValid

(

)

const

Returns

False if any coordinate is ON_UNSET_FLOAT, ON_UNSET_POSITIVE_FLOAT, nan, or infinite. True, otherwise.

IsZero()

bool ON_2fVector::IsZero

(

)

const

Returns

true if vector is the zero vector.

Length()

double ON_2fVector::Length

(

)

const

LengthSquared()

double ON_2fVector::LengthSquared

(

)

const

MaximumCoordinate()

double ON_2fVector::MaximumCoordinate

(

)

const

MaximumCoordinateIndex()

int ON_2fVector::MaximumCoordinateIndex

(

)

const

operator const float *()

ON_2fVector::operator const float *

(

)

const

operator float *()

ON_2fVector::operator float *

(

)

(float*) conversion operators

operator!=()

bool ON_2fVector::operator!=

(

const ON_2fVector &

)

const

operator*() [1/6]

float ON_2fVector::operator*

(

const ON_2fVector &

)

const

operator*() [2/6]

float ON_2fVector::operator*

(

const ON_2fPoint &

)

const

operator*() [3/6]

double ON_2fVector::operator*

(

const ON_2dVector &

)

const

operator*() [4/6]

ON_2fVector ON_2fVector::operator*

(

int

)

const

operator*() [5/6]

ON_2fVector ON_2fVector::operator*

(

float

)

const

operator*() [6/6]

ON_2dVector ON_2fVector::operator*

(

double

)

const

operator*=()

ON_2fVector& ON_2fVector::operator*=

(

float

)

operator+() [1/8]

ON_2fVector ON_2fVector::operator+

(

const ON_2fVector &

)

const

operator+() [2/8]

ON_2fPoint ON_2fVector::operator+

(

const ON_2fPoint &

)

const

operator+() [3/8]

ON_3fVector ON_2fVector::operator+

(

const ON_3fVector &

)

const

operator+() [4/8]

ON_3fPoint ON_2fVector::operator+

(

const ON_3fPoint &

)

const

operator+() [5/8]

ON_2dVector ON_2fVector::operator+

(

const ON_2dVector &

)

const

operator+() [6/8]

ON_2dPoint ON_2fVector::operator+

(

const ON_2dPoint &

)

const

operator+() [7/8]

ON_3dVector ON_2fVector::operator+

(

const ON_3dVector &

)

const

operator+() [8/8]

ON_3dPoint ON_2fVector::operator+

(

const ON_3dPoint &

)

const

operator+=()

ON_2fVector& ON_2fVector::operator+=

(

const ON_2fVector &

)

operator-() [1/9]

ON_2fVector ON_2fVector::operator-

(

)

const

operator-() [2/9]

ON_2fVector ON_2fVector::operator-

(

const ON_2fVector &

)

const

operator-() [3/9]

ON_2fPoint ON_2fVector::operator-

(

const ON_2fPoint &

)

const

operator-() [4/9]

ON_3fVector ON_2fVector::operator-

(

const ON_3fVector &

)

const

operator-() [5/9]

ON_3fPoint ON_2fVector::operator-

(

const ON_3fPoint &

)

const

operator-() [6/9]

ON_2dVector ON_2fVector::operator-

(

const ON_2dVector &

)

const

operator-() [7/9]

ON_2dPoint ON_2fVector::operator-

(

const ON_2dPoint &

)

const

operator-() [8/9]

ON_3dVector ON_2fVector::operator-

(

const ON_3dVector &

)

const

operator-() [9/9]

ON_3dPoint ON_2fVector::operator-

(

const ON_3dPoint &

)

const

operator-=()

ON_2fVector& ON_2fVector::operator-=

(

const ON_2fVector &

)

operator/() [1/3]

ON_2fVector ON_2fVector::operator/

(

int

)

const

operator/() [2/3]

ON_2fVector ON_2fVector::operator/

(

float

)

const

operator/() [3/3]

ON_2dVector ON_2fVector::operator/

(

double

)

const

operator/=()

ON_2fVector& ON_2fVector::operator/=

(

float

)

operator<()

bool ON_2fVector::operator<

(

const ON_2fVector &

)

const

operator<=()

bool ON_2fVector::operator<=

(

const ON_2fVector &

)

const

dictionary order comparisons

operator=() [1/10]

ON_2fVector& ON_2fVector::operator= ( const ON_2fVector &  )

default

operator=() [2/10]

ON_2fVector& ON_2fVector::operator=

(

const ON_2fPoint &

)

use implicit operator=(const ON_2fVector&)

operator=() [3/10]

ON_2fVector& ON_2fVector::operator=

(

const ON_3fPoint &

)

operator=() [4/10]

ON_2fVector& ON_2fVector::operator=

(

const ON_3fVector &

)

operator=() [5/10]

ON_2fVector& ON_2fVector::operator=

(

const float *

)

operator=() [6/10]

ON_2fVector& ON_2fVector::operator=

(

const ON_2dPoint &

)

operator=() [7/10]

ON_2fVector& ON_2fVector::operator=

(

const ON_3dPoint &

)

operator=() [8/10]

ON_2fVector& ON_2fVector::operator=

(

const ON_2dVector &

)

operator=() [9/10]

ON_2fVector& ON_2fVector::operator=

(

const ON_3dVector &

)

operator=() [10/10]

ON_2fVector& ON_2fVector::operator=

(

const double *

)

operator==()

bool ON_2fVector::operator==

(

const ON_2fVector &

)

const

operator>()

bool ON_2fVector::operator>

(

const ON_2fVector &

)

const

operator>=()

bool ON_2fVector::operator>=

(

const ON_2fVector &

)

const

operator[]() [1/4]

float& ON_2fVector::operator[]

(

int

)

index operators mimic float[2] behavior

operator[]() [2/4]

float ON_2fVector::operator[]

(

int

)

const

operator[]() [3/4]

float& ON_2fVector::operator[]

(

unsigned

int

)

operator[]() [4/4]

float ON_2fVector::operator[]

(

unsigned

int

)

const

PerpendicularTo() [1/2]

bool ON_2fVector::PerpendicularTo

(

const ON_2fVector &

)

set this vector to be perpendicular to another vector

PerpendicularTo() [2/2]

bool ON_2fVector::PerpendicularTo	(	const ON_2fPoint &	,
		const ON_2fPoint &
	)

set this vector to be perpendicular to a line defined by 2 points

Reverse()

void ON_2fVector::Reverse

(

)

Set()

void ON_2fVector::Set	(	float	,
		float
	)

set 2d vector value

Unitize()

bool ON_2fVector::Unitize

(

)

UnitVector() [1/2]

static const ON_2fVector& ON_2fVector::UnitVector ( int  )

static

A index driven function to get unit axis vectors.

Parameters

index

[in] 0 returns (1,0), 1 returns (0,1)

Returns

Unit 3d vector with vector[i] = (i==index)?1:0;

UnitVector() [2/2]

ON_2fVector ON_2fVector::UnitVector

(

)

const

Returns

If this is a valid non-zero vector, a unit vector parallel to this is returned. Otherwise the zero vector is returned.

Zero()

void ON_2fVector::Zero

(

)

Member Data Documentation

NanVector

const ON_2fVector ON_2fVector::NanVector

static

x

float ON_2fVector::x

XAxis

const ON_2fVector ON_2fVector::XAxis

static

y

float ON_2fVector::y

YAxis

const ON_2fVector ON_2fVector::YAxis

static

ZeroVector

const ON_2fVector ON_2fVector::ZeroVector

static