cocos2d-x  3.3rc0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Vec2 Class Reference

Defines a 2-element floating point vector. More...

#include <Vec2.h>

Public Member Functions

 Vec2 ()
 Constructs a new vector initialized to all zeros. More...
 
 Vec2 ()
 Constructs a new vector initialized to all zeros. More...
 
 Vec2 ()
 Constructs a new vector initialized to all zeros. More...
 
 Vec2 (float xx, float yy)
 Constructs a new vector initialized to the specified values. More...
 
 Vec2 ( var xx, var yy)
 Constructs a new vector initialized to the specified values. More...
 
 Vec2 ( local xx, local yy)
 Constructs a new vector initialized to the specified values. More...
 
 Vec2 (const float *array)
 Constructs a new vector from the values in the specified array. More...
 
 Vec2 (const Vec2 &p1, const Vec2 &p2)
 Constructs a vector that describes the direction between the specified points. More...
 
 Vec2 ( var p1, var p2)
 Constructs a vector that describes the direction between the specified points. More...
 
 Vec2 ( local p1, local p2)
 Constructs a vector that describes the direction between the specified points. More...
 
 Vec2 (const Vec2 &copy)
 Constructs a new vector that is a copy of the specified vector. More...
 
 ~Vec2 ()
 Destructor. More...
 
bool isZero () const
 Indicates whether this vector contains all zeros. More...
 
bool isOne () const
 Indicates whether this vector contains all ones. More...
 
void add (const Vec2 &v)
 Adds the elements of the specified vector to this one. More...
 
var add ( var v)
 Adds the elements of the specified vector to this one. More...
 
local add ( local v)
 Adds the elements of the specified vector to this one. More...
 
void clamp (const Vec2 &min, const Vec2 &max)
 Clamps this vector within the specified range. More...
 
var clamp ( var min, var max)
 Clamps this vector within the specified range. More...
 
local clamp ( local min, local max)
 Clamps this vector within the specified range. More...
 
float distance (const Vec2 &v) const
 Returns the distance between this vector and v. More...
 
var distance ( var v)
 Returns the distance between this vector and v. More...
 
local distance ( local v)
 Returns the distance between this vector and v. More...
 
float distanceSquared (const Vec2 &v) const
 Returns the squared distance between this vector and v. More...
 
float dot (const Vec2 &v) const
 Returns the dot product of this vector and the specified vector. More...
 
float length () const
 Computes the length of this vector. More...
 
float lengthSquared () const
 Returns the squared length of this vector. More...
 
var lengthSquared ()
 Returns the squared length of this vector. More...
 
local lengthSquared ()
 Returns the squared length of this vector. More...
 
void negate ()
 Negates this vector. More...
 
var negate ()
 Negates this vector. More...
 
local negate ()
 Negates this vector. More...
 
void normalize ()
 Normalizes this vector. More...
 
var normalize ()
 Normalizes this vector. More...
 
local normalize ()
 Normalizes this vector. More...
 
Vec2 getNormalized () const
 Normalizes this vector and stores the result in dst. More...
 
var getNormalized ()
 Normalizes this vector and stores the result in dst. More...
 
local getNormalized ()
 Normalizes this vector and stores the result in dst. More...
 
void scale (float scalar)
 Scales all elements of this vector by the specified value. More...
 
void scale (const Vec2 &scale)
 Scales each element of this vector by the matching component of scale. More...
 
void rotate (const Vec2 &point, float angle)
 Rotates this vector by angle (specified in radians) around the given point. More...
 
var rotate ( var point, var angle)
 Rotates this vector by angle (specified in radians) around the given point. More...
 
local rotate ( local point, local angle)
 Rotates this vector by angle (specified in radians) around the given point. More...
 
void set (float xx, float yy)
 Sets the elements of this vector to the specified values. More...
 
void set (const float *array)
 Sets the elements of this vector from the values in the specified array. More...
 
void set (const Vec2 &v)
 Sets the elements of this vector to those in the specified vector. More...
 
var set ( var v)
 Sets the elements of this vector to those in the specified vector. More...
 
local set ( local v)
 Sets the elements of this vector to those in the specified vector. More...
 
void set (const Vec2 &p1, const Vec2 &p2)
 Sets this vector to the directional vector between the specified points. More...
 
var set ( var p1, var p2)
 Sets this vector to the directional vector between the specified points. More...
 
local set ( local p1, local p2)
 Sets this vector to the directional vector between the specified points. More...
 
void subtract (const Vec2 &v)
 Subtracts this vector and the specified vector as (this - v) and stores the result in this vector. More...
 
void smooth (const Vec2 &target, float elapsedTime, float responseTime)
 Updates this vector towards the given target using a smoothing function. More...
 
const Vec2 operator+ (const Vec2 &v) const
 Calculates the sum of this vector with the given vector. More...
 
Vec2operator+= (const Vec2 &v)
 Adds the given vector to this vector. More...
 
const Vec2 operator- (const Vec2 &v) const
 Calculates the sum of this vector with the given vector. More...
 
var operator- ( var v)
 Calculates the sum of this vector with the given vector. More...
 
Vec2operator-= (const Vec2 &v)
 Subtracts the given vector from this vector. More...
 
const Vec2 operator- () const
 Calculates the negation of this vector. More...
 
const Vec2 operator* (float s) const
 Calculates the scalar product of this vector with the given value. More...
 
local operator* ( local s)
 Calculates the scalar product of this vector with the given value. More...
 
Vec2operator*= (float s)
 Scales this vector by the given value. More...
 
const Vec2 operator/ (float s) const
 Returns the components of this vector divided by the given constant. More...
 
bool operator< (const Vec2 &v) const
 Determines if this vector is less than the given vector. More...
 
bool operator== (const Vec2 &v) const
 Determines if this vector is equal to the given vector. More...
 
bool operator!= (const Vec2 &v) const
 Determines if this vector is not equal to the given vector. More...
 
var operator!= ( var v)
 Determines if this vector is not equal to the given vector. More...
 
local operator!= ( local v)
 Determines if this vector is not equal to the given vector. More...
 
void setPoint (float xx, float yy)
bool equals (const Vec2 &target) const
bool fuzzyEquals (const Vec2 &target, float variance) const
float getLength () const
 Calculates distance between point an origin. More...
 
float getLengthSq () const
 Calculates the square length of a Vec2 (not calling sqrt() ) More...
 
float getDistanceSq (const Vec2 &other) const
 Calculates the square distance between two points (not calling sqrt() ) More...
 
float getDistance (const Vec2 &other) const
 Calculates the distance between two points. More...
 
float getAngle () const
float getAngle (const Vec2 &other) const
float cross (const Vec2 &other) const
 Calculates cross product of two points. More...
 
Vec2 getPerp () const
 Calculates perpendicular of v, rotated 90 degrees counter-clockwise – cross(v, perp(v)) >= 0. More...
 
Vec2 getMidpoint (const Vec2 &other) const
 Calculates midpoint between two points. More...
 
Vec2 getClampPoint (const Vec2 &min_inclusive, const Vec2 &max_inclusive) const
 Clamp a point between from and to. More...
 
Vec2 compOp (std::function< float(float)> function) const
 Run a math operation function on each point component absf, fllorf, ceilf, roundf any function that has the signature: float func(float); For example: let's try to take the floor of x,y p.compOp(floorf);. More...
 
Vec2 getRPerp () const
 Calculates perpendicular of v, rotated 90 degrees clockwise – cross(v, rperp(v)) <= 0. More...
 
Vec2 project (const Vec2 &other) const
 Calculates the projection of this over other. More...
 
Vec2 rotate (const Vec2 &other) const
 Complex multiplication of two points ("rotates" two points). More...
 
Vec2 unrotate (const Vec2 &other) const
 Unrotates two points. More...
 
Vec2 lerp (const Vec2 &other, float alpha) const
 Linear Interpolation between two points a and b. More...
 
Vec2 rotateByAngle (const Vec2 &pivot, float angle) const
 Rotates a point counter clockwise by the angle around a pivot. More...
 

Static Public Member Functions

static float angle (const Vec2 &v1, const Vec2 &v2)
 Returns the angle (in radians) between the specified vectors. More...
 
static void add (const Vec2 &v1, const Vec2 &v2, Vec2 *dst)
 Adds the specified vectors and stores the result in dst. More...
 
static void clamp (const Vec2 &v, const Vec2 &min, const Vec2 &max, Vec2 *dst)
 Clamps the specified vector within the specified range and returns it in dst. More...
 
local clamp ( local v, local min, local max, local dst)
 Clamps the specified vector within the specified range and returns it in dst. More...
 
static float dot (const Vec2 &v1, const Vec2 &v2)
 Returns the dot product between the specified vectors. More...
 
local dot ( local v1, local v2)
 Returns the dot product between the specified vectors. More...
 
static void subtract (const Vec2 &v1, const Vec2 &v2, Vec2 *dst)
 Subtracts the specified vectors and stores the result in dst. More...
 
local subtract ( local v1, local v2, local dst)
 Subtracts the specified vectors and stores the result in dst. More...
 
static Vec2 forAngle (const float a)
static bool isLineIntersect (const Vec2 &A, const Vec2 &B, const Vec2 &C, const Vec2 &D, float *S=nullptr, float *T=nullptr)
 A general line-line intersection test. More...
 
static bool isLineOverlap (const Vec2 &A, const Vec2 &B, const Vec2 &C, const Vec2 &D)
 returns true if Line A-B overlap with segment C-D More...
 
static bool isLineParallel (const Vec2 &A, const Vec2 &B, const Vec2 &C, const Vec2 &D)
 returns true if Line A-B parallel with segment C-D More...
 
static bool isSegmentOverlap (const Vec2 &A, const Vec2 &B, const Vec2 &C, const Vec2 &D, Vec2 *S=nullptr, Vec2 *E=nullptr)
 returns true if Segment A-B overlap with segment C-D More...
 
static bool isSegmentIntersect (const Vec2 &A, const Vec2 &B, const Vec2 &C, const Vec2 &D)
 returns true if Segment A-B intersects with segment C-D More...
 
static Vec2 getIntersectPoint (const Vec2 &A, const Vec2 &B, const Vec2 &C, const Vec2 &D)
 returns the intersection point of line A-B, C-D More...
 

Public Attributes

float x
 The x coordinate. More...
 
float y
 The y coordinate. More...
 
var y
 The y coordinate. More...
 
local y
 The y coordinate. More...
 

Static Public Attributes

static const Vec2 ZERO
 equals to Vec2(0,0) More...
 
var ZERO
 equals to Vec2(0,0) More...
 
local ZERO
 equals to Vec2(0,0) More...
 
static const Vec2 ONE
 equals to Vec2(1,1) More...
 
static const Vec2 UNIT_X
 equals to Vec2(1,0) More...
 
local UNIT_X
 equals to Vec2(1,0) More...
 
static const Vec2 UNIT_Y
 equals to Vec2(0,1) More...
 
local UNIT_Y
 equals to Vec2(0,1) More...
 
static const Vec2 ANCHOR_MIDDLE
 equals to Vec2(0.5, 0.5) More...
 
local ANCHOR_MIDDLE
 equals to Vec2(0.5, 0.5) More...
 
static const Vec2 ANCHOR_BOTTOM_LEFT
 equals to Vec2(0, 0) More...
 
var ANCHOR_BOTTOM_LEFT
 equals to Vec2(0, 0) More...
 
static const Vec2 ANCHOR_TOP_LEFT
 equals to Vec2(0, 1) More...
 
var ANCHOR_TOP_LEFT
 equals to Vec2(0, 1) More...
 
local ANCHOR_TOP_LEFT
 equals to Vec2(0, 1) More...
 
static const Vec2 ANCHOR_BOTTOM_RIGHT
 equals to Vec2(1, 0) More...
 
static const Vec2 ANCHOR_TOP_RIGHT
 equals to Vec2(1, 1) More...
 
var ANCHOR_TOP_RIGHT
 equals to Vec2(1, 1) More...
 
local ANCHOR_TOP_RIGHT
 equals to Vec2(1, 1) More...
 
static const Vec2 ANCHOR_MIDDLE_RIGHT
 equals to Vec2(1, 0.5) More...
 
var ANCHOR_MIDDLE_RIGHT
 equals to Vec2(1, 0.5) More...
 
local ANCHOR_MIDDLE_RIGHT
 equals to Vec2(1, 0.5) More...
 
static const Vec2 ANCHOR_MIDDLE_LEFT
 equals to Vec2(0, 0.5) More...
 
var ANCHOR_MIDDLE_LEFT
 equals to Vec2(0, 0.5) More...
 
static const Vec2 ANCHOR_MIDDLE_TOP
 equals to Vec2(0.5, 1) More...
 
static const Vec2 ANCHOR_MIDDLE_BOTTOM
 equals to Vec2(0.5, 0) More...
 

Detailed Description

Defines a 2-element floating point vector.

Constructor & Destructor Documentation

Vec2 ( )

Constructs a new vector initialized to all zeros.

var Vec2 ( )

Constructs a new vector initialized to all zeros.

local Vec2 ( )

Constructs a new vector initialized to all zeros.

Vec2 ( float  xx,
float  yy 
)

Constructs a new vector initialized to the specified values.

Parameters
xxThe x coordinate.
yyThe y coordinate.
var Vec2 ( var  xx,
var  yy 
)

Constructs a new vector initialized to the specified values.

Parameters
xxThe x coordinate.
yyThe y coordinate.
local Vec2 ( local  xx,
local  yy 
)

Constructs a new vector initialized to the specified values.

Parameters
xxThe x coordinate.
yyThe y coordinate.
Vec2 ( const float *  array)

Constructs a new vector from the values in the specified array.

Parameters
arrayAn array containing the elements of the vector in the order x, y.
var Vec2 ( var  array)

Constructs a new vector from the values in the specified array.

Parameters
arrayAn array containing the elements of the vector in the order x, y.
local Vec2 ( local  array)

Constructs a new vector from the values in the specified array.

Parameters
arrayAn array containing the elements of the vector in the order x, y.
Vec2 ( const Vec2 p1,
const Vec2 p2 
)

Constructs a vector that describes the direction between the specified points.

Parameters
p1The first point.
p2The second point.
var Vec2 ( var  p1,
var  p2 
)

Constructs a vector that describes the direction between the specified points.

Parameters
p1The first point.
p2The second point.
local Vec2 ( local  p1,
local  p2 
)

Constructs a vector that describes the direction between the specified points.

Parameters
p1The first point.
p2The second point.
Vec2 ( const Vec2 copy)

Constructs a new vector that is a copy of the specified vector.

Parameters
copyThe vector to copy.
var Vec2 ( var  copy)

Constructs a new vector that is a copy of the specified vector.

Parameters
copyThe vector to copy.
local Vec2 ( local  copy)

Constructs a new vector that is a copy of the specified vector.

Parameters
copyThe vector to copy.
~Vec2 ( )

Destructor.

var ~Vec2 ( )

Destructor.

local ~Vec2 ( )

Destructor.

Member Function Documentation

void add ( const Vec2 v)

Adds the elements of the specified vector to this one.

Parameters
vThe vector to add.
var add ( var  v)

Adds the elements of the specified vector to this one.

Parameters
vThe vector to add.
local add ( local  v)

Adds the elements of the specified vector to this one.

Parameters
vThe vector to add.
static void add ( const Vec2 v1,
const Vec2 v2,
Vec2 dst 
)
static

Adds the specified vectors and stores the result in dst.

Parameters
v1The first vector.
v2The second vector.
dstA vector to store the result in.
var add ( var  v1,
var  v2,
var  dst 
)
static

Adds the specified vectors and stores the result in dst.

Parameters
v1The first vector.
v2The second vector.
dstA vector to store the result in.
local add ( local  v1,
local  v2,
local  dst 
)
static

Adds the specified vectors and stores the result in dst.

Parameters
v1The first vector.
v2The second vector.
dstA vector to store the result in.
static float angle ( const Vec2 v1,
const Vec2 v2 
)
static

Returns the angle (in radians) between the specified vectors.

Parameters
v1The first vector.
v2The second vector.
Returns
The angle between the two vectors (in radians).
var angle ( var  v1,
var  v2 
)
static

Returns the angle (in radians) between the specified vectors.

Parameters
v1The first vector.
v2The second vector.
Returns
The angle between the two vectors (in radians).
local angle ( local  v1,
local  v2 
)
static

Returns the angle (in radians) between the specified vectors.

Parameters
v1The first vector.
v2The second vector.
Returns
The angle between the two vectors (in radians).
void clamp ( const Vec2 min,
const Vec2 max 
)

Clamps this vector within the specified range.

Parameters
minThe minimum value.
maxThe maximum value.
var clamp ( var  min,
var  max 
)

Clamps this vector within the specified range.

Parameters
minThe minimum value.
maxThe maximum value.
local clamp ( local  min,
local  max 
)

Clamps this vector within the specified range.

Parameters
minThe minimum value.
maxThe maximum value.
static void clamp ( const Vec2 v,
const Vec2 min,
const Vec2 max,
Vec2 dst 
)
static

Clamps the specified vector within the specified range and returns it in dst.

Parameters
vThe vector to clamp.
minThe minimum value.
maxThe maximum value.
dstA vector to store the result in.
var clamp ( var  v,
var  min,
var  max,
var  dst 
)
static

Clamps the specified vector within the specified range and returns it in dst.

Parameters
vThe vector to clamp.
minThe minimum value.
maxThe maximum value.
dstA vector to store the result in.
local clamp ( local  v,
local  min,
local  max,
local  dst 
)
static

Clamps the specified vector within the specified range and returns it in dst.

Parameters
vThe vector to clamp.
minThe minimum value.
maxThe maximum value.
dstA vector to store the result in.
Vec2 compOp ( std::function< float(float)>  function) const
inline

Run a math operation function on each point component absf, fllorf, ceilf, roundf any function that has the signature: float func(float); For example: let's try to take the floor of x,y p.compOp(floorf);.

Since
v3.0
float cross ( const Vec2 other) const
inline

Calculates cross product of two points.

Returns
float
Since
v2.1.4
float distance ( const Vec2 v) const

Returns the distance between this vector and v.

Parameters
vThe other vector.
Returns
The distance between this vector and v.
See also
distanceSquared
var distance ( var  v)

Returns the distance between this vector and v.

Parameters
vThe other vector.
Returns
The distance between this vector and v.
See also
distanceSquared
local distance ( local  v)

Returns the distance between this vector and v.

Parameters
vThe other vector.
Returns
The distance between this vector and v.
See also
distanceSquared
float distanceSquared ( const Vec2 v) const

Returns the squared distance between this vector and v.

When it is not necessary to get the exact distance between two vectors (for example, when simply comparing the distance between different vectors), it is advised to use this method instead of distance.

Parameters
vThe other vector.
Returns
The squared distance between this vector and v.
See also
distance
var distanceSquared ( var  v)

Returns the squared distance between this vector and v.

When it is not necessary to get the exact distance between two vectors (for example, when simply comparing the distance between different vectors), it is advised to use this method instead of distance.

Parameters
vThe other vector.
Returns
The squared distance between this vector and v.
See also
distance
local distanceSquared ( local  v)

Returns the squared distance between this vector and v.

When it is not necessary to get the exact distance between two vectors (for example, when simply comparing the distance between different vectors), it is advised to use this method instead of distance.

Parameters
vThe other vector.
Returns
The squared distance between this vector and v.
See also
distance
float dot ( const Vec2 v) const

Returns the dot product of this vector and the specified vector.

Parameters
vThe vector to compute the dot product with.
Returns
The dot product.
var dot ( var  v)

Returns the dot product of this vector and the specified vector.

Parameters
vThe vector to compute the dot product with.
Returns
The dot product.
local dot ( local  v)

Returns the dot product of this vector and the specified vector.

Parameters
vThe vector to compute the dot product with.
Returns
The dot product.
static float dot ( const Vec2 v1,
const Vec2 v2 
)
static

Returns the dot product between the specified vectors.

Parameters
v1The first vector.
v2The second vector.
Returns
The dot product between the vectors.
var dot ( var  v1,
var  v2 
)
static

Returns the dot product between the specified vectors.

Parameters
v1The first vector.
v2The second vector.
Returns
The dot product between the vectors.
local dot ( local  v1,
local  v2 
)
static

Returns the dot product between the specified vectors.

Parameters
v1The first vector.
v2The second vector.
Returns
The dot product between the vectors.
bool equals ( const Vec2 target) const
local equals ( local  target)
static Vec2 forAngle ( const float  a)
inlinestatic
bool fuzzyEquals ( const Vec2 target,
float  variance 
) const
Returns
if points have fuzzy equality which means equal with some degree of variance.
Since
v2.1.4
float getAngle ( ) const
inline
Returns
the angle in radians between this vector and the x axis
Since
v2.1.4
float getAngle ( const Vec2 other) const
Returns
the angle in radians between two vector directions
Since
v2.1.4
Vec2 getClampPoint ( const Vec2 min_inclusive,
const Vec2 max_inclusive 
) const
inline

Clamp a point between from and to.

Since
v3.0
float getDistance ( const Vec2 other) const
inline

Calculates the distance between two points.

Returns
float
Since
v2.1.4
float getDistanceSq ( const Vec2 other) const
inline

Calculates the square distance between two points (not calling sqrt() )

Returns
float
Since
v2.1.4
static Vec2 getIntersectPoint ( const Vec2 A,
const Vec2 B,
const Vec2 C,
const Vec2 D 
)
static

returns the intersection point of line A-B, C-D

Since
v3.0
float getLength ( ) const
inline

Calculates distance between point an origin.

Returns
float
Since
v2.1.4
float getLengthSq ( ) const
inline

Calculates the square length of a Vec2 (not calling sqrt() )

Returns
float
Since
v2.1.4
Vec2 getMidpoint ( const Vec2 other) const
inline

Calculates midpoint between two points.

Returns
Vec2
Since
v3.0
Vec2 getNormalized ( ) const

Normalizes this vector and stores the result in dst.

If the vector already has unit length or if the length of the vector is zero, this method simply copies the current vector into dst.

Parameters
dstThe destination vector.
var getNormalized ( )

Normalizes this vector and stores the result in dst.

If the vector already has unit length or if the length of the vector is zero, this method simply copies the current vector into dst.

Parameters
dstThe destination vector.
local getNormalized ( )

Normalizes this vector and stores the result in dst.

If the vector already has unit length or if the length of the vector is zero, this method simply copies the current vector into dst.

Parameters
dstThe destination vector.
Vec2 getPerp ( ) const
inline

Calculates perpendicular of v, rotated 90 degrees counter-clockwise – cross(v, perp(v)) >= 0.

Returns
Vec2
Since
v2.1.4
Vec2 getRPerp ( ) const
inline

Calculates perpendicular of v, rotated 90 degrees clockwise – cross(v, rperp(v)) <= 0.

Returns
Vec2
Since
v2.1.4
static bool isLineIntersect ( const Vec2 A,
const Vec2 B,
const Vec2 C,
const Vec2 D,
float *  S = nullptr,
float *  T = nullptr 
)
static

A general line-line intersection test.

Parameters
Athe startpoint for the first line L1 = (A - B)
Bthe endpoint for the first line L1 = (A - B)
Cthe startpoint for the second line L2 = (C - D)
Dthe endpoint for the second line L2 = (C - D)
Sthe range for a hitpoint in L1 (p = A + S*(B - A))
Tthe range for a hitpoint in L2 (p = C + T*(D - C))
Returns
whether these two lines interects.

Note that to truly test intersection for segments we have to make sure that S & T lie within [0..1] and for rays, make sure S & T > 0 the hit point is C + T * (D - C); the hit point also is A + S * (B - A);

Since
3.0
static bool isLineOverlap ( const Vec2 A,
const Vec2 B,
const Vec2 C,
const Vec2 D 
)
static

returns true if Line A-B overlap with segment C-D

Since
v3.0
static bool isLineParallel ( const Vec2 A,
const Vec2 B,
const Vec2 C,
const Vec2 D 
)
static

returns true if Line A-B parallel with segment C-D

Since
v3.0
bool isOne ( ) const

Indicates whether this vector contains all ones.

Returns
true if this vector contains all ones, false otherwise.
var isOne ( )

Indicates whether this vector contains all ones.

Returns
true if this vector contains all ones, false otherwise.
local isOne ( )

Indicates whether this vector contains all ones.

Returns
true if this vector contains all ones, false otherwise.
static bool isSegmentIntersect ( const Vec2 A,
const Vec2 B,
const Vec2 C,
const Vec2 D 
)
static

returns true if Segment A-B intersects with segment C-D

Since
v3.0
static bool isSegmentOverlap ( const Vec2 A,
const Vec2 B,
const Vec2 C,
const Vec2 D,
Vec2 S = nullptr,
Vec2 E = nullptr 
)
static

returns true if Segment A-B overlap with segment C-D

Since
v3.0
bool isZero ( ) const

Indicates whether this vector contains all zeros.

Returns
true if this vector contains all zeros, false otherwise.
var isZero ( )

Indicates whether this vector contains all zeros.

Returns
true if this vector contains all zeros, false otherwise.
local isZero ( )

Indicates whether this vector contains all zeros.

Returns
true if this vector contains all zeros, false otherwise.
float length ( ) const

Computes the length of this vector.

Returns
The length of the vector.
See also
lengthSquared
var length ( )

Computes the length of this vector.

Returns
The length of the vector.
See also
lengthSquared
local length ( )

Computes the length of this vector.

Returns
The length of the vector.
See also
lengthSquared
float lengthSquared ( ) const

Returns the squared length of this vector.

When it is not necessary to get the exact length of a vector (for example, when simply comparing the lengths of different vectors), it is advised to use this method instead of length.

Returns
The squared length of the vector.
See also
length
var lengthSquared ( )

Returns the squared length of this vector.

When it is not necessary to get the exact length of a vector (for example, when simply comparing the lengths of different vectors), it is advised to use this method instead of length.

Returns
The squared length of the vector.
See also
length
local lengthSquared ( )

Returns the squared length of this vector.

When it is not necessary to get the exact length of a vector (for example, when simply comparing the lengths of different vectors), it is advised to use this method instead of length.

Returns
The squared length of the vector.
See also
length
Vec2 lerp ( const Vec2 other,
float  alpha 
) const
inline

Linear Interpolation between two points a and b.

Returns
alpha == 0 ? a alpha == 1 ? b otherwise a value between a..b
Since
v2.1.4
void negate ( )

Negates this vector.

var negate ( )

Negates this vector.

local negate ( )

Negates this vector.

void normalize ( )

Normalizes this vector.

This method normalizes this Vec2 so that it is of unit length (in other words, the length of the vector after calling this method will be 1.0f). If the vector already has unit length or if the length of the vector is zero, this method does nothing.

Returns
This vector, after the normalization occurs.
var normalize ( )

Normalizes this vector.

This method normalizes this Vec2 so that it is of unit length (in other words, the length of the vector after calling this method will be 1.0f). If the vector already has unit length or if the length of the vector is zero, this method does nothing.

Returns
This vector, after the normalization occurs.
local normalize ( )

Normalizes this vector.

This method normalizes this Vec2 so that it is of unit length (in other words, the length of the vector after calling this method will be 1.0f). If the vector already has unit length or if the length of the vector is zero, this method does nothing.

Returns
This vector, after the normalization occurs.
bool operator!= ( const Vec2 v) const
inline

Determines if this vector is not equal to the given vector.

Parameters
vThe vector to compare against.
Returns
True if this vector is not equal to the given vector, false otherwise.
bool operator!= ( var  v)
inline

Determines if this vector is not equal to the given vector.

Parameters
vThe vector to compare against.
Returns
True if this vector is not equal to the given vector, false otherwise.
bool operator!= ( local  v)
inline

Determines if this vector is not equal to the given vector.

Parameters
vThe vector to compare against.
Returns
True if this vector is not equal to the given vector, false otherwise.
const Vec2 operator* ( float  s) const
inline

Calculates the scalar product of this vector with the given value.

Note: this does not modify this vector.

Parameters
sThe value to scale by.
Returns
The scaled vector.
const Vec2 operator* ( var  s)
inline

Calculates the scalar product of this vector with the given value.

Note: this does not modify this vector.

Parameters
sThe value to scale by.
Returns
The scaled vector.
const Vec2 operator* ( local  s)
inline

Calculates the scalar product of this vector with the given value.

Note: this does not modify this vector.

Parameters
sThe value to scale by.
Returns
The scaled vector.
Vec2& operator*= ( float  s)
inline

Scales this vector by the given value.

Parameters
sThe value to scale by.
Returns
This vector, after the scale occurs.
Vec2& operator*= ( var  s)
inline

Scales this vector by the given value.

Parameters
sThe value to scale by.
Returns
This vector, after the scale occurs.
Vec2& operator*= ( local  s)
inline

Scales this vector by the given value.

Parameters
sThe value to scale by.
Returns
This vector, after the scale occurs.
const Vec2 operator+ ( const Vec2 v) const
inline

Calculates the sum of this vector with the given vector.

Note: this does not modify this vector.

Parameters
vThe vector to add.
Returns
The vector sum.
const Vec2 operator+ ( var  v)
inline

Calculates the sum of this vector with the given vector.

Note: this does not modify this vector.

Parameters
vThe vector to add.
Returns
The vector sum.
const Vec2 operator+ ( local  v)
inline

Calculates the sum of this vector with the given vector.

Note: this does not modify this vector.

Parameters
vThe vector to add.
Returns
The vector sum.
Vec2& operator+= ( const Vec2 v)
inline

Adds the given vector to this vector.

Parameters
vThe vector to add.
Returns
This vector, after the addition occurs.
Vec2& operator+= ( var  v)
inline

Adds the given vector to this vector.

Parameters
vThe vector to add.
Returns
This vector, after the addition occurs.
Vec2& operator+= ( local  v)
inline

Adds the given vector to this vector.

Parameters
vThe vector to add.
Returns
This vector, after the addition occurs.
const Vec2 operator- ( const Vec2 v) const
inline

Calculates the sum of this vector with the given vector.

Note: this does not modify this vector.

Parameters
vThe vector to add.
Returns
The vector sum.
const Vec2 operator- ( var  v)
inline

Calculates the sum of this vector with the given vector.

Note: this does not modify this vector.

Parameters
vThe vector to add.
Returns
The vector sum.
const Vec2 operator- ( local  v)
inline

Calculates the sum of this vector with the given vector.

Note: this does not modify this vector.

Parameters
vThe vector to add.
Returns
The vector sum.
const Vec2 operator- ( ) const
inline

Calculates the negation of this vector.

Note: this does not modify this vector.

Returns
The negation of this vector.
const Vec2 operator- ( )
inline

Calculates the negation of this vector.

Note: this does not modify this vector.

Returns
The negation of this vector.
const Vec2 operator- ( )
inline

Calculates the negation of this vector.

Note: this does not modify this vector.

Returns
The negation of this vector.
Vec2& operator-= ( const Vec2 v)
inline

Subtracts the given vector from this vector.

Parameters
vThe vector to subtract.
Returns
This vector, after the subtraction occurs.
Vec2& operator-= ( var  v)
inline

Subtracts the given vector from this vector.

Parameters
vThe vector to subtract.
Returns
This vector, after the subtraction occurs.
Vec2& operator-= ( local  v)
inline

Subtracts the given vector from this vector.

Parameters
vThe vector to subtract.
Returns
This vector, after the subtraction occurs.
const Vec2 operator/ ( float  s) const
inline

Returns the components of this vector divided by the given constant.

Note: this does not modify this vector.

Parameters
sthe constant to divide this vector with
Returns
a smaller vector
const Vec2 operator/ ( var  s)
inline

Returns the components of this vector divided by the given constant.

Note: this does not modify this vector.

Parameters
sthe constant to divide this vector with
Returns
a smaller vector
const Vec2 operator/ ( local  s)
inline

Returns the components of this vector divided by the given constant.

Note: this does not modify this vector.

Parameters
sthe constant to divide this vector with
Returns
a smaller vector
bool operator< ( const Vec2 v) const
inline

Determines if this vector is less than the given vector.

Parameters
vThe vector to compare against.
Returns
True if this vector is less than the given vector, false otherwise.
bool operator< ( var  v)
inline

Determines if this vector is less than the given vector.

Parameters
vThe vector to compare against.
Returns
True if this vector is less than the given vector, false otherwise.
bool operator< ( local  v)
inline

Determines if this vector is less than the given vector.

Parameters
vThe vector to compare against.
Returns
True if this vector is less than the given vector, false otherwise.
bool operator== ( const Vec2 v) const
inline

Determines if this vector is equal to the given vector.

Parameters
vThe vector to compare against.
Returns
True if this vector is equal to the given vector, false otherwise.
bool operator== ( var  v)
inline

Determines if this vector is equal to the given vector.

Parameters
vThe vector to compare against.
Returns
True if this vector is equal to the given vector, false otherwise.
bool operator== ( local  v)
inline

Determines if this vector is equal to the given vector.

Parameters
vThe vector to compare against.
Returns
True if this vector is equal to the given vector, false otherwise.
Vec2 project ( const Vec2 other) const
inline

Calculates the projection of this over other.

Returns
Vec2
Since
v2.1.4
void rotate ( const Vec2 point,
float  angle 
)

Rotates this vector by angle (specified in radians) around the given point.

Parameters
pointThe point to rotate around.
angleThe angle to rotate by (in radians).
var rotate ( var  point,
var  angle 
)

Rotates this vector by angle (specified in radians) around the given point.

Parameters
pointThe point to rotate around.
angleThe angle to rotate by (in radians).
local rotate ( local  point,
local  angle 
)

Rotates this vector by angle (specified in radians) around the given point.

Parameters
pointThe point to rotate around.
angleThe angle to rotate by (in radians).
Vec2 rotate ( const Vec2 other) const
inline

Complex multiplication of two points ("rotates" two points).

Returns
Vec2 vector with an angle of this.getAngle() + other.getAngle(), and a length of this.getLength() * other.getLength().
Since
v2.1.4
Vec2 rotateByAngle ( const Vec2 pivot,
float  angle 
) const

Rotates a point counter clockwise by the angle around a pivot.

Parameters
pivotis the pivot, naturally
angleis the angle of rotation ccw in radians
Returns
the rotated point
Since
v2.1.4
void scale ( float  scalar)

Scales all elements of this vector by the specified value.

Parameters
scalarThe scalar value.
var scale ( var  scalar)

Scales all elements of this vector by the specified value.

Parameters
scalarThe scalar value.
local scale ( local  scalar)

Scales all elements of this vector by the specified value.

Parameters
scalarThe scalar value.
void scale ( const Vec2 scale)

Scales each element of this vector by the matching component of scale.

Parameters
scaleThe vector to scale by.
var scale ( var  scale)

Scales each element of this vector by the matching component of scale.

Parameters
scaleThe vector to scale by.
local scale ( local  scale)

Scales each element of this vector by the matching component of scale.

Parameters
scaleThe vector to scale by.
void set ( float  xx,
float  yy 
)

Sets the elements of this vector to the specified values.

Parameters
xxThe new x coordinate.
yyThe new y coordinate.
var set ( var  xx,
var  yy 
)

Sets the elements of this vector to the specified values.

Parameters
xxThe new x coordinate.
yyThe new y coordinate.
local set ( local  xx,
local  yy 
)

Sets the elements of this vector to the specified values.

Parameters
xxThe new x coordinate.
yyThe new y coordinate.
void set ( const float *  array)

Sets the elements of this vector from the values in the specified array.

Parameters
arrayAn array containing the elements of the vector in the order x, y.
var set ( var  array)

Sets the elements of this vector from the values in the specified array.

Parameters
arrayAn array containing the elements of the vector in the order x, y.
local set ( local  array)

Sets the elements of this vector from the values in the specified array.

Parameters
arrayAn array containing the elements of the vector in the order x, y.
void set ( const Vec2 v)

Sets the elements of this vector to those in the specified vector.

Parameters
vThe vector to copy.
var set ( var  v)

Sets the elements of this vector to those in the specified vector.

Parameters
vThe vector to copy.
local set ( local  v)

Sets the elements of this vector to those in the specified vector.

Parameters
vThe vector to copy.
void set ( const Vec2 p1,
const Vec2 p2 
)

Sets this vector to the directional vector between the specified points.

Parameters
p1The first point.
p2The second point.
var set ( var  p1,
var  p2 
)

Sets this vector to the directional vector between the specified points.

Parameters
p1The first point.
p2The second point.
local set ( local  p1,
local  p2 
)

Sets this vector to the directional vector between the specified points.

Parameters
p1The first point.
p2The second point.
void setPoint ( float  xx,
float  yy 
)
void smooth ( const Vec2 target,
float  elapsedTime,
float  responseTime 
)

Updates this vector towards the given target using a smoothing function.

The given response time determines the amount of smoothing (lag). A longer response time yields a smoother result and more lag. To force this vector to follow the target closely, provide a response time that is very small relative to the given elapsed time.

Parameters
targettarget value.
elapsedTimeelapsed time between calls.
responseTimeresponse time (in the same units as elapsedTime).
var smooth ( var  target,
var  elapsedTime,
var  responseTime 
)

Updates this vector towards the given target using a smoothing function.

The given response time determines the amount of smoothing (lag). A longer response time yields a smoother result and more lag. To force this vector to follow the target closely, provide a response time that is very small relative to the given elapsed time.

Parameters
targettarget value.
elapsedTimeelapsed time between calls.
responseTimeresponse time (in the same units as elapsedTime).
local smooth ( local  target,
local  elapsedTime,
local  responseTime 
)

Updates this vector towards the given target using a smoothing function.

The given response time determines the amount of smoothing (lag). A longer response time yields a smoother result and more lag. To force this vector to follow the target closely, provide a response time that is very small relative to the given elapsed time.

Parameters
targettarget value.
elapsedTimeelapsed time between calls.
responseTimeresponse time (in the same units as elapsedTime).
void subtract ( const Vec2 v)

Subtracts this vector and the specified vector as (this - v) and stores the result in this vector.

Parameters
vThe vector to subtract.
var subtract ( var  v)

Subtracts this vector and the specified vector as (this - v) and stores the result in this vector.

Parameters
vThe vector to subtract.
local subtract ( local  v)

Subtracts this vector and the specified vector as (this - v) and stores the result in this vector.

Parameters
vThe vector to subtract.
static void subtract ( const Vec2 v1,
const Vec2 v2,
Vec2 dst 
)
static

Subtracts the specified vectors and stores the result in dst.

The resulting vector is computed as (v1 - v2).

Parameters
v1The first vector.
v2The second vector.
dstThe destination vector.
var subtract ( var  v1,
var  v2,
var  dst 
)
static

Subtracts the specified vectors and stores the result in dst.

The resulting vector is computed as (v1 - v2).

Parameters
v1The first vector.
v2The second vector.
dstThe destination vector.
local subtract ( local  v1,
local  v2,
local  dst 
)
static

Subtracts the specified vectors and stores the result in dst.

The resulting vector is computed as (v1 - v2).

Parameters
v1The first vector.
v2The second vector.
dstThe destination vector.
Vec2 unrotate ( const Vec2 other) const
inline

Unrotates two points.

Returns
Vec2 vector with an angle of this.getAngle() - other.getAngle(), and a length of this.getLength() * other.getLength().
Since
v2.1.4

Member Data Documentation

const Vec2 ANCHOR_BOTTOM_LEFT
static

equals to Vec2(0, 0)

var ANCHOR_BOTTOM_LEFT
static

equals to Vec2(0, 0)

const Vec2 ANCHOR_BOTTOM_RIGHT
static

equals to Vec2(1, 0)

var ANCHOR_BOTTOM_RIGHT
static

equals to Vec2(1, 0)

local ANCHOR_BOTTOM_RIGHT
static

equals to Vec2(1, 0)

const Vec2 ANCHOR_MIDDLE
static

equals to Vec2(0.5, 0.5)

var ANCHOR_MIDDLE
static

equals to Vec2(0.5, 0.5)

local ANCHOR_MIDDLE
static

equals to Vec2(0.5, 0.5)

const Vec2 ANCHOR_MIDDLE_BOTTOM
static

equals to Vec2(0.5, 0)

const Vec2 ANCHOR_MIDDLE_LEFT
static

equals to Vec2(0, 0.5)

var ANCHOR_MIDDLE_LEFT
static

equals to Vec2(0, 0.5)

const Vec2 ANCHOR_MIDDLE_RIGHT
static

equals to Vec2(1, 0.5)

var ANCHOR_MIDDLE_RIGHT
static

equals to Vec2(1, 0.5)

local ANCHOR_MIDDLE_RIGHT
static

equals to Vec2(1, 0.5)

const Vec2 ANCHOR_MIDDLE_TOP
static

equals to Vec2(0.5, 1)

var ANCHOR_MIDDLE_TOP
static

equals to Vec2(0.5, 1)

local ANCHOR_MIDDLE_TOP
static

equals to Vec2(0.5, 1)

const Vec2 ANCHOR_TOP_LEFT
static

equals to Vec2(0, 1)

var ANCHOR_TOP_LEFT
static

equals to Vec2(0, 1)

local ANCHOR_TOP_LEFT
static

equals to Vec2(0, 1)

const Vec2 ANCHOR_TOP_RIGHT
static

equals to Vec2(1, 1)

var ANCHOR_TOP_RIGHT
static

equals to Vec2(1, 1)

local ANCHOR_TOP_RIGHT
static

equals to Vec2(1, 1)

const Vec2 ONE
static

equals to Vec2(1,1)

const Vec2 UNIT_X
static

equals to Vec2(1,0)

var UNIT_X
static

equals to Vec2(1,0)

local UNIT_X
static

equals to Vec2(1,0)

const Vec2 UNIT_Y
static

equals to Vec2(0,1)

var UNIT_Y
static

equals to Vec2(0,1)

local UNIT_Y
static

equals to Vec2(0,1)

float x

The x coordinate.

float y

The y coordinate.

var y

The y coordinate.

local y

The y coordinate.

const Vec2 ZERO
static

equals to Vec2(0,0)

var ZERO
static

equals to Vec2(0,0)

local ZERO
static

equals to Vec2(0,0)


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