Ravelin
Public Member Functions | Static Public Member Functions | List of all members
ORIGIN3 Class Reference

A three-dimensional floating point vector used for representing points and vectors in 3D and without associated frame information. More...

#include <Origin3.h>

Public Member Functions

 ORIGIN3 (REAL x, REAL y, REAL z)
 Constructs this origin with the given values.
 
 ORIGIN3 (const REAL *array)
 Constructs this origin from the given array. More...
 
 ORIGIN3 (const CONST_SHAREDVECTORN &v)
 
 ORIGIN3 (const SHAREDVECTORN &v)
 
 ORIGIN3 (const VECTOR3 &v)
 
REAL norm_inf () const
 
REAL norm () const
 
REAL norm_sq () const
 
void normalize ()
 
REAL dot (const ORIGIN3 &v) const
 
ORIGIN3set_zero ()
 
ORIGIN3set_zero (unsigned m)
 
ORIGIN3set_zero (unsigned m, unsigned n)
 
ORIGIN3operator= (const ORIGIN3 &o)
 Assigns the values from one origin to this origin.
 
ORIGIN3operator= (const VECTOR3 &v)
 Assigns this origin using the 3D vector.
 
ORIGIN3operator= (const CONST_SHAREDVECTORN &v)
 Copies a matrix to this one.
 
ORIGIN3operator= (const SHAREDVECTORN &v)
 Copies a matrix to this one.
 
ORIGIN3 operator+ (const ORIGIN3 &o) const
 Adds two origins.
 
VECTOR3 operator+ (const VECTOR3 &v) const
 Adds a vector to an origin.
 
ORIGIN3 operator- (const ORIGIN3 &v) const
 Subtracts one origin from another.
 
VECTOR3 operator- (const VECTOR3 &v) const
 Subtracts a vector from an origin.
 
ORIGIN3operator+= (const ORIGIN3 &v)
 Adds two origins.
 
ORIGIN3operator-= (const ORIGIN3 &v)
 Subtracts an origin from this.
 
ORIGIN3operator*= (REAL scalar)
 
ORIGIN3operator/= (REAL scalar)
 
ORIGIN3 operator* (REAL scalar) const
 
ORIGIN3 operator/ (REAL scalar) const
 
ORIGIN3 operator- () const
 
REAL * data ()
 
const REAL * data () const
 
REAL & operator[] (const unsigned i)
 
const REAL & operator[] (const unsigned i) const
 
REAL * data (unsigned i)
 
const REAL * data (unsigned i) const
 
const REAL & x () const
 
const REAL & y () const
 
const REAL & z () const
 
REAL & x ()
 
REAL & y ()
 
REAL & z ()
 
COLUMN_ITERATOR begin ()
 
CONST_COLUMN_ITERATOR begin () const
 
COLUMN_ITERATOR end ()
 
CONST_COLUMN_ITERATOR end () const
 
COLUMN_ITERATOR column_iterator_begin ()
 
CONST_COLUMN_ITERATOR column_iterator_begin () const
 
COLUMN_ITERATOR column_iterator_end ()
 
CONST_COLUMN_ITERATOR column_iterator_end () const
 
ROW_ITERATOR row_iterator_begin ()
 
CONST_ROW_ITERATOR row_iterator_begin () const
 
ROW_ITERATOR row_iterator_end ()
 
CONST_ROW_ITERATOR row_iterator_end () const
 
unsigned size () const
 
unsigned rows () const
 
unsigned columns () const
 
unsigned inc () const
 
unsigned leading_dim () const
 
ORIGIN3resize (unsigned m, bool preserve=false)
 Does nothing.
 
ORIGIN3resize (unsigned m, unsigned n, bool preserve=false)
 Does nothing.
 

Static Public Member Functions

static REAL norm (const ORIGIN3 &v)
 
static REAL norm_sq (const ORIGIN3 &v)
 
static ORIGIN3 normalize (const ORIGIN3 &v)
 
static REAL dot (const ORIGIN3 &v1, const ORIGIN3 &v2)
 
static ORIGIN3 zero ()
 
static ORIGIN3 cross (const ORIGIN3 &v1, const ORIGIN3 &v2)
 Computes the cross-product of two vectors.
 

Detailed Description

A three-dimensional floating point vector used for representing points and vectors in 3D and without associated frame information.

Constructor & Destructor Documentation

ORIGIN3::ORIGIN3 ( const REAL *  array)

Constructs this origin from the given array.

Parameters
arraya 3-dimensional (or larger) array

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