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

#include <vec2i.h>

Public Types
typedef int	ScalarType
	Scalar element type and dimension.

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

constexpr	GfVec2i (int value)
	Initialize all elements to a single value.

constexpr	GfVec2i (int s0, int s1)
	Initialize all elements with explicit arguments.

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

GfVec2i &	Set (int s0, int s1)
	Set all elements with passed arguments.

GfVec2i &	Set (int const *a)
	Set all elements with a pointer to data.

int const *	data () const
	Direct data access.

int *	data ()

int const *	GetArray () const

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

int &	operator[] (size_t i)

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

bool	operator!= (GfVec2i 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 GfVec2h const &other) const
	Equality comparison.

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

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

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

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

GfVec2i	operator* (double s) const

GfVec2i &	operator/= (int s)
	Division by scalar.

GfVec2i	operator/ (int s) const

int	operator* (GfVec2i const &v) const
	See GfDot().

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

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

int	GetLengthSq () const
	Squared length.

Swizzles
Each accessor returns a new vector built from this one's components, in the order named. For example yx() returns GfVec2i(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 GfVec2i	xy () const

constexpr GfVec2i	yx () const

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

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

static GfVec2i	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.
int	x

int	y

Static Public Attributes
static const size_t	dimension = 2

Friends
size_t	hash_value (GfVec2i const &vec)
	Hash.

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

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

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

Detailed Description

Basic type for a vector of 2 int components.

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

Definition at line 43 of file vec2i.h.

Member Typedef Documentation

◆ ScalarType

int ScalarType

Scalar element type and dimension.

Definition at line 47 of file vec2i.h.

Constructor & Destructor Documentation

◆ GfVec2i() [1/4]

GfVec2i ( )

default

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

◆ GfVec2i() [2/4]

GfVec2i ( int value )

inlineexplicitconstexpr

Initialize all elements to a single value.

Definition at line 69 of file vec2i.h.

◆ GfVec2i() [3/4]

GfVec2i	(	int	s0,
		int	s1 )

inlineconstexpr

Initialize all elements with explicit arguments.

Definition at line 75 of file vec2i.h.

◆ GfVec2i() [4/4]

template<class Scl >

GfVec2i ( Scl const * p )

inlineexplicitconstexpr

Construct with pointer to values.

Definition at line 82 of file vec2i.h.

Member Function Documentation

◆ Axis()

static GfVec2i 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 102 of file vec2i.h.

◆ data() [1/2]

int * data ( )

inline

Definition at line 127 of file vec2i.h.

◆ data() [2/2]

int 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 126 of file vec2i.h.

◆ GetArray()

int const * GetArray ( ) const

inline

Definition at line 128 of file vec2i.h.

◆ GetComplement()

GfVec2i GetComplement ( GfVec2i const & b ) const

inline

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

That is:

*this - this->GetProjection(b)

GfVec2i::GetProjection

GfVec2i GetProjection(GfVec2i const &v) const

Returns the projection of this onto v.

Definition vec2i.h:216

Definition at line 225 of file vec2i.h.

◆ GetLengthSq()

int GetLengthSq ( ) const

inline

Squared length.

Definition at line 230 of file vec2i.h.

◆ GetProjection()

GfVec2i GetProjection ( GfVec2i const & v ) const

inline

Returns the projection of this onto v.

That is:

v * (*this * v)

Definition at line 216 of file vec2i.h.

◆ operator!=()

bool operator!= ( GfVec2i const & other ) const

inline

Definition at line 144 of file vec2i.h.

◆ operator*() [1/2]

GfVec2i operator* ( double s ) const

inline

Definition at line 190 of file vec2i.h.

◆ operator*() [2/2]

int operator* ( GfVec2i const & v ) const

inline

See GfDot().

Definition at line 208 of file vec2i.h.

◆ operator*=()

GfVec2i & operator*= ( double s )

inline

Multiplication by scalar.

Definition at line 185 of file vec2i.h.

◆ operator+=()

GfVec2i & operator+= ( GfVec2i const & other )

inline

Addition.

Definition at line 165 of file vec2i.h.

◆ operator-()

GfVec2i operator- ( ) const

inline

Create a vec with negated elements.

Definition at line 160 of file vec2i.h.

◆ operator-=()

GfVec2i & operator-= ( GfVec2i const & other )

inline

Subtraction.

Definition at line 175 of file vec2i.h.

◆ operator/()

GfVec2i operator/ ( int s ) const

inline

Definition at line 203 of file vec2i.h.

◆ operator/=()

GfVec2i & operator/= ( int s )

inline

Division by scalar.

Definition at line 198 of file vec2i.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 GfVec2h const & other ) const

Equality comparison.

◆ operator==() [4/4]

bool operator== ( GfVec2i const & other ) const

inline

Equality comparison.

Definition at line 140 of file vec2i.h.

◆ operator[]() [1/2]

int & operator[] ( size_t i )

inline

Definition at line 132 of file vec2i.h.

◆ operator[]() [2/2]

int const & operator[] ( size_t i ) const

inline

Indexing.

Definition at line 131 of file vec2i.h.

◆ Set() [1/2]

GfVec2i & Set ( int const * a )

inline

Set all elements with a pointer to data.

Definition at line 117 of file vec2i.h.

◆ Set() [2/2]

GfVec2i & Set	(	int	s0,
		int	s1 )

inline

Set all elements with passed arguments.

Definition at line 110 of file vec2i.h.

◆ XAxis()

static GfVec2i XAxis ( )

inlinestatic

Create a unit vector along the X-axis.

Definition at line 87 of file vec2i.h.

◆ xy()

Vec xy ( ) const

constexpr

Definition at line 276 of file vec2i.h.

◆ YAxis()

static GfVec2i YAxis ( )

inlinestatic

Create a unit vector along the Y-axis.

Definition at line 94 of file vec2i.h.

◆ yx()

Vec yx ( ) const

constexpr

Definition at line 284 of file vec2i.h.

Friends And Related Symbol Documentation

◆ hash_value

size_t hash_value ( GfVec2i const & vec )

friend

Hash.

Definition at line 135 of file vec2i.h.

◆ operator*

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

friend

Definition at line 193 of file vec2i.h.

◆ operator+

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

friend

Definition at line 170 of file vec2i.h.

◆ operator-

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

friend

Definition at line 180 of file vec2i.h.

Member Data Documentation

◆ dimension

const size_t dimension = 2

static

Definition at line 48 of file vec2i.h.

◆ x

int x

Definition at line 61 of file vec2i.h.

◆ y

int y

Definition at line 61 of file vec2i.h.

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

pxr/base/gf/vec2i.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

◆ GfVec2i() [1/4]

◆ GfVec2i() [2/4]

◆ GfVec2i() [3/4]

◆ GfVec2i() [4/4]

Member Function Documentation

◆ Axis()

◆ data() [1/2]

◆ data() [2/2]

◆ GetArray()

◆ GetComplement()

◆ GetLengthSq()

◆ GetProjection()

◆ 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