Vec2 (Nape Physics Library)

type: class

2 Dimensional vector.

Note that in many cases of a Vec2 object being returned by a Nape function the Vec2 object will be marked internally as an 'immutable' Vec2. This will always be documented and trying to mutate such a Vec2 will result in an error being thrown.

Vec2 objects can make use of a global object pool, attempting to make use of a disposed Vec2 will also result in an error with the object pool working in a FILO order to increase the likelihood of such misuse being caught.

Additionally Vec2 objects can be created as 'weak'. Passing a weak Vec2 to any Nape function as an argument will result in the automatic disposal of the Vec2 once the method has finished with it. There may be exceptions to this rule which will also be documented; a notable case being the appending of a weak Vec2 to a Nape Vec2List in which case the disposal of the weak Vec2 is performed when that Vec2List is handed to a Nape function instead.

Example:

var vertices = Polygon.box(20, 20, true);
var polygon = new Polygon(vertices);

In this example, passing true to the Polygon.box method means that we will be returned a Vec2List containing only 'weak' Vec2s. Upon passing this Vec2List to the Polygon constructor, all of the Vec2s from that list will be automatically disposed.

Static Methods

Compute distance between two points.

Compute square distance between two points.

Allocate a Vec2 from AS3 Point object.

Allocate a Vec2 given polar coordinates.

Allocates a Vec2 from the global object pool.

Allocate a weak Vec2 from global object pool.

Constructor

Construct a new Vec2.

Instance Properties

Angle of this Vec2.

Length of this Vec2.

x coordinate of vector.

y coordinate of vector.

Instance Methods

Add another vector to this vector.

Add a multiple of a vector to this vector.

Add another vector into this vector.

Produce a copy of this Vec2.

Cross product with another vector.

Release this Vec2 to global object pool.

Dot product with another vector.

Compute squared length of this Vec2.

Multiply this vector with a number.

Normalise this vector.

The right-perpendicular to this vector.

Reflect given Vec2 in plane whose normal is this Vec2.

Rotate Vec2 in-place by given number of radians..

Set values of this Vec2 to those of the argument.

Set values of this Vec2 given pair of x/y values.

Subtract another vector from this vector.

Create an AS3 Point object from Vec2.

Return normalisation of this vector.

nape.geom.Vec2

Static Methods

static inline function distance(a:Vec2, b:Vec2):Float

static inline function dsq(a:Vec2, b:Vec2):Float

static function fromPoint(point:flash.geom.Point, weak:Bool = false):Vec2

static function fromPolar(length:Float, angle:Float, weak:Bool = false):Vec2

static inline function get(x:Float = 0, y:Float = 0, weak:Bool = false):Vec2

static inline function weak(x:Float = 0, y:Float = 0):Vec2

Constructor

Instance Properties

var angle : Float = 0

var length : Float = 0

var x : Float = 0

var y : Float = 0

Instance Methods

function add(vector:Vec2, weak:Bool = false):Vec2

function addMul(vector:Vec2, scalar:Float, weak:Bool = false):Vec2

function addeq(vector:Vec2):Vec2

inline function copy(weak:Bool = false):Vec2

function cross(vector:Vec2):Float

inline function dispose():Void

function dot(vector:Vec2):Float

function lsq():Float

function mul(scalar:Float, weak:Bool = false):Vec2

function muleq(scalar:Float):Vec2

function normalise():Vec2

function perp(weak:Bool = false):Vec2

function reflect(vec:Vec2, weak:Bool = false):Vec2

function rotate(angle:Float):Vec2

inline function set(vector:Vec2):Vec2

inline function setxy(x:Float, y:Float):Vec2

function sub(vector:Vec2, weak:Bool = false):Vec2

function subeq(vector:Vec2):Vec2

function toPoint(output:flash.geom.Point = null):flash.geom.Point

function unit(weak:Bool = false):Vec2