HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GfVec3d Class Reference

#include <vec3d.h>

Public Types

typedef double ScalarType
 Scalar element type and dimension. More...
 

Public Member Functions

 GfVec3d ()=default
 Default constructor does no initialization. More...
 
constexpr GfVec3d (double value)
 Initialize all elements to a single value. More...
 
constexpr GfVec3d (double s0, double s1, double s2)
 Initialize all elements with explicit arguments. More...
 
template<class Scl >
constexpr GfVec3d (Scl const *p)
 Construct with pointer to values. More...
 
 GfVec3d (class GfVec3f const &other)
 Implicitly convert from GfVec3f. More...
 
 GfVec3d (class GfVec3h const &other)
 Implicitly convert from GfVec3h. More...
 
 GfVec3d (class GfVec3i const &other)
 Implicitly convert from GfVec3i. More...
 
GfVec3dSet (double s0, double s1, double s2)
 Set all elements with passed arguments. More...
 
GfVec3dSet (double const *a)
 Set all elements with a pointer to data. More...
 
double constdata () const
 Direct data access. More...
 
double * data ()
 
double constGetArray () const
 
double constoperator[] (size_t i) const
 Indexing. More...
 
double & operator[] (size_t i)
 
bool operator== (GfVec3d const &other) const
 Equality comparison. More...
 
bool operator!= (GfVec3d const &other) const
 
GF_API bool operator== (class GfVec3f const &other) const
 Equality comparison. More...
 
GF_API bool operator== (class GfVec3h const &other) const
 Equality comparison. More...
 
GF_API bool operator== (class GfVec3i const &other) const
 Equality comparison. More...
 
GfVec3d operator- () const
 Create a vec with negated elements. More...
 
GfVec3doperator+= (GfVec3d const &other)
 Addition. More...
 
GfVec3doperator-= (GfVec3d const &other)
 Subtraction. More...
 
GfVec3doperator*= (double s)
 Multiplication by scalar. More...
 
GfVec3d operator* (double s) const
 
GfVec3doperator/= (double s)
 Division by scalar. More...
 
GfVec3d operator/ (double s) const
 
double operator* (GfVec3d const &v) const
 See GfDot(). More...
 
GfVec3d GetProjection (GfVec3d const &v) const
 
GfVec3d GetComplement (GfVec3d const &b) const
 
double GetLengthSq () const
 Squared length. More...
 
double GetLength () const
 Length. More...
 
double Normalize (double eps=GF_MIN_VECTOR_LENGTH)
 
GfVec3d GetNormalized (double eps=GF_MIN_VECTOR_LENGTH) const
 
GF_API void BuildOrthonormalFrame (GfVec3d *v1, GfVec3d *v2, double eps=GF_MIN_VECTOR_LENGTH) const
 

Static Public Member Functions

static GfVec3d XAxis ()
 Create a unit vector along the X-axis. More...
 
static GfVec3d YAxis ()
 Create a unit vector along the Y-axis. More...
 
static GfVec3d ZAxis ()
 Create a unit vector along the Z-axis. More...
 
static GfVec3d Axis (size_t i)
 
static GF_API bool OrthogonalizeBasis (GfVec3d *tx, GfVec3d *ty, GfVec3d *tz, const bool normalize, double eps=GF_MIN_ORTHO_TOLERANCE)
 

Static Public Attributes

static const size_t dimension = 3
 

Friends

size_t hash_value (GfVec3d const &vec)
 Hash. More...
 
GfVec3d operator+ (GfVec3d const &l, GfVec3d const &r)
 
GfVec3d operator- (GfVec3d const &l, GfVec3d const &r)
 
GfVec3d operator* (double s, GfVec3d const &v)
 

Detailed Description

Basic type for a vector of 3 double components.

Represents a vector of 3 components of type double. It is intended to be fast and simple.

Definition at line 63 of file vec3d.h.

Member Typedef Documentation

typedef double GfVec3d::ScalarType

Scalar element type and dimension.

Definition at line 67 of file vec3d.h.

Constructor & Destructor Documentation

GfVec3d::GfVec3d ( )
default

Default constructor does no initialization.

constexpr GfVec3d::GfVec3d ( double  value)
inlineexplicit

Initialize all elements to a single value.

Definition at line 74 of file vec3d.h.

constexpr GfVec3d::GfVec3d ( double  s0,
double  s1,
double  s2 
)
inline

Initialize all elements with explicit arguments.

Definition at line 80 of file vec3d.h.

template<class Scl >
constexpr GfVec3d::GfVec3d ( Scl const p)
inlineexplicit

Construct with pointer to values.

Definition at line 87 of file vec3d.h.

Implicitly convert from GfVec3f.

Definition at line 331 of file vec3d.h.

GfVec3d::GfVec3d ( class GfVec3h const other)
inline

Implicitly convert from GfVec3h.

Definition at line 338 of file vec3d.h.

GfVec3d::GfVec3d ( class GfVec3i const other)
inline

Implicitly convert from GfVec3i.

Definition at line 345 of file vec3d.h.

Member Function Documentation

static GfVec3d GfVec3d::Axis ( size_t  i)
inlinestatic

Create a unit vector along the i-th axis, zero-based. Return the zero vector if i is greater than or equal to 3.

Definition at line 122 of file vec3d.h.

GF_API void GfVec3d::BuildOrthonormalFrame ( GfVec3d v1,
GfVec3d v2,
double  eps = GF_MIN_VECTOR_LENGTH 
) const

Sets v1 and v2 to unit vectors such that v1, v2 and *this are mutually orthogonal. If the length L of *this is smaller than eps, then v1 and v2 will have magnitude L/eps. As a result, the function delivers a continuous result as *this shrinks in length.

double const* GfVec3d::data ( ) const
inline

Direct data access.

Definition at line 143 of file vec3d.h.

double* GfVec3d::data ( )
inline

Definition at line 144 of file vec3d.h.

double const* GfVec3d::GetArray ( ) const
inline

Definition at line 145 of file vec3d.h.

GfVec3d GfVec3d::GetComplement ( GfVec3d const b) const
inline

Returns the orthogonal complement of this->GetProjection(b). That is:

*this - this->GetProjection(b)

Definition at line 252 of file vec3d.h.

double GfVec3d::GetLength ( ) const
inline

Length.

Definition at line 262 of file vec3d.h.

double GfVec3d::GetLengthSq ( ) const
inline

Squared length.

Definition at line 257 of file vec3d.h.

GfVec3d GfVec3d::GetNormalized ( double  eps = GF_MIN_VECTOR_LENGTH) const
inline

Definition at line 283 of file vec3d.h.

GfVec3d GfVec3d::GetProjection ( GfVec3d const v) const
inline

Returns the projection of this onto v. That is:

v * (*this * v)

Definition at line 243 of file vec3d.h.

double GfVec3d::Normalize ( double  eps = GF_MIN_VECTOR_LENGTH)
inline

Normalizes the vector in place to unit length, returning the length before normalization. If the length of the vector is smaller than eps, then the vector is set to vector/eps. The original length of the vector is returned. See also GfNormalize().

Todo:
This was fixed for bug 67777. This is a gcc64 optimizer bug. By tickling the code, it no longer tries to write into an illegal memory address (in the code section of memory).

Definition at line 275 of file vec3d.h.

bool GfVec3d::operator!= ( GfVec3d const other) const
inline

Definition at line 166 of file vec3d.h.

GfVec3d GfVec3d::operator* ( double  s) const
inline

Definition at line 215 of file vec3d.h.

double GfVec3d::operator* ( GfVec3d const v) const
inline

See GfDot().

Definition at line 235 of file vec3d.h.

GfVec3d& GfVec3d::operator*= ( double  s)
inline

Multiplication by scalar.

Definition at line 209 of file vec3d.h.

GfVec3d& GfVec3d::operator+= ( GfVec3d const other)
inline

Addition.

Definition at line 187 of file vec3d.h.

GfVec3d GfVec3d::operator- ( ) const
inline

Create a vec with negated elements.

Definition at line 182 of file vec3d.h.

GfVec3d& GfVec3d::operator-= ( GfVec3d const other)
inline

Subtraction.

Definition at line 198 of file vec3d.h.

GfVec3d GfVec3d::operator/ ( double  s) const
inline

Definition at line 230 of file vec3d.h.

GfVec3d& GfVec3d::operator/= ( double  s)
inline

Division by scalar.

Definition at line 224 of file vec3d.h.

bool GfVec3d::operator== ( GfVec3d const other) const
inline

Equality comparison.

Definition at line 161 of file vec3d.h.

GF_API bool GfVec3d::operator== ( class GfVec3f const other) const

Equality comparison.

GF_API bool GfVec3d::operator== ( class GfVec3h const other) const

Equality comparison.

GF_API bool GfVec3d::operator== ( class GfVec3i const other) const

Equality comparison.

double const& GfVec3d::operator[] ( size_t  i) const
inline

Indexing.

Definition at line 148 of file vec3d.h.

double& GfVec3d::operator[] ( size_t  i)
inline

Definition at line 149 of file vec3d.h.

static GF_API bool GfVec3d::OrthogonalizeBasis ( GfVec3d tx,
GfVec3d ty,
GfVec3d tz,
const bool  normalize,
double  eps = GF_MIN_ORTHO_TOLERANCE 
)
static

Orthogonalize and optionally normalize a set of basis vectors. This uses an iterative method that is very stable even when the vectors are far from orthogonal (close to colinear). The number of iterations and thus the computation time does increase as the vectors become close to colinear, however. Returns a bool specifying whether the solution converged after a number of iterations. If it did not converge, the returned vectors will be as close as possible to orthogonal within the iteration limit. Colinear vectors will be unaltered, and the method will return false.

GfVec3d& GfVec3d::Set ( double  s0,
double  s1,
double  s2 
)
inline

Set all elements with passed arguments.

Definition at line 130 of file vec3d.h.

GfVec3d& GfVec3d::Set ( double const a)
inline

Set all elements with a pointer to data.

Definition at line 138 of file vec3d.h.

static GfVec3d GfVec3d::XAxis ( )
inlinestatic

Create a unit vector along the X-axis.

Definition at line 102 of file vec3d.h.

static GfVec3d GfVec3d::YAxis ( )
inlinestatic

Create a unit vector along the Y-axis.

Definition at line 108 of file vec3d.h.

static GfVec3d GfVec3d::ZAxis ( )
inlinestatic

Create a unit vector along the Z-axis.

Definition at line 114 of file vec3d.h.

Friends And Related Function Documentation

size_t hash_value ( GfVec3d const vec)
friend

Hash.

Definition at line 152 of file vec3d.h.

GfVec3d operator* ( double  s,
GfVec3d const v 
)
friend

Definition at line 218 of file vec3d.h.

GfVec3d operator+ ( GfVec3d const l,
GfVec3d const r 
)
friend

Definition at line 193 of file vec3d.h.

GfVec3d operator- ( GfVec3d const l,
GfVec3d const r 
)
friend

Definition at line 204 of file vec3d.h.

Member Data Documentation

const size_t GfVec3d::dimension = 3
static

Definition at line 68 of file vec3d.h.


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