Kaim::Vec3f Class Reference

Kaim::Vec3f Class Reference

#include <vec3f.h>

Class Description

3d vector using 32bits floating points.

See also
vec3f.h
+ Examples:

Functions

 Vec3f ()
 Sets {0.0f, 0.0f, 0.0f}. More...
 
 Vec3f (KyFloat32 _x, KyFloat32 _y, KyFloat32 _z)
 Sets {_x, _y, _z}. More...
 
 Vec3f (const KyFloat32 *coords)
 Sets {coords[0], coords[1], coords[2]}. More...
 
 Vec3f (const Vec2f &v)
 Sets {v.x, v.y, 0.0f}. More...
 
 Vec3f (const Vec2f &v, KyFloat32 _z)
 Sets {v.x, v.y, _z}. More...
 
void Set (KyFloat32 _x, KyFloat32 _y, KyFloat32 _z)
 Sets {_x, _y, _z}. More...
 
void Set (const KyFloat32 *coords)
 Sets {coords[0], coords[1], coords[2]}. More...
 
void Set (const Vec2f &v)
 Sets {v.x, v.y, 0.0f}. More...
 
void Set (const Vec2f &v, KyFloat32 _z)
 Sets {v.x, v.y, _z}. More...
 
void Clear ()
 Sets x=0.0f, y=0.0f and z=0.0f. More...
 

Operators

KyFloat32 & operator[] (KyInt32 i)
 
KyFloat32 operator[] (KyInt32 i) const
 
bool operator== (const Vec3f &v) const
 
bool operator!= (const Vec3f &v) const
 
bool operator< (const Vec3f &v) const
 x is compared first. ex: {1, 5, 0} < {2, 0, 0}. More...
 
bool operator> (const Vec3f &v) const
 
bool operator<= (const Vec3f &v) const
 
bool operator>= (const Vec3f &v) const
 
Vec3f & operator*= (KyFloat32 s)
 
Vec3f & operator/= (KyFloat32 d)
 
Vec3f & operator+= (const Vec3f &v)
 
Vec3f & operator-= (const Vec3f &v)
 
Vec3f operator* (KyFloat32 s) const
 
Vec3f operator/ (KyFloat32 d) const
 
Vec3f operator+ (const Vec3f &v) const
 
Vec3f operator- (const Vec3f &v) const
 
Vec3f operator- () const
 

2d

Vec3f & operator+= (const Vec2f &v)
 
Vec3f & operator-= (const Vec2f &v)
 
Vec3f operator+ (const Vec2f &v) const
 
Vec3f operator- (const Vec2f &v) const
 
Vec2f Get2d () const
 
KyFloat32 GetSquareLength2d () const
 as Get2d().GetSquareLength() More...
 
KyFloat32 GetLength2d () const
 as Get2d().GetLength() More...
 
KyFloat32 GetNormalized2d (Vec2f &normalized) const
 as Get2d().GetNormalized() More...
 
Vec2f GetNormalized2d () const
 as Get2d().GetNormalized() More...
 

Length

KyFloat32 GetSquareLength () const
 
KyFloat32 GetLength () const
 
KyFloat32 Normalize ()
 Normalizes this vector. Returns the length of this vector before normalization. More...
 
KyFloat32 GetNormalized (Vec3f &normalized) const
 Normalizes normalized. Returns the length of this vector before normalization. More...
 
Vec3f GetNormalized () const
 
bool IsNormalized () const
 

Length Shorter Names

KyFloat32 SqLength () const
 
KyFloat32 Length () const
 
Vec3f Dir () const
 
Vec2f Dir2d () const
 

Offset

Vec3f OffsetX (KyFloat32 dx) const
 Returns {x + dx, y, z}. More...
 
Vec3f OffsetY (KyFloat32 dy) const
 Returns {x, y + dy, z}. More...
 
Vec3f OffsetZ (KyFloat32 dz) const
 Returns {x, y, z + dz}. More...
 
Vec3f Offset2d (KyFloat32 dx, KyFloat32 dy) const
 Returns {x + dx, y + dy, z}. More...
 

Zero

bool IsZero () const
 
static Vec3f Zero ()
 Returns {0.0f, 0.0f, 0.0f}. More...
 

Unit

static Vec3f UnitX ()
 Returns {1.0f, 0.0f, 0.0f}. More...
 
static Vec3f UnitY ()
 Returns {0.0f, 1.0f, 0.0f}. More...
 
static Vec3f UnitZ ()
 Returns {0.0f, 0.0f, 1.0f}. More...
 

Data

KyFloat32 x
 
KyFloat32 y
 
KyFloat32 z
 

Constructor & Destructor Documentation

Kaim::Vec3f::Vec3f ( )
inline

Sets {0.0f, 0.0f, 0.0f}.

Kaim::Vec3f::Vec3f ( KyFloat32  _x,
KyFloat32  _y,
KyFloat32  _z 
)
inline

Sets {_x, _y, _z}.

Kaim::Vec3f::Vec3f ( const KyFloat32 *  coords)
inlineexplicit

Sets {coords[0], coords[1], coords[2]}.

Kaim::Vec3f::Vec3f ( const Vec2f &  v)
inlineexplicit

Sets {v.x, v.y, 0.0f}.

Kaim::Vec3f::Vec3f ( const Vec2f &  v,
KyFloat32  _z 
)
inline

Sets {v.x, v.y, _z}.

Member Function Documentation

void Kaim::Vec3f::Clear ( )
inline

Sets x=0.0f, y=0.0f and z=0.0f.

KyFloat32 Kaim::Vec3f::GetLength2d ( ) const
inline

as Get2d().GetLength()

KyFloat32 Kaim::Vec3f::GetNormalized ( Vec3f &  normalized) const
inline

Normalizes normalized. Returns the length of this vector before normalization.

KyFloat32 Kaim::Vec3f::GetNormalized2d ( Vec2f &  normalized) const
inline

as Get2d().GetNormalized()

+ Examples:
Vec2f Kaim::Vec3f::GetNormalized2d ( ) const
inline

as Get2d().GetNormalized()

KyFloat32 Kaim::Vec3f::GetSquareLength2d ( ) const
inline

as Get2d().GetSquareLength()

KyFloat32 Kaim::Vec3f::Normalize ( )
inline

Normalizes this vector. Returns the length of this vector before normalization.

+ Examples:
Vec3f Kaim::Vec3f::Offset2d ( KyFloat32  dx,
KyFloat32  dy 
) const
inline

Returns {x + dx, y + dy, z}.

Vec3f Kaim::Vec3f::OffsetX ( KyFloat32  dx) const
inline

Returns {x + dx, y, z}.

Vec3f Kaim::Vec3f::OffsetY ( KyFloat32  dy) const
inline

Returns {x, y + dy, z}.

Vec3f Kaim::Vec3f::OffsetZ ( KyFloat32  dz) const
inline

Returns {x, y, z + dz}.

+ Examples:
bool Kaim::Vec3f::operator< ( const Vec3f &  v) const
inline

x is compared first. ex: {1, 5, 0} < {2, 0, 0}.

void Kaim::Vec3f::Set ( KyFloat32  _x,
KyFloat32  _y,
KyFloat32  _z 
)
inline

Sets {_x, _y, _z}.

+ Examples:
void Kaim::Vec3f::Set ( const KyFloat32 *  coords)
inline

Sets {coords[0], coords[1], coords[2]}.

void Kaim::Vec3f::Set ( const Vec2f &  v)
inline

Sets {v.x, v.y, 0.0f}.

void Kaim::Vec3f::Set ( const Vec2f &  v,
KyFloat32  _z 
)
inline

Sets {v.x, v.y, _z}.

static Vec3f Kaim::Vec3f::UnitX ( )
inlinestatic

Returns {1.0f, 0.0f, 0.0f}.

+ Examples:
static Vec3f Kaim::Vec3f::UnitY ( )
inlinestatic

Returns {0.0f, 1.0f, 0.0f}.

static Vec3f Kaim::Vec3f::UnitZ ( )
inlinestatic

Returns {0.0f, 0.0f, 1.0f}.

+ Examples:
static Vec3f Kaim::Vec3f::Zero ( )
inlinestatic

Returns {0.0f, 0.0f, 0.0f}.

+ Examples:
The documentation for this class was generated from the following file:
Please send us your comment about this page