Rhino C++ API  7.22
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ON_3dVector Class Reference

#include <opennurbs_point.h>

Public Member Functions

 ON_3dVector ()=default
 x,y,z not initialized More...
 
 ON_3dVector (const double *)
 from double[3] array More...
 
 ON_3dVector (const float *)
 from float[3] array More...
 
 ON_3dVector (const ON_2dPoint &)
 from 2d point More...
 
 ON_3dVector (const ON_2dVector &)
 from 2d vector More...
 
 ON_3dVector (const ON_2fPoint &)
 from 2f point More...
 
 ON_3dVector (const ON_2fVector &)
 from 2f vector More...
 
 ON_3dVector (const ON_3dPoint &)
 from 3d point More...
 
 ON_3dVector (const ON_3dVector &)=default
 
 ON_3dVector (const ON_3fPoint &)
 from 3f point More...
 
 ON_3dVector (const ON_3fVector &)
 from 3f vector More...
 
 ON_3dVector (double x, double y, double z)
 
 ~ON_3dVector ()=default
 
ON__UINT32 DataCRC (ON__UINT32 current_remainder) const
 
bool Decompose (const ON_3dVector &, const ON_3dVector &, const ON_3dVector &, double *, double *, double *) const
 
double Fuzz (double tolerance=ON_ZERO_TOLERANCE) const
 tolerance to use when comparing 3d vectors More...
 
bool IsNan () const
 
bool IsNotZero () const
 
int IsParallelTo (const ON_3dVector &other, double angle_tolerance=ON_DEFAULT_ANGLE_TOLERANCE) const
 
bool IsPerpendicularTo (const ON_3dVector &other, double angle_tolerance=ON_DEFAULT_ANGLE_TOLERANCE) const
 
bool IsTiny (double tiny_tol=ON_ZERO_TOLERANCE) const
 
bool IsUnitVector () const
 
bool IsUnset () const
 
bool IsUnsetOrNan () const
 
bool IsValid () const
 
bool IsZero () const
 
double Length () const
 
double LengthAndUnitize ()
 unitizes and returns initial length More...
 
double LengthSquared () const
 
double MaximumCoordinate () const
 absolute value of maximum coordinate More...
 
int MaximumCoordinateIndex () const
 
double MinimumCoordinate () const
 absolute value of minimum coordinate More...
 
int MinimumCoordinateIndex () const
 
 operator const double * () const
 
 operator double * ()
 (double*) conversion operators More...
 
bool operator!= (const ON_3dVector &) const
 
double operator* (const ON_3dPoint &) const
 inner (dot) product More...
 
double operator* (const ON_3dVector &) const
 DO NOT ADD ANY MORE overrides of += or -=. More...
 
double operator* (const ON_3fVector &) const
 inner (dot) product More...
 
ON_3dVector operator* (const ON_Xform &) const
 
ON_3dVector operator* (double) const
 
ON_3dVector operator* (float) const
 
ON_3dVector operator* (int) const
 
ON_3dVectoroperator*= (double)
 
ON_3dPoint operator+ (const ON_2dPoint &) const
 
ON_3dVector operator+ (const ON_2dVector &) const
 
ON_3dPoint operator+ (const ON_2fPoint &) const
 
ON_3dVector operator+ (const ON_2fVector &) const
 
ON_3dPoint operator+ (const ON_3dPoint &) const
 
ON_3dVector operator+ (const ON_3dVector &) const
 
ON_3dPoint operator+ (const ON_3fPoint &) const
 
ON_3dVector operator+ (const ON_3fVector &) const
 
ON_3dVectoroperator+= (const ON_3dVector &)
 
ON_3dVector operator- () const
 
ON_3dPoint operator- (const ON_2dPoint &) const
 
ON_3dVector operator- (const ON_2dVector &) const
 
ON_3dPoint operator- (const ON_2fPoint &) const
 
ON_3dVector operator- (const ON_2fVector &) const
 
ON_3dPoint operator- (const ON_3dPoint &) const
 
ON_3dVector operator- (const ON_3dVector &) const
 
ON_3dPoint operator- (const ON_3fPoint &) const
 
ON_3dVector operator- (const ON_3fVector &) const
 
ON_3dVectoroperator-= (const ON_3dVector &)
 
ON_3dVector operator/ (double) const
 
ON_3dVector operator/ (float) const
 
ON_3dVector operator/ (int) const
 
ON_3dVectoroperator/= (double)
 
bool operator< (const ON_3dVector &) const
 
bool operator<= (const ON_3dVector &) const
 dictionary order comparisons More...
 
ON_3dVectoroperator= (const double *)
 vector = double[3] support More...
 
ON_3dVectoroperator= (const float *)
 vector = float[3] support More...
 
ON_3dVectoroperator= (const ON_2dPoint &)
 
ON_3dVectoroperator= (const ON_2dVector &)
 use implicit operator=(const ON_3dVector&) More...
 
ON_3dVectoroperator= (const ON_2fPoint &)
 
ON_3dVectoroperator= (const ON_2fVector &)
 
ON_3dVectoroperator= (const ON_3dPoint &)
 
ON_3dVectoroperator= (const ON_3dVector &)=default
 
ON_3dVectoroperator= (const ON_3fPoint &)
 
ON_3dVectoroperator= (const ON_3fVector &)
 
bool operator== (const ON_3dVector &) const
 
bool operator> (const ON_3dVector &) const
 
bool operator>= (const ON_3dVector &) const
 
double & operator[] (int)
 index operators mimic double[3] behavior More...
 
double operator[] (int) const
 
double & operator[] (unsigned int)
 
double operator[] (unsigned int) const
 
const ON_3dVector Perpendicular (ON_3dVector failure_result) const
 
bool PerpendicularTo (const ON_3dPoint &, const ON_3dPoint &, const ON_3dPoint &)
 set this vector to be perpendicular to a plane defined by 3 points More...
 
bool PerpendicularTo (const ON_3dVector &)
 set this vector to be perpendicular to another vector More...
 
void Reverse ()
 negate all coordinates More...
 
void Rotate (double angle, const ON_3dVector &axis)
 
void Rotate (double sin_angle, double cos_angle, const ON_3dVector &axis)
 
void Set (double x, double y, double z)
 set 3d vector value More...
 
void Transform (const ON_Xform &)
 
bool Unitize ()
 returns false if vector has zero length More...
 
ON_3dVector UnitVector () const
 
void Zero ()
 set all coordinates to zero; More...
 

Static Public Member Functions

static int Compare (const ON_3dVector &lhs, const ON_3dVector &rhs)
 
static const ON_3dVector CrossProduct (ON_3dVector A, ON_3dVector B)
 
static double DotProduct (ON_3dVector A, ON_3dVector B)
 
static const ON_3dVectorUnitVector (int)
 

Public Attributes

double x
 
double y
 
double z
 

Static Public Attributes

static const ON_3dVector NanVector
 (ON_DBL_QNAN,ON_DBL_QNAN,ON_DBL_QNAN) More...
 
static const ON_3dVector UnsetVector
 (ON_UNSET_VALUE,ON_UNSET_VALUE,ON_UNSET_VALUE) More...
 
static const ON_3dVector XAxis
 (1.0,0.0,0.0) More...
 
static const ON_3dVector YAxis
 (0.0,1.0,0.0) More...
 
static const ON_3dVector ZAxis
 (0.0,0.0,1.0) More...
 
static const ON_3dVector ZeroVector
 (0.0,0.0,0.0) More...
 

Detailed Description

ON_3dVector

Constructor & Destructor Documentation

◆ ON_3dVector() [1/12]

ON_3dVector::ON_3dVector ( )
default

x,y,z not initialized

◆ ~ON_3dVector()

ON_3dVector::~ON_3dVector ( )
default

◆ ON_3dVector() [2/12]

ON_3dVector::ON_3dVector ( const ON_3dVector )
default

◆ ON_3dVector() [3/12]

ON_3dVector::ON_3dVector ( double  x,
double  y,
double  z 
)
explicit

◆ ON_3dVector() [4/12]

ON_3dVector::ON_3dVector ( const ON_2dVector )

from 2d vector

◆ ON_3dVector() [5/12]

ON_3dVector::ON_3dVector ( const ON_2dPoint )
explicit

from 2d point

◆ ON_3dVector() [6/12]

ON_3dVector::ON_3dVector ( const ON_3dPoint )

from 3d point

◆ ON_3dVector() [7/12]

ON_3dVector::ON_3dVector ( const double *  )
explicit

from double[3] array

◆ ON_3dVector() [8/12]

ON_3dVector::ON_3dVector ( const ON_2fVector )
explicit

from 2f vector

◆ ON_3dVector() [9/12]

ON_3dVector::ON_3dVector ( const ON_3fVector )

from 3f vector

◆ ON_3dVector() [10/12]

ON_3dVector::ON_3dVector ( const ON_2fPoint )
explicit

from 2f point

◆ ON_3dVector() [11/12]

ON_3dVector::ON_3dVector ( const ON_3fPoint )
explicit

from 3f point

◆ ON_3dVector() [12/12]

ON_3dVector::ON_3dVector ( const float *  )
explicit

from float[3] array

Member Function Documentation

◆ Compare()

static int ON_3dVector::Compare ( const ON_3dVector lhs,
const ON_3dVector rhs 
)
static

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

◆ CrossProduct()

static const ON_3dVector ON_3dVector::CrossProduct ( ON_3dVector  A,
ON_3dVector  B 
)
static

◆ DataCRC()

ON__UINT32 ON_3dVector::DataCRC ( ON__UINT32  current_remainder) const

◆ Decompose()

bool ON_3dVector::Decompose ( const ON_3dVector ,
const ON_3dVector ,
const ON_3dVector ,
double *  ,
double *  ,
double *   
) const

◆ DotProduct()

static double ON_3dVector::DotProduct ( ON_3dVector  A,
ON_3dVector  B 
)
static

◆ Fuzz()

double ON_3dVector::Fuzz ( double  tolerance = ON_ZERO_TOLERANCE) const

tolerance to use when comparing 3d vectors

◆ IsNan()

bool ON_3dVector::IsNan ( ) const

Returns: True if any coordinate is a nan.

◆ IsNotZero()

bool ON_3dVector::IsNotZero ( ) const

Returns: true if at lease one coordinate is not zero and no coordinates are unset or nans.

◆ IsParallelTo()

int ON_3dVector::IsParallelTo ( const ON_3dVector other,
double  angle_tolerance = ON_DEFAULT_ANGLE_TOLERANCE 
) const
Parameters
otherreturns 1: this and other vectors are parallel -1: this and other vectors are anti-parallel 0: this and other vectors are not parallel or at least one of the vectors is zero other vector
angle_toleranceoptional angle tolerance (radians)

◆ IsPerpendicularTo()

bool ON_3dVector::IsPerpendicularTo ( const ON_3dVector other,
double  angle_tolerance = ON_DEFAULT_ANGLE_TOLERANCE 
) const
Parameters
otherreturns true: this and other vectors are perpendicular false: this and other vectors are not perpendicular or at least one of the vectors is zero other vector
angle_toleranceoptional angle tolerance (radians)

◆ IsTiny()

bool ON_3dVector::IsTiny ( double  tiny_tol = ON_ZERO_TOLERANCE) const

Description: 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 && fabs(z) <= tiny_tol )

Parameters
tiny_toltiny_tol

◆ IsUnitVector()

bool ON_3dVector::IsUnitVector ( ) const

Returns: true if vector is valid and has length 1.

◆ IsUnset()

bool ON_3dVector::IsUnset ( ) const

Returns: True if any coordinate is ON_UNSET_VALUE or ON_UNSET_POSITIVE_VALUE

◆ IsUnsetOrNan()

bool ON_3dVector::IsUnsetOrNan ( ) const

Returns: True if any coordinate is ON_UNSET_VALUE, ON_UNSET_POSITIVE_VALUE, or a nan

◆ IsValid()

bool ON_3dVector::IsValid ( ) const

Returns: False if any coordinate is infinte, a nan, or ON_UNSET_VALUE.

◆ IsZero()

bool ON_3dVector::IsZero ( ) const

Returns: true if vector is the zero vector.

◆ Length()

double ON_3dVector::Length ( ) const

◆ LengthAndUnitize()

double ON_3dVector::LengthAndUnitize ( )

unitizes and returns initial length

◆ LengthSquared()

double ON_3dVector::LengthSquared ( ) const

◆ MaximumCoordinate()

double ON_3dVector::MaximumCoordinate ( ) const

absolute value of maximum coordinate

◆ MaximumCoordinateIndex()

int ON_3dVector::MaximumCoordinateIndex ( ) const

◆ MinimumCoordinate()

double ON_3dVector::MinimumCoordinate ( ) const

absolute value of minimum coordinate

◆ MinimumCoordinateIndex()

int ON_3dVector::MinimumCoordinateIndex ( ) const

◆ operator const double *()

ON_3dVector::operator const double * ( ) const

◆ operator double *()

ON_3dVector::operator double * ( )

(double*) conversion operators

◆ operator!=()

bool ON_3dVector::operator!= ( const ON_3dVector ) const

◆ operator*() [1/7]

double ON_3dVector::operator* ( const ON_3dPoint ) const

inner (dot) product

◆ operator*() [2/7]

double ON_3dVector::operator* ( const ON_3dVector ) const

DO NOT ADD ANY MORE overrides of += or -=.

inner (dot) product

◆ operator*() [3/7]

double ON_3dVector::operator* ( const ON_3fVector ) const

inner (dot) product

◆ operator*() [4/7]

ON_3dVector ON_3dVector::operator* ( const ON_Xform ) const

◆ operator*() [5/7]

ON_3dVector ON_3dVector::operator* ( double  ) const

◆ operator*() [6/7]

ON_3dVector ON_3dVector::operator* ( float  ) const

◆ operator*() [7/7]

ON_3dVector ON_3dVector::operator* ( int  ) const

◆ operator*=()

ON_3dVector& ON_3dVector::operator*= ( double  )

◆ operator+() [1/8]

ON_3dPoint ON_3dVector::operator+ ( const ON_2dPoint ) const

◆ operator+() [2/8]

ON_3dVector ON_3dVector::operator+ ( const ON_2dVector ) const

◆ operator+() [3/8]

ON_3dPoint ON_3dVector::operator+ ( const ON_2fPoint ) const

◆ operator+() [4/8]

ON_3dVector ON_3dVector::operator+ ( const ON_2fVector ) const

◆ operator+() [5/8]

ON_3dPoint ON_3dVector::operator+ ( const ON_3dPoint ) const

◆ operator+() [6/8]

ON_3dVector ON_3dVector::operator+ ( const ON_3dVector ) const

◆ operator+() [7/8]

ON_3dPoint ON_3dVector::operator+ ( const ON_3fPoint ) const

◆ operator+() [8/8]

ON_3dVector ON_3dVector::operator+ ( const ON_3fVector ) const

◆ operator+=()

ON_3dVector& ON_3dVector::operator+= ( const ON_3dVector )

◆ operator-() [1/9]

ON_3dVector ON_3dVector::operator- ( ) const

◆ operator-() [2/9]

ON_3dPoint ON_3dVector::operator- ( const ON_2dPoint ) const

◆ operator-() [3/9]

ON_3dVector ON_3dVector::operator- ( const ON_2dVector ) const

◆ operator-() [4/9]

ON_3dPoint ON_3dVector::operator- ( const ON_2fPoint ) const

◆ operator-() [5/9]

ON_3dVector ON_3dVector::operator- ( const ON_2fVector ) const

◆ operator-() [6/9]

ON_3dPoint ON_3dVector::operator- ( const ON_3dPoint ) const

◆ operator-() [7/9]

ON_3dVector ON_3dVector::operator- ( const ON_3dVector ) const

◆ operator-() [8/9]

ON_3dPoint ON_3dVector::operator- ( const ON_3fPoint ) const

◆ operator-() [9/9]

ON_3dVector ON_3dVector::operator- ( const ON_3fVector ) const

◆ operator-=()

ON_3dVector& ON_3dVector::operator-= ( const ON_3dVector )

◆ operator/() [1/3]

ON_3dVector ON_3dVector::operator/ ( double  ) const

◆ operator/() [2/3]

ON_3dVector ON_3dVector::operator/ ( float  ) const

◆ operator/() [3/3]

ON_3dVector ON_3dVector::operator/ ( int  ) const

◆ operator/=()

ON_3dVector& ON_3dVector::operator/= ( double  )

◆ operator<()

bool ON_3dVector::operator< ( const ON_3dVector ) const

◆ operator<=()

bool ON_3dVector::operator<= ( const ON_3dVector ) const

dictionary order comparisons

◆ operator=() [1/10]

ON_3dVector& ON_3dVector::operator= ( const double *  )

vector = double[3] support

◆ operator=() [2/10]

ON_3dVector& ON_3dVector::operator= ( const float *  )

vector = float[3] support

◆ operator=() [3/10]

ON_3dVector& ON_3dVector::operator= ( const ON_2dPoint )

◆ operator=() [4/10]

ON_3dVector& ON_3dVector::operator= ( const ON_2dVector )

◆ operator=() [5/10]

ON_3dVector& ON_3dVector::operator= ( const ON_2fPoint )

◆ operator=() [6/10]

ON_3dVector& ON_3dVector::operator= ( const ON_2fVector )

◆ operator=() [7/10]

ON_3dVector& ON_3dVector::operator= ( const ON_3dPoint )

◆ operator=() [8/10]

ON_3dVector& ON_3dVector::operator= ( const ON_3dVector )
default

◆ operator=() [9/10]

ON_3dVector& ON_3dVector::operator= ( const ON_3fPoint )

◆ operator=() [10/10]

ON_3dVector& ON_3dVector::operator= ( const ON_3fVector )

◆ operator==()

bool ON_3dVector::operator== ( const ON_3dVector ) const

◆ operator>()

bool ON_3dVector::operator> ( const ON_3dVector ) const

◆ operator>=()

bool ON_3dVector::operator>= ( const ON_3dVector ) const

◆ operator[]() [1/4]

double& ON_3dVector::operator[] ( int  )

index operators mimic double[3] behavior

◆ operator[]() [2/4]

double ON_3dVector::operator[] ( int  ) const

◆ operator[]() [3/4]

double& ON_3dVector::operator[] ( unsigned int  )

◆ operator[]() [4/4]

double ON_3dVector::operator[] ( unsigned int  ) const

◆ Perpendicular()

const ON_3dVector ON_3dVector::Perpendicular ( ON_3dVector  failure_result) const

Parameters: failure_result - [in] vector to return if this is zero or unset. When in doubt, pass ON_3dVector::NanVector. Returns: If this is nonzero, a vector perpindicular to this. The returned vector is not unitized. Otherwise failure_result is returned.

◆ PerpendicularTo() [1/2]

bool ON_3dVector::PerpendicularTo ( const ON_3dPoint ,
const ON_3dPoint ,
const ON_3dPoint  
)

set this vector to be perpendicular to a plane defined by 3 points

◆ PerpendicularTo() [2/2]

bool ON_3dVector::PerpendicularTo ( const ON_3dVector )

set this vector to be perpendicular to another vector

◆ Reverse()

void ON_3dVector::Reverse ( )

negate all coordinates

◆ Rotate() [1/2]

void ON_3dVector::Rotate ( double  angle,
const ON_3dVector axis 
)
Parameters
angleangle in radians
axisaxis of rotation

◆ Rotate() [2/2]

void ON_3dVector::Rotate ( double  sin_angle,
double  cos_angle,
const ON_3dVector axis 
)
Parameters
sin_anglesin(angle)
cos_anglecos(angle)
axisaxis of rotation

◆ Set()

void ON_3dVector::Set ( double  x,
double  y,
double  z 
)

set 3d vector value

◆ Transform()

void ON_3dVector::Transform ( const ON_Xform )

These transform the vector in place. The transformation matrix acts on the left of the vector; i.e., result = transformation*vector

◆ Unitize()

bool ON_3dVector::Unitize ( )

returns false if vector has zero length

◆ UnitVector() [1/2]

ON_3dVector ON_3dVector::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.

◆ UnitVector() [2/2]

static const ON_3dVector& ON_3dVector::UnitVector ( int  )
static

Description: A index driven function to get unit axis vectors. Parameters: index - [in] 0 returns (1,0,0), 1 returns (0,1,0), 2 returns (0,0,1) Returns: Unit 3d vector with vector[i] = (i==index)?1:0;

◆ Zero()

void ON_3dVector::Zero ( )

set all coordinates to zero;

Member Data Documentation

◆ NanVector

const ON_3dVector ON_3dVector::NanVector
static

(ON_DBL_QNAN,ON_DBL_QNAN,ON_DBL_QNAN)

◆ UnsetVector

const ON_3dVector ON_3dVector::UnsetVector
static

(ON_UNSET_VALUE,ON_UNSET_VALUE,ON_UNSET_VALUE)

◆ x

double ON_3dVector::x

◆ XAxis

const ON_3dVector ON_3dVector::XAxis
static

(1.0,0.0,0.0)

◆ y

double ON_3dVector::y

◆ YAxis

const ON_3dVector ON_3dVector::YAxis
static

(0.0,1.0,0.0)

◆ z

double ON_3dVector::z

◆ ZAxis

const ON_3dVector ON_3dVector::ZAxis
static

(0.0,0.0,1.0)

◆ ZeroVector

const ON_3dVector ON_3dVector::ZeroVector
static

(0.0,0.0,0.0)