GfVec4d Class Reference

Basic type for a vector of 4 double components. More...

Public Types

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

Public Member Functions

 GfVec4d ()=default
 Default constructor does no initialization. More...
 
constexpr GfVec4d (double value)
 Initialize all elements to a single value. More...
 
constexpr GfVec4d (double s0, double s1, double s2, double s3)
 Initialize all elements with explicit arguments. More...
 
template<class Scl >
constexpr GfVec4d (Scl const *p)
 Construct with pointer to values. More...
 
 GfVec4d (class GfVec4f const &other)
 Implicitly convert from GfVec4f. More...
 
 GfVec4d (class GfVec4h const &other)
 Implicitly convert from GfVec4h. More...
 
 GfVec4d (class GfVec4i const &other)
 Implicitly convert from GfVec4i. More...
 
GfVec4dSet (double s0, double s1, double s2, double s3)
 Set all elements with passed arguments. More...
 
GfVec4dSet (double const *a)
 Set all elements with a pointer to data. More...
 
double const * data () const
 Direct data access. More...
 
double * data ()
 
double const * GetArray () const
 
double const & operator[] (size_t i) const
 Indexing. More...
 
double & operator[] (size_t i)
 
bool operator== (GfVec4d const &other) const
 Equality comparison. More...
 
bool operator!= (GfVec4d const &other) const
 
GF_API bool operator== (class GfVec4f const &other) const
 Equality comparison. More...
 
GF_API bool operator== (class GfVec4h const &other) const
 Equality comparison. More...
 
GF_API bool operator== (class GfVec4i const &other) const
 Equality comparison. More...
 
GfVec4d operator- () const
 Create a vec with negated elements. More...
 
GfVec4doperator+= (GfVec4d const &other)
 Addition. More...
 
GfVec4doperator-= (GfVec4d const &other)
 Subtraction. More...
 
GfVec4doperator *= (double s)
 Multiplication by scalar. More...
 
GfVec4d operator * (double s) const
 
GfVec4doperator/= (double s)
 Division by scalar. More...
 
GfVec4d operator/ (double s) const
 
double operator * (GfVec4d const &v) const
 See GfDot(). More...
 
GfVec4d GetProjection (GfVec4d const &v) const
 Returns the projection of this onto v. More...
 
GfVec4d GetComplement (GfVec4d const &b) const
 Returns the orthogonal complement of this->GetProjection(b). More...
 
double GetLengthSq () const
 Squared length. More...
 
double GetLength () const
 Length. More...
 
double Normalize (double eps=GF_MIN_VECTOR_LENGTH)
 Normalizes the vector in place to unit length, returning the length before normalization. More...
 
GfVec4d GetNormalized (double eps=GF_MIN_VECTOR_LENGTH) const
 

Static Public Member Functions

static GfVec4d XAxis ()
 Create a unit vector along the X-axis. More...
 
static GfVec4d YAxis ()
 Create a unit vector along the Y-axis. More...
 
static GfVec4d ZAxis ()
 Create a unit vector along the Z-axis. More...
 
static GfVec4d WAxis ()
 Create a unit vector along the W-axis. More...
 
static GfVec4d Axis (size_t i)
 Create a unit vector along the i-th axis, zero-based. More...
 

Static Public Attributes

static const size_t dimension = 4
 

Friends

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

Detailed Description

Basic type for a vector of 4 double components.

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

Definition at line 63 of file vec4d.h.

Member Typedef Documentation

◆ ScalarType

typedef double ScalarType

Scalar element type and dimension.

Definition at line 67 of file vec4d.h.

Constructor & Destructor Documentation

◆ GfVec4d() [1/7]

GfVec4d ( )
default

Default constructor does no initialization.

◆ GfVec4d() [2/7]

constexpr GfVec4d ( double  value)
inlineexplicit

Initialize all elements to a single value.

Definition at line 74 of file vec4d.h.

◆ GfVec4d() [3/7]

constexpr GfVec4d ( double  s0,
double  s1,
double  s2,
double  s3 
)
inline

Initialize all elements with explicit arguments.

Definition at line 80 of file vec4d.h.

◆ GfVec4d() [4/7]

constexpr GfVec4d ( Scl const *  p)
inlineexplicit

Construct with pointer to values.

Definition at line 87 of file vec4d.h.

◆ GfVec4d() [5/7]

GfVec4d ( class GfVec4f const &  other)
inline

Implicitly convert from GfVec4f.

Definition at line 320 of file vec4d.h.

◆ GfVec4d() [6/7]

GfVec4d ( class GfVec4h const &  other)
inline

Implicitly convert from GfVec4h.

Definition at line 328 of file vec4d.h.

◆ GfVec4d() [7/7]

GfVec4d ( class GfVec4i const &  other)
inline

Implicitly convert from GfVec4i.

Definition at line 336 of file vec4d.h.

Member Function Documentation

◆ Axis()

static GfVec4d 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 4.

Definition at line 128 of file vec4d.h.

◆ data()

double const* data ( ) const
inline

Direct data access.

Definition at line 150 of file vec4d.h.

◆ GetComplement()

GfVec4d GetComplement ( GfVec4d const &  b) const
inline

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

That is:

*this - this->GetProjection(b)

Definition at line 264 of file vec4d.h.

◆ GetLength()

double GetLength ( ) const
inline

Length.

Definition at line 274 of file vec4d.h.

◆ GetLengthSq()

double GetLengthSq ( ) const
inline

Squared length.

Definition at line 269 of file vec4d.h.

◆ GetProjection()

GfVec4d GetProjection ( GfVec4d const &  v) const
inline

Returns the projection of this onto v.

That is:

v * (*this * v)

Definition at line 255 of file vec4d.h.

◆ Normalize()

double 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().

Definition at line 287 of file vec4d.h.

◆ operator *()

double operator * ( GfVec4d const &  v) const
inline

See GfDot().

Definition at line 247 of file vec4d.h.

◆ operator *=()

GfVec4d& operator *= ( double  s)
inline

Multiplication by scalar.

Definition at line 220 of file vec4d.h.

◆ operator+=()

GfVec4d& operator+= ( GfVec4d const &  other)
inline

Addition.

Definition at line 196 of file vec4d.h.

◆ operator-()

GfVec4d operator- ( ) const
inline

Create a vec with negated elements.

Definition at line 191 of file vec4d.h.

◆ operator-=()

GfVec4d& operator-= ( GfVec4d const &  other)
inline

Subtraction.

Definition at line 208 of file vec4d.h.

◆ operator/=()

GfVec4d& operator/= ( double  s)
inline

Division by scalar.

Definition at line 236 of file vec4d.h.

◆ operator==() [1/4]

bool operator== ( GfVec4d const &  other) const
inline

Equality comparison.

Definition at line 169 of file vec4d.h.

◆ operator==() [2/4]

GF_API bool operator== ( class GfVec4f const &  other) const

Equality comparison.

◆ operator==() [3/4]

GF_API bool operator== ( class GfVec4h const &  other) const

Equality comparison.

◆ operator==() [4/4]

GF_API bool operator== ( class GfVec4i const &  other) const

Equality comparison.

◆ operator[]()

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

Indexing.

Definition at line 155 of file vec4d.h.

◆ Set() [1/2]

GfVec4d& Set ( double  s0,
double  s1,
double  s2,
double  s3 
)
inline

Set all elements with passed arguments.

Definition at line 136 of file vec4d.h.

◆ Set() [2/2]

GfVec4d& Set ( double const *  a)
inline

Set all elements with a pointer to data.

Definition at line 145 of file vec4d.h.

◆ WAxis()

static GfVec4d WAxis ( )
inlinestatic

Create a unit vector along the W-axis.

Definition at line 120 of file vec4d.h.

◆ XAxis()

static GfVec4d XAxis ( )
inlinestatic

Create a unit vector along the X-axis.

Definition at line 102 of file vec4d.h.

◆ YAxis()

static GfVec4d YAxis ( )
inlinestatic

Create a unit vector along the Y-axis.

Definition at line 108 of file vec4d.h.

◆ ZAxis()

static GfVec4d ZAxis ( )
inlinestatic

Create a unit vector along the Z-axis.

Definition at line 114 of file vec4d.h.

Friends And Related Function Documentation

◆ hash_value

size_t hash_value ( GfVec4d const &  vec)
friend

Hash.

Definition at line 159 of file vec4d.h.


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