HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GfVec4f Class Reference

#include <vec4f.h>

Public Types

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

Public Member Functions

 GfVec4f ()=default
 Default constructor does no initialization. More...
 
constexpr GfVec4f (float value)
 Initialize all elements to a single value. More...
 
constexpr GfVec4f (float s0, float s1, float s2, float s3)
 Initialize all elements with explicit arguments. More...
 
template<class Scl >
constexpr GfVec4f (Scl const *p)
 Construct with pointer to values. More...
 
 GfVec4f (class GfVec4d const &other)
 Construct from GfVec4d. More...
 
 GfVec4f (class GfVec4h const &other)
 Implicitly convert from GfVec4h. More...
 
 GfVec4f (class GfVec4i const &other)
 Implicitly convert from GfVec4i. More...
 
GfVec4fSet (float s0, float s1, float s2, float s3)
 Set all elements with passed arguments. More...
 
GfVec4fSet (float const *a)
 Set all elements with a pointer to data. More...
 
float constdata () const
 Direct data access. More...
 
float * data ()
 
float constGetArray () const
 
float constoperator[] (size_t i) const
 Indexing. More...
 
float & operator[] (size_t i)
 
bool operator== (GfVec4f const &other) const
 Equality comparison. More...
 
bool operator!= (GfVec4f const &other) const
 
GF_API bool operator== (class GfVec4d 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...
 
GfVec4f operator- () const
 Create a vec with negated elements. More...
 
GfVec4foperator+= (GfVec4f const &other)
 Addition. More...
 
GfVec4foperator-= (GfVec4f const &other)
 Subtraction. More...
 
GfVec4foperator*= (double s)
 Multiplication by scalar. More...
 
GfVec4f operator* (double s) const
 
GfVec4foperator/= (double s)
 Division by scalar. More...
 
GfVec4f operator/ (double s) const
 
float operator* (GfVec4f const &v) const
 See GfDot(). More...
 
GfVec4f GetProjection (GfVec4f const &v) const
 
GfVec4f GetComplement (GfVec4f const &b) const
 
float GetLengthSq () const
 Squared length. More...
 
float GetLength () const
 Length. More...
 
float Normalize (float eps=GF_MIN_VECTOR_LENGTH)
 
GfVec4f GetNormalized (float eps=GF_MIN_VECTOR_LENGTH) const
 

Static Public Member Functions

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

Static Public Attributes

static const size_t dimension = 4
 

Friends

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

Detailed Description

Basic type for a vector of 4 float components.

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

Definition at line 63 of file vec4f.h.

Member Typedef Documentation

typedef float GfVec4f::ScalarType

Scalar element type and dimension.

Definition at line 67 of file vec4f.h.

Constructor & Destructor Documentation

GfVec4f::GfVec4f ( )
default

Default constructor does no initialization.

constexpr GfVec4f::GfVec4f ( float  value)
inlineexplicit

Initialize all elements to a single value.

Definition at line 74 of file vec4f.h.

constexpr GfVec4f::GfVec4f ( float  s0,
float  s1,
float  s2,
float  s3 
)
inline

Initialize all elements with explicit arguments.

Definition at line 80 of file vec4f.h.

template<class Scl >
constexpr GfVec4f::GfVec4f ( Scl const p)
inlineexplicit

Construct with pointer to values.

Definition at line 87 of file vec4f.h.

PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE GfVec4f::GfVec4f ( class GfVec4d const other)
inlineexplicit

Construct from GfVec4d.

Definition at line 320 of file vec4f.h.

GfVec4f::GfVec4f ( class GfVec4h const other)
inline

Implicitly convert from GfVec4h.

Definition at line 328 of file vec4f.h.

GfVec4f::GfVec4f ( class GfVec4i const other)
inline

Implicitly convert from GfVec4i.

Definition at line 336 of file vec4f.h.

Member Function Documentation

static GfVec4f GfVec4f::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 vec4f.h.

float const* GfVec4f::data ( ) const
inline

Direct data access.

Definition at line 150 of file vec4f.h.

float* GfVec4f::data ( )
inline

Definition at line 151 of file vec4f.h.

float const* GfVec4f::GetArray ( ) const
inline

Definition at line 152 of file vec4f.h.

GfVec4f GfVec4f::GetComplement ( GfVec4f const b) const
inline

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

*this - this->GetProjection(b)

Definition at line 264 of file vec4f.h.

float GfVec4f::GetLength ( ) const
inline

Length.

Definition at line 274 of file vec4f.h.

float GfVec4f::GetLengthSq ( ) const
inline

Squared length.

Definition at line 269 of file vec4f.h.

GfVec4f GfVec4f::GetNormalized ( float  eps = GF_MIN_VECTOR_LENGTH) const
inline

Definition at line 295 of file vec4f.h.

GfVec4f GfVec4f::GetProjection ( GfVec4f const v) const
inline

Returns the projection of this onto v. That is:

v * (*this * v)

Definition at line 255 of file vec4f.h.

float GfVec4f::Normalize ( float  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().

Todo:
This was fixed for bug 67777. This is a gcc64 optimizer bug. By tickling the code, it no longer tries to write into an illegal memory address (in the code section of memory).

Definition at line 287 of file vec4f.h.

bool GfVec4f::operator!= ( GfVec4f const other) const
inline

Definition at line 175 of file vec4f.h.

GfVec4f GfVec4f::operator* ( double  s) const
inline

Definition at line 227 of file vec4f.h.

float GfVec4f::operator* ( GfVec4f const v) const
inline

See GfDot().

Definition at line 247 of file vec4f.h.

GfVec4f& GfVec4f::operator*= ( double  s)
inline

Multiplication by scalar.

Definition at line 220 of file vec4f.h.

GfVec4f& GfVec4f::operator+= ( GfVec4f const other)
inline

Addition.

Definition at line 196 of file vec4f.h.

GfVec4f GfVec4f::operator- ( ) const
inline

Create a vec with negated elements.

Definition at line 191 of file vec4f.h.

GfVec4f& GfVec4f::operator-= ( GfVec4f const other)
inline

Subtraction.

Definition at line 208 of file vec4f.h.

GfVec4f GfVec4f::operator/ ( double  s) const
inline

Definition at line 242 of file vec4f.h.

GfVec4f& GfVec4f::operator/= ( double  s)
inline

Division by scalar.

Definition at line 236 of file vec4f.h.

bool GfVec4f::operator== ( GfVec4f const other) const
inline

Equality comparison.

Definition at line 169 of file vec4f.h.

GF_API bool GfVec4f::operator== ( class GfVec4d const other) const

Equality comparison.

GF_API bool GfVec4f::operator== ( class GfVec4h const other) const

Equality comparison.

GF_API bool GfVec4f::operator== ( class GfVec4i const other) const

Equality comparison.

float const& GfVec4f::operator[] ( size_t  i) const
inline

Indexing.

Definition at line 155 of file vec4f.h.

float& GfVec4f::operator[] ( size_t  i)
inline

Definition at line 156 of file vec4f.h.

GfVec4f& GfVec4f::Set ( float  s0,
float  s1,
float  s2,
float  s3 
)
inline

Set all elements with passed arguments.

Definition at line 136 of file vec4f.h.

GfVec4f& GfVec4f::Set ( float const a)
inline

Set all elements with a pointer to data.

Definition at line 145 of file vec4f.h.

static GfVec4f GfVec4f::WAxis ( )
inlinestatic

Create a unit vector along the W-axis.

Definition at line 120 of file vec4f.h.

static GfVec4f GfVec4f::XAxis ( )
inlinestatic

Create a unit vector along the X-axis.

Definition at line 102 of file vec4f.h.

static GfVec4f GfVec4f::YAxis ( )
inlinestatic

Create a unit vector along the Y-axis.

Definition at line 108 of file vec4f.h.

static GfVec4f GfVec4f::ZAxis ( )
inlinestatic

Create a unit vector along the Z-axis.

Definition at line 114 of file vec4f.h.

Friends And Related Function Documentation

size_t hash_value ( GfVec4f const vec)
friend

Hash.

Definition at line 159 of file vec4f.h.

GfVec4f operator* ( double  s,
GfVec4f const v 
)
friend

Definition at line 230 of file vec4f.h.

GfVec4f operator+ ( GfVec4f const l,
GfVec4f const r 
)
friend

Definition at line 203 of file vec4f.h.

GfVec4f operator- ( GfVec4f const l,
GfVec4f const r 
)
friend

Definition at line 215 of file vec4f.h.

Member Data Documentation

const size_t GfVec4f::dimension = 4
static

Definition at line 68 of file vec4f.h.


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