This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
GfVec2d Class Reference

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

#include <vec2d.h>

Public Types

typedef double ScalarType
 Scalar element type and dimension.
 

Public Member Functions

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

Static Public Member Functions

static GfVec2d XAxis ()
 Create a unit vector along the X-axis.
 
static GfVec2d YAxis ()
 Create a unit vector along the Y-axis.
 
static GfVec2d Axis (size_t i)
 Create a unit vector along the i-th axis, zero-based.
 

Static Public Attributes

static const size_t dimension = 2
 

Friends

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

Detailed Description

Basic type for a vector of 2 double components.

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

Definition at line 45 of file vec2d.h.

Member Typedef Documentation

◆ ScalarType

typedef double ScalarType

Scalar element type and dimension.

Definition at line 49 of file vec2d.h.

Constructor & Destructor Documentation

◆ GfVec2d() [1/7]

GfVec2d ( )
default

Default constructor does no initialization.

◆ GfVec2d() [2/7]

constexpr GfVec2d ( double  value)
inlineexplicitconstexpr

Initialize all elements to a single value.

Definition at line 56 of file vec2d.h.

◆ GfVec2d() [3/7]

constexpr GfVec2d ( double  s0,
double  s1 
)
inlineconstexpr

Initialize all elements with explicit arguments.

Definition at line 62 of file vec2d.h.

◆ GfVec2d() [4/7]

constexpr GfVec2d ( Scl const *  p)
inlineexplicitconstexpr

Construct with pointer to values.

Definition at line 69 of file vec2d.h.

◆ GfVec2d() [5/7]

GfVec2d ( class GfVec2f const &  other)
inline

Implicitly convert from GfVec2f.

Definition at line 274 of file vec2d.h.

◆ GfVec2d() [6/7]

GfVec2d ( class GfVec2h const &  other)
inline

Implicitly convert from GfVec2h.

Definition at line 280 of file vec2d.h.

◆ GfVec2d() [7/7]

GfVec2d ( class GfVec2i const &  other)
inline

Implicitly convert from GfVec2i.

Definition at line 286 of file vec2d.h.

Member Function Documentation

◆ Axis()

static GfVec2d 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 2.

Definition at line 98 of file vec2d.h.

◆ data() [1/2]

double * data ( )
inline

Definition at line 119 of file vec2d.h.

◆ data() [2/2]

double const * data ( ) const
inline

Direct data access.

Definition at line 118 of file vec2d.h.

◆ GetArray()

double const * GetArray ( ) const
inline

Definition at line 120 of file vec2d.h.

◆ GetComplement()

GfVec2d GetComplement ( GfVec2d const &  b) const
inline

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

That is:

*this - this->GetProjection(b)
GfVec2d GetProjection(GfVec2d const &v) const
Returns the projection of this onto v.
Definition: vec2d.h:210

Definition at line 219 of file vec2d.h.

◆ GetLength()

double GetLength ( ) const
inline

Length.

Definition at line 229 of file vec2d.h.

◆ GetLengthSq()

double GetLengthSq ( ) const
inline

Squared length.

Definition at line 224 of file vec2d.h.

◆ GetNormalized()

GfVec2d GetNormalized ( double  eps = GF_MIN_VECTOR_LENGTH) const
inline

Definition at line 249 of file vec2d.h.

◆ GetProjection()

GfVec2d GetProjection ( GfVec2d const &  v) const
inline

Returns the projection of this onto v.

That is:

v * (*this * v)

Definition at line 210 of file vec2d.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 241 of file vec2d.h.

◆ operator!=()

bool operator!= ( GfVec2d const &  other) const
inline

Definition at line 136 of file vec2d.h.

◆ operator*() [1/2]

GfVec2d operator* ( double  s) const
inline

Definition at line 182 of file vec2d.h.

◆ operator*() [2/2]

double operator* ( GfVec2d const &  v) const
inline

See GfDot().

Definition at line 202 of file vec2d.h.

◆ operator*=()

GfVec2d & operator*= ( double  s)
inline

Multiplication by scalar.

Definition at line 177 of file vec2d.h.

◆ operator+=()

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

Addition.

Definition at line 157 of file vec2d.h.

◆ operator-()

GfVec2d operator- ( ) const
inline

Create a vec with negated elements.

Definition at line 152 of file vec2d.h.

◆ operator-=()

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

Subtraction.

Definition at line 167 of file vec2d.h.

◆ operator/()

GfVec2d operator/ ( double  s) const
inline

Definition at line 197 of file vec2d.h.

◆ operator/=()

GfVec2d & operator/= ( double  s)
inline

Division by scalar.

Definition at line 191 of file vec2d.h.

◆ operator==() [1/4]

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

Equality comparison.

◆ operator==() [2/4]

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

Equality comparison.

◆ operator==() [3/4]

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

Equality comparison.

◆ operator==() [4/4]

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

Equality comparison.

Definition at line 132 of file vec2d.h.

◆ operator[]() [1/2]

double & operator[] ( size_t  i)
inline

Definition at line 124 of file vec2d.h.

◆ operator[]() [2/2]

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

Indexing.

Definition at line 123 of file vec2d.h.

◆ Set() [1/2]

GfVec2d & Set ( double const *  a)
inline

Set all elements with a pointer to data.

Definition at line 113 of file vec2d.h.

◆ Set() [2/2]

GfVec2d & Set ( double  s0,
double  s1 
)
inline

Set all elements with passed arguments.

Definition at line 106 of file vec2d.h.

◆ XAxis()

static GfVec2d XAxis ( )
inlinestatic

Create a unit vector along the X-axis.

Definition at line 84 of file vec2d.h.

◆ YAxis()

static GfVec2d YAxis ( )
inlinestatic

Create a unit vector along the Y-axis.

Definition at line 90 of file vec2d.h.

Friends And Related Function Documentation

◆ hash_value

size_t hash_value ( GfVec2d const &  vec)
friend

Hash.

Definition at line 127 of file vec2d.h.

◆ operator*

GfVec2d operator* ( double  s,
GfVec2d const &  v 
)
friend

Definition at line 185 of file vec2d.h.

◆ operator+

GfVec2d operator+ ( GfVec2d const &  l,
GfVec2d const &  r 
)
friend

Definition at line 162 of file vec2d.h.

◆ operator-

GfVec2d operator- ( GfVec2d const &  l,
GfVec2d const &  r 
)
friend

Definition at line 172 of file vec2d.h.

Member Data Documentation

◆ dimension

const size_t dimension = 2
static

Definition at line 50 of file vec2d.h.


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