Public Member Functions | Public Attributes | List of all members
b2Vec2 Struct Reference

A 2D column vector. More...

#include <b2Math.h>

Public Member Functions

 b2Vec2 ()
 Default constructor does nothing (for performance). More...
 
 b2Vec2 (float32 x, float32 y)
 Construct using coordinates. More...
 
bool IsValid () const
 Does this vector contain finite coordinates? More...
 
float32 Length () const
 Get the length of this vector (the norm). More...
 
float32 LengthSquared () const
 
float32 Normalize ()
 Convert this vector into a unit vector. Returns the length. More...
 
float32 operator() (int32 i) const
 Read from and indexed element. More...
 
float32operator() (int32 i)
 Write to an indexed element. More...
 
void operator*= (float32 a)
 Multiply this vector by a scalar. More...
 
void operator+= (const b2Vec2 &v)
 Add a vector to this vector. More...
 
b2Vec2 operator- () const
 Negate this vector. More...
 
void operator-= (const b2Vec2 &v)
 Subtract a vector from this vector. More...
 
void Set (float32 x_, float32 y_)
 Set this vector to some specified coordinates. More...
 
void SetZero ()
 Set this vector to all zeros. More...
 
b2Vec2 Skew () const
 Get the skew vector such that dot(skew_vec, other) == cross(vec, other) More...
 

Public Attributes

float32 x
 
float32 y
 

Detailed Description

A 2D column vector.

Definition at line 52 of file b2Math.h.

Constructor & Destructor Documentation

b2Vec2::b2Vec2 ( )
inline

Default constructor does nothing (for performance).

Definition at line 55 of file b2Math.h.

b2Vec2::b2Vec2 ( float32  x,
float32  y 
)
inline

Construct using coordinates.

Definition at line 58 of file b2Math.h.

Member Function Documentation

bool b2Vec2::IsValid ( ) const
inline

Does this vector contain finite coordinates?

Definition at line 128 of file b2Math.h.

float32 b2Vec2::Length ( ) const
inline

Get the length of this vector (the norm).

Definition at line 100 of file b2Math.h.

float32 b2Vec2::LengthSquared ( ) const
inline

Get the length squared. For performance, use this instead of b2Vec2::Length (if possible).

Definition at line 107 of file b2Math.h.

float32 b2Vec2::Normalize ( )
inline

Convert this vector into a unit vector. Returns the length.

Definition at line 113 of file b2Math.h.

float32 b2Vec2::operator() ( int32  i) const
inline

Read from and indexed element.

Definition at line 70 of file b2Math.h.

float32& b2Vec2::operator() ( int32  i)
inline

Write to an indexed element.

Definition at line 76 of file b2Math.h.

void b2Vec2::operator*= ( float32  a)
inline

Multiply this vector by a scalar.

Definition at line 94 of file b2Math.h.

void b2Vec2::operator+= ( const b2Vec2 v)
inline

Add a vector to this vector.

Definition at line 82 of file b2Math.h.

b2Vec2 b2Vec2::operator- ( ) const
inline

Negate this vector.

Definition at line 67 of file b2Math.h.

void b2Vec2::operator-= ( const b2Vec2 v)
inline

Subtract a vector from this vector.

Definition at line 88 of file b2Math.h.

void b2Vec2::Set ( float32  x_,
float32  y_ 
)
inline

Set this vector to some specified coordinates.

Definition at line 64 of file b2Math.h.

void b2Vec2::SetZero ( )
inline

Set this vector to all zeros.

Definition at line 61 of file b2Math.h.

b2Vec2 b2Vec2::Skew ( ) const
inline

Get the skew vector such that dot(skew_vec, other) == cross(vec, other)

Definition at line 134 of file b2Math.h.

Member Data Documentation

float32 b2Vec2::x

Definition at line 139 of file b2Math.h.

float32 b2Vec2::y

Definition at line 139 of file b2Math.h.


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


mvsim
Author(s):
autogenerated on Fri May 7 2021 03:05:52