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

#include <vec2h.h>

Public Types
typedef GfHalf	ScalarType
	Scalar element type and dimension.

Public Member Functions
	GfVec2h ()=default
	GfVec2h value-initializes to zero and performs no default initialization, like float or double.

constexpr	GfVec2h (GfHalf value)
	Initialize all elements to a single value.

constexpr	GfVec2h (GfHalf s0, GfHalf s1)
	Initialize all elements with explicit arguments.

template<class Scl >
constexpr	GfVec2h (Scl const *p)
	Construct with pointer to values.

	GfVec2h (class GfVec2d const &other)
	Construct from GfVec2d.

	GfVec2h (class GfVec2f const &other)
	Construct from GfVec2f.

	GfVec2h (class GfVec2i const &other)
	Implicitly convert from GfVec2i.

GfVec2h &	Set (GfHalf s0, GfHalf s1)
	Set all elements with passed arguments.

GfVec2h &	Set (GfHalf const *a)
	Set all elements with a pointer to data.

GfHalf const *	data () const
	Direct data access.

GfHalf *	data ()

GfHalf const *	GetArray () const

GfHalf const &	operator[] (size_t i) const
	Indexing.

GfHalf &	operator[] (size_t i)

bool	operator== (GfVec2h const &other) const
	Equality comparison.

bool	operator!= (GfVec2h const &other) const

GF_API bool	operator== (class GfVec2d const &other) const
	Equality comparison.

GF_API bool	operator== (class GfVec2f const &other) const
	Equality comparison.

GF_API bool	operator== (class GfVec2i const &other) const
	Equality comparison.

GfVec2h	operator- () const
	Create a vec with negated elements.

GfVec2h &	operator+= (GfVec2h const &other)
	Addition.

GfVec2h &	operator-= (GfVec2h const &other)
	Subtraction.

GfVec2h &	operator*= (double s)
	Multiplication by scalar.

GfVec2h	operator* (double s) const

GfVec2h &	operator/= (double s)
	Division by scalar.

GfVec2h	operator/ (double s) const

GfHalf	operator* (GfVec2h const &v) const
	See GfDot().

GfVec2h	GetProjection (GfVec2h const &v) const
	Returns the projection of `this` onto `v`.

GfVec2h	GetComplement (GfVec2h const &b) const
	Returns the orthogonal complement of `this->GetProjection(b)`.

GfHalf	GetLengthSq () const
	Squared length.

GfHalf	GetLength () const
	Length.

GfHalf	Normalize (GfHalf eps=0.001)
	Normalizes the vector in place to unit length, returning the length before normalization.

GfVec2h	GetNormalized (GfHalf eps=0.001) const

Swizzles
Each accessor returns a new vector built from this one's components, in the order named. For example yx() returns GfVec2h(y, x). Every permutation of 2 to 2 of the 2 components is available. Repeated components (`xx`, `xyy`) are not; nor are single-component swizzles, which are just the components themselves. The results are ordinary GfVecs, so all the usual operators, GfDot() and so on apply to them. They are values, not references into this vector, so they cannot be assigned through.
constexpr GfVec2h	xy () const

constexpr GfVec2h	yx () const

Static Public Member Functions
static GfVec2h	XAxis ()
	Create a unit vector along the X-axis.

static GfVec2h	YAxis ()
	Create a unit vector along the Y-axis.

static GfVec2h	Axis (size_t i)
	Create a unit vector along the i-th axis, zero-based.

Public Attributes
Vector Components
The vector's components, which are also its storage. These are public and directly readable and writable. The components are contiguous and in declaration order, so `&x` points to `dimension` values. See data() and operator[](). For multi-component access see the swizzle accessors below, which return a new vector by value.
GfHalf	x

GfHalf	y

Static Public Attributes
static const size_t	dimension = 2

Friends
size_t	hash_value (GfVec2h const &vec)
	Hash.

GfVec2h	operator+ (GfVec2h const &l, GfVec2h const &r)

GfVec2h	operator- (GfVec2h const &l, GfVec2h const &r)

GfVec2h	operator* (double s, GfVec2h const &v)

Detailed Description

Basic type for a vector of 2 GfHalf components.

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

Definition at line 46 of file vec2h.h.

Member Typedef Documentation

◆ ScalarType

GfHalf ScalarType

Scalar element type and dimension.

Definition at line 50 of file vec2h.h.

Constructor & Destructor Documentation

◆ GfVec2h() [1/7]

GfVec2h ( )

default

GfVec2h value-initializes to zero and performs no default initialization, like float or double.

◆ GfVec2h() [2/7]

GfVec2h ( GfHalf value )

inlineexplicitconstexpr

Initialize all elements to a single value.

Definition at line 72 of file vec2h.h.

◆ GfVec2h() [3/7]

GfVec2h	(	GfHalf	s0,
		GfHalf	s1 )

inlineconstexpr

Initialize all elements with explicit arguments.

Definition at line 78 of file vec2h.h.

◆ GfVec2h() [4/7]

template<class Scl >

GfVec2h ( Scl const * p )

inlineexplicitconstexpr

Construct with pointer to values.

Definition at line 85 of file vec2h.h.

◆ GfVec2h() [5/7]

GfVec2h ( class GfVec2d const & other )

inlineexplicit

Construct from GfVec2d.

Definition at line 319 of file vec2h.h.

◆ GfVec2h() [6/7]

GfVec2h ( class GfVec2f const & other )

inlineexplicit

Construct from GfVec2f.

Definition at line 325 of file vec2h.h.

◆ GfVec2h() [7/7]

GfVec2h ( class GfVec2i const & other )

inline

Implicitly convert from GfVec2i.

Definition at line 331 of file vec2h.h.

Member Function Documentation

◆ Axis()

static GfVec2h 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 114 of file vec2h.h.

◆ data() [1/2]

GfHalf * data ( )

inline

Definition at line 139 of file vec2h.h.

◆ data() [2/2]

GfHalf const * data ( ) const

inline

Direct data access.

data() is the only member that relies on the components being contiguous; every other member either names them directly or goes through here.

Definition at line 138 of file vec2h.h.

◆ GetArray()

GfHalf const * GetArray ( ) const

inline

Definition at line 140 of file vec2h.h.

◆ GetComplement()

GfVec2h GetComplement ( GfVec2h const & b ) const

inline

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

That is:

*this - this->GetProjection(b)

GfVec2h::GetProjection

GfVec2h GetProjection(GfVec2h const &v) const

Returns the projection of this onto v.

Definition vec2h.h:230

Definition at line 239 of file vec2h.h.

◆ GetLength()

GfHalf GetLength ( ) const

inline

Length.

Definition at line 249 of file vec2h.h.

◆ GetLengthSq()

GfHalf GetLengthSq ( ) const

inline

Squared length.

Definition at line 244 of file vec2h.h.

◆ GetNormalized()

GfVec2h GetNormalized ( GfHalf eps = 0.001 ) const

inline

Definition at line 269 of file vec2h.h.

◆ GetProjection()

GfVec2h GetProjection ( GfVec2h const & v ) const

inline

Returns the projection of this onto v.

That is:

v * (*this * v)

Definition at line 230 of file vec2h.h.

◆ Normalize()

GfHalf Normalize ( GfHalf eps = 0.001 )

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 261 of file vec2h.h.

◆ operator!=()

bool operator!= ( GfVec2h const & other ) const

inline

Definition at line 156 of file vec2h.h.

◆ operator*() [1/2]

GfVec2h operator* ( double s ) const

inline

Definition at line 202 of file vec2h.h.

◆ operator*() [2/2]

GfHalf operator* ( GfVec2h const & v ) const

inline

See GfDot().

Definition at line 222 of file vec2h.h.

◆ operator*=()

GfVec2h & operator*= ( double s )

inline

Multiplication by scalar.

Definition at line 197 of file vec2h.h.

◆ operator+=()

GfVec2h & operator+= ( GfVec2h const & other )

inline

Addition.

Definition at line 177 of file vec2h.h.

◆ operator-()

GfVec2h operator- ( ) const

inline

Create a vec with negated elements.

Definition at line 172 of file vec2h.h.

◆ operator-=()

GfVec2h & operator-= ( GfVec2h const & other )

inline

Subtraction.

Definition at line 187 of file vec2h.h.

◆ operator/()

GfVec2h operator/ ( double s ) const

inline

Definition at line 217 of file vec2h.h.

◆ operator/=()

GfVec2h & operator/= ( double s )

inline

Division by scalar.

Definition at line 211 of file vec2h.h.

◆ operator==() [1/4]

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

Equality comparison.

◆ operator==() [2/4]

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

Equality comparison.

◆ operator==() [3/4]

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

Equality comparison.

◆ operator==() [4/4]

bool operator== ( GfVec2h const & other ) const

inline

Equality comparison.

Definition at line 152 of file vec2h.h.

◆ operator[]() [1/2]

GfHalf & operator[] ( size_t i )

inline

Definition at line 144 of file vec2h.h.

◆ operator[]() [2/2]

GfHalf const & operator[] ( size_t i ) const

inline

Indexing.

Definition at line 143 of file vec2h.h.

◆ Set() [1/2]

GfVec2h & Set ( GfHalf const * a )

inline

Set all elements with a pointer to data.

Definition at line 129 of file vec2h.h.

◆ Set() [2/2]

GfVec2h & Set	(	GfHalf	s0,
		GfHalf	s1 )

inline

Set all elements with passed arguments.

Definition at line 122 of file vec2h.h.

◆ XAxis()

static GfVec2h XAxis ( )

inlinestatic

Create a unit vector along the X-axis.

Definition at line 99 of file vec2h.h.

◆ xy()

Vec xy ( ) const

constexpr

Definition at line 339 of file vec2h.h.

◆ YAxis()

static GfVec2h YAxis ( )

inlinestatic

Create a unit vector along the Y-axis.

Definition at line 106 of file vec2h.h.

◆ yx()

Vec yx ( ) const

constexpr

Definition at line 347 of file vec2h.h.

Friends And Related Symbol Documentation

◆ hash_value

size_t hash_value ( GfVec2h const & vec )

friend

Hash.

Definition at line 147 of file vec2h.h.

◆ operator*

GfVec2h operator*	(	double	s,
		GfVec2h const &	v )

friend

Definition at line 205 of file vec2h.h.

◆ operator+

GfVec2h operator+	(	GfVec2h const &	l,
		GfVec2h const &	r )

friend

Definition at line 182 of file vec2h.h.

◆ operator-

GfVec2h operator-	(	GfVec2h const &	l,
		GfVec2h const &	r )

friend

Definition at line 192 of file vec2h.h.

Member Data Documentation

◆ dimension

const size_t dimension = 2

static

Definition at line 51 of file vec2h.h.

◆ x

GfHalf x

Definition at line 64 of file vec2h.h.

◆ y

GfHalf y

Definition at line 64 of file vec2h.h.

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

pxr/base/gf/vec2h.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ScalarType

Constructor & Destructor Documentation

◆ GfVec2h() [1/7]

◆ GfVec2h() [2/7]

◆ GfVec2h() [3/7]

◆ GfVec2h() [4/7]

◆ GfVec2h() [5/7]

◆ GfVec2h() [6/7]

◆ GfVec2h() [7/7]

Member Function Documentation

◆ Axis()

◆ data() [1/2]

◆ data() [2/2]

◆ GetArray()

◆ GetComplement()

◆ GetLength()

◆ GetLengthSq()

◆ GetNormalized()

◆ GetProjection()

◆ Normalize()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ Set() [1/2]

◆ Set() [2/2]

◆ XAxis()

◆ xy()

◆ YAxis()

◆ yx()

Friends And Related Symbol Documentation

◆ hash_value

◆ operator*

◆ operator+

◆ operator-

Member Data Documentation

◆ dimension

◆ x

◆ y