GfVec2i Class Reference

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

Public Types

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

Public Member Functions

 GfVec2i ()=default
 Default constructor does no initialization. More...
 
constexpr GfVec2i (int value)
 Initialize all elements to a single value. More...
 
constexpr GfVec2i (int s0, int s1)
 Initialize all elements with explicit arguments. More...
 
template<class Scl >
constexpr GfVec2i (Scl const *p)
 Construct with pointer to values. More...
 
GfVec2iSet (int s0, int s1)
 Set all elements with passed arguments. More...
 
GfVec2iSet (int const *a)
 Set all elements with a pointer to data. More...
 
int const * data () const
 Direct data access. More...
 
int * data ()
 
int const * GetArray () const
 
int const & operator[] (size_t i) const
 Indexing. More...
 
int & operator[] (size_t i)
 
bool operator== (GfVec2i const &other) const
 Equality comparison. More...
 
bool operator!= (GfVec2i const &other) const
 
GF_API bool operator== (class GfVec2d const &other) const
 Equality comparison. More...
 
GF_API bool operator== (class GfVec2f const &other) const
 Equality comparison. More...
 
GF_API bool operator== (class GfVec2h const &other) const
 Equality comparison. More...
 
GfVec2i operator- () const
 Create a vec with negated elements. More...
 
GfVec2ioperator+= (GfVec2i const &other)
 Addition. More...
 
GfVec2ioperator-= (GfVec2i const &other)
 Subtraction. More...
 
GfVec2ioperator *= (double s)
 Multiplication by scalar. More...
 
GfVec2i operator * (double s) const
 
GfVec2ioperator/= (int s)
 Division by scalar. More...
 
GfVec2i operator/ (int s) const
 
int operator * (GfVec2i const &v) const
 See GfDot(). More...
 
GfVec2i GetProjection (GfVec2i const &v) const
 Returns the projection of this onto v. More...
 
GfVec2i GetComplement (GfVec2i const &b) const
 Returns the orthogonal complement of this->GetProjection(b). More...
 
int GetLengthSq () const
 Squared length. More...
 

Static Public Member Functions

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

Static Public Attributes

static const size_t dimension = 2
 

Friends

size_t hash_value (GfVec2i const &vec)
 Hash. More...
 
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 61 of file vec2i.h.

Member Typedef Documentation

◆ ScalarType

typedef int ScalarType

Scalar element type and dimension.

Definition at line 65 of file vec2i.h.

Constructor & Destructor Documentation

◆ GfVec2i() [1/4]

GfVec2i ( )
default

Default constructor does no initialization.

◆ GfVec2i() [2/4]

constexpr GfVec2i ( int  value)
inlineexplicit

Initialize all elements to a single value.

Definition at line 72 of file vec2i.h.

◆ GfVec2i() [3/4]

constexpr GfVec2i ( int  s0,
int  s1 
)
inline

Initialize all elements with explicit arguments.

Definition at line 78 of file vec2i.h.

◆ GfVec2i() [4/4]

constexpr GfVec2i ( Scl const *  p)
inlineexplicit

Construct with pointer to values.

Definition at line 85 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 105 of file vec2i.h.

◆ data()

int const* data ( ) const
inline

Direct data access.

Definition at line 125 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)

Definition at line 227 of file vec2i.h.

◆ GetLengthSq()

int GetLengthSq ( ) const
inline

Squared length.

Definition at line 232 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 218 of file vec2i.h.

◆ operator *()

int operator * ( GfVec2i const &  v) const
inline

See GfDot().

Definition at line 210 of file vec2i.h.

◆ operator *=()

GfVec2i& operator *= ( double  s)
inline

Multiplication by scalar.

Definition at line 187 of file vec2i.h.

◆ operator+=()

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

Addition.

Definition at line 167 of file vec2i.h.

◆ operator-()

GfVec2i operator- ( ) const
inline

Create a vec with negated elements.

Definition at line 162 of file vec2i.h.

◆ operator-=()

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

Subtraction.

Definition at line 177 of file vec2i.h.

◆ operator/=()

GfVec2i& operator/= ( int  s)
inline

Division by scalar.

Definition at line 200 of file vec2i.h.

◆ operator==() [1/4]

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

Equality comparison.

Definition at line 142 of file vec2i.h.

◆ operator==() [2/4]

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

Equality comparison.

◆ operator==() [3/4]

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

Equality comparison.

◆ operator==() [4/4]

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

Equality comparison.

◆ operator[]()

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

Indexing.

Definition at line 130 of file vec2i.h.

◆ Set() [1/2]

GfVec2i& Set ( int  s0,
int  s1 
)
inline

Set all elements with passed arguments.

Definition at line 113 of file vec2i.h.

◆ Set() [2/2]

GfVec2i& Set ( int const *  a)
inline

Set all elements with a pointer to data.

Definition at line 120 of file vec2i.h.

◆ XAxis()

static GfVec2i XAxis ( )
inlinestatic

Create a unit vector along the X-axis.

Definition at line 91 of file vec2i.h.

◆ YAxis()

static GfVec2i YAxis ( )
inlinestatic

Create a unit vector along the Y-axis.

Definition at line 97 of file vec2i.h.

Friends And Related Function Documentation

◆ hash_value

size_t hash_value ( GfVec2i const &  vec)
friend

Hash.

Definition at line 134 of file vec2i.h.


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