DPoint3 Class Reference

#include <dpoint3.h>

Class Description

class DPoint3 Description: This class describes a 3D point using double precision x, y and z coordinates.

Methods are provided to add and subtract points, multiply and divide by scalars, and element by element multiply and divide two points. All methods are implemented by the system. Data Members: double x,y,z;

Inheritance diagram for DPoint3:

Public Member Functions
	DPoint3 ()
	Initializes all vector components to zero. More...
	DPoint3 (double X, double Y, double Z)
	Constructor. More...
	DPoint3 (const DPoint3 &a)
	Constructor. More...
	DPoint3 (const Point3 &a)
	DPoint3 (const double af[3])
	Constructor. More...
double &	operator[] (int i)
	Allows access to x, y and z using the subscript operator. More...
const double &	operator[] (int i) const
	Allows access to x, y and z using the subscript operator. More...
	operator double * ()
	Conversion function. More...
DPoint3	operator- () const
	Unary - operator. More...
DPoint3	operator+ () const
	Unary +. More...
DPoint3 &	operator= (const Point3 &a)
DPoint3 &	operator-= (const DPoint3 &)
	Subtracts a DPoint3 from this DPoint3. More...
DPoint3 &	operator+= (const DPoint3 &)
	Adds a DPoint3 to this DPoint3. More...
DPoint3 &	operator*= (const DPoint3 &)
	Member-wise multiplication of two vectors: (x*x, y*y, z*z) More...
DPoint3 &	operator*= (double)
	Each element of this DPoint3 is multiplied by the specified double. More...
DPoint3 &	operator/= (double)
	Each element of this DPoint3 is divided by the specified double. More...
DPoint3	operator- (const DPoint3 &) const
	Subtracts a DPoint3 from a DPoint3. More...
DPoint3	operator+ (const DPoint3 &) const
	Adds a DPoint3 to a DPoint3. More...
DPoint3	operator* (const DPoint3 &) const
	Member-wise multiplication of two vectors: (x*x, y*y, z*z) More...
DPoint3	operator^ (const DPoint3 &) const
	Computes the cross product of this DPoint3 and the specified DPoint3. More...
double	Length () const
	Returns the 'Length' of this point (vector). More...
double	LengthSquared () const
	The 'Length' squared of this point. More...
DPoint3 &	Unify ()
	in place normalize More...
int	MaxComponent () const
int	MinComponent () const
int	operator== (const DPoint3 &p) const
	Equality operator. More...
int	operator!= (const DPoint3 &p) const
	Equality operator. More...

Public Attributes
double	x
double	y
double	z

Static Public Attributes
static const DPoint3	Origin
	const for (0,0,0) More...
static const DPoint3	XAxis
	const for (1,0,0) More...
static const DPoint3	YAxis
	const for (0,1,0) More...
static const DPoint3	ZAxis
	const for (0,0,1) More...

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...

Constructor & Destructor Documentation

DPoint3 ( )

inline

Initializes all vector components to zero.

: x(0.0), y(0.0), z(0.0) {}

DPoint3 ( double  X, double  Y, double  Z  )

inline

Constructor.

x, y, and z are initialized to the values specified.

{ x = X; y = Y; z = Z;  }

DPoint3 ( const DPoint3 &  a )

inline

Constructor.

x, y, and z are initialized to the DPoint3 specified.

{ x = a.x; y = a.y; z = a.z; } 

DPoint3 ( const Point3 &  a )

inline

{ x = a.x; y = a.y; z = a.z; } 

DPoint3 ( const double  af[3] )

inline

Constructor.

x, y, and z are initialized to. af[0], af[1], and af[2] respectively. Operators:

{ x = af[0]; y = af[1]; z = af[2]; }

Member Function Documentation

double& operator[] ( int  i )

inline

Allows access to x, y and z using the subscript operator.

Returns

An index of 0 will return x, 1 will return y, 2 will return z.

{ DbgAssert((i >= 0) && (i <= 2)); return (&x)[i]; }

const double& operator[] ( int  i ) const

inline

Allows access to x, y and z using the subscript operator.

Returns

An index of 0 will return x, 1 will return y, 2 will return z.

{ DbgAssert((i >= 0) && (i <= 2)); return (&x)[i]; }

operator double * ( )

inline

Conversion function.

Returns the address of the DPoint3.x

{ return(&x); }

DPoint3 operator- ( ) const

inline

Unary - operator.

Negates both x, y and z.

{ return(DPoint3(-x,-y,-z)); } 

DPoint3 operator+ ( ) const

inline

Unary +.

Returns the point unaltered.

{ return *this; } 

DPoint3& operator= ( const Point3 &  a )

inline

{   x = a.x; y = a.y; z = a.z;  return *this; }

DPoint3 & operator-= ( const DPoint3 &  a )

inline

Subtracts a DPoint3 from this DPoint3.

                                                    {   
    x -= a.x;   y -= a.y;   z -= a.z;
    return *this;
    }

DPoint3 & operator+= ( const DPoint3 &  a )

inline

Adds a DPoint3 to this DPoint3.

                                                    {
    x += a.x;   y += a.y;   z += a.z;
    return *this;
    }

DPoint3 & operator*= ( const DPoint3 &  rhs )

inline

Member-wise multiplication of two vectors: (x*x, y*y, z*z)

{
    x *= rhs.x;
    y *= rhs.y;
    z *= rhs.z;
    return *this;
}

DPoint3 & operator*= ( double  f )

inline

Each element of this DPoint3 is multiplied by the specified double.

                                            {
    x *= f;   y *= f;   z *= f;
    return *this;
    }

DPoint3 & operator/= ( double  f )

inline

Each element of this DPoint3 is divided by the specified double.

                                            { 
    x /= f; y /= f; z /= f; 
    return *this; 
    }

DPoint3 operator- ( const DPoint3 &  b ) const

inline

Subtracts a DPoint3 from a DPoint3.

                                                        {
    return(DPoint3(x-b.x,y-b.y,z-b.z));
    }

DPoint3 operator+ ( const DPoint3 &  b ) const

inline

Adds a DPoint3 to a DPoint3.

                                                        {
    return(DPoint3(x+b.x,y+b.y,z+b.z));
    }

DPoint3 operator* ( const DPoint3 &  b ) const

inline

Member-wise multiplication of two vectors: (x*x, y*y, z*z)

                                                        {  
    return DPoint3(x * b.x, y * b.y, z * b.z);  
    }

DPoint3 operator^

(

const DPoint3 &

)

const

Computes the cross product of this DPoint3 and the specified DPoint3.

double Length

(

)

const

Returns the 'Length' of this point (vector).

This is:

sqrt(v.x*v.x+v.y*v.y+v.z*v.z)

double LengthSquared

(

)

const

The 'Length' squared of this point.

This is v.x*v.x+v.y*v.y+v.z*v.z.

DPoint3& Unify

(

)

in place normalize

int MaxComponent

(

)

const

Returns

The largest axis

int MinComponent

(

)

const

Returns

The smallest axis

int operator== ( const DPoint3 &  p ) const

inline

Equality operator.

Test for equality between two Point3's.

Returns

Nonzero if the Point3's are equal; otherwise 0.

                                                     { 
         return ((p.x==x)&&(p.y==y)&&(p.z==z)); 
     }

int operator!= ( const DPoint3 &  p ) const

inline

Equality operator.

Test for nonequality between two Point3's.

Returns

Nonzero if the Point3's are not equal; otherwise 0.

                                                     { 
         return ((p.x!=x)||(p.y!=y)||(p.z!=z)); 
     }

Member Data Documentation

double x

double y

double z

const DPoint3 Origin

static

const for (0,0,0)

const DPoint3 XAxis

static

const for (1,0,0)

const DPoint3 YAxis

static

const for (0,1,0)

const DPoint3 ZAxis

static

const for (0,0,1)