@aidinabedi/playcanvas
Version:
PlayCanvas WebGL game engine
652 lines (590 loc) • 38.6 kB
HTML
<html lang="en">
<head>
<title>pc.Vec2 | PlayCanvas API Reference</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="icon" type="image/png" href="images/playcanvas-favicon.png">
<link href="styles/styles.css" rel="stylesheet">
<link href="styles/playcanvas-theme.css" rel="stylesheet">
<script src="scripts/interface.js"></script>
<script src="scripts/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body>
<header>
<nav class="header-width">
<a href="/" class="header-title"><img src="images/playcanvas-manual.png"></a>
<ul class="header-menu">
<li class="user-manual"><a href="https://developer.playcanvas.com/en/user-manual/">User Manual</a></li>
<li class="tutorials"><a href="https://developer.playcanvas.com/en/tutorials">Tutorials</a></li>
<li class="forum"><a href="https://forum.playcanvas.com/" target="_blank">Forum</a></li>
<li class="api active"><a href="/api/">API Reference</a></li>
</ul>
</nav>
<div class="header-content header-page header-width">
<h1><span class="font-icon"></span>API Reference</h1>
<input id="search" class="search" type="text" placeholder="Search"></input>
</div>
</header>
<div class="container content-width">
<nav class="sidebar">
<div class="sidebarFilter">
<input id="filter-input" type="text" placeholder="Filter">
</div>
<ul>
<li id="nav-pc"><a href="pc.html">pc</a></li>
<li id="nav-pc.callbacks"><a href="pc.callbacks.html">pc.callbacks</a></li>
<li id="nav-pc.guid"><a href="pc.guid.html">pc.guid</a></li>
<li id="nav-pc.math"><a href="pc.math.html">pc.math</a></li>
<li id="nav-pc.path"><a href="pc.path.html">pc.path</a></li>
<li id="nav-pc.platform"><a href="pc.platform.html">pc.platform</a></li>
<li id="nav-pc.script"><a href="pc.script.html">pc.script</a></li>
<li id="nav-pc.string"><a href="pc.string.html">pc.string</a></li>
<li id="nav-pc.Animation"><a href="pc.Animation.html">Animation</a></li>
<li id="nav-pc.AnimationComponent"><a href="pc.AnimationComponent.html">AnimationComponent</a></li>
<li id="nav-pc.AnimationComponentSystem"><a href="pc.AnimationComponentSystem.html">AnimationComponentSystem</a></li>
<li id="nav-pc.AnimationHandler"><a href="pc.AnimationHandler.html">AnimationHandler</a></li>
<li id="nav-pc.AnimCache"><a href="pc.AnimCache.html">AnimCache</a></li>
<li id="nav-pc.AnimClip"><a href="pc.AnimClip.html">AnimClip</a></li>
<li id="nav-pc.AnimController"><a href="pc.AnimController.html">AnimController</a></li>
<li id="nav-pc.AnimCurve"><a href="pc.AnimCurve.html">AnimCurve</a></li>
<li id="nav-pc.AnimData"><a href="pc.AnimData.html">AnimData</a></li>
<li id="nav-pc.AnimSnapshot"><a href="pc.AnimSnapshot.html">AnimSnapshot</a></li>
<li id="nav-pc.AnimTarget"><a href="pc.AnimTarget.html">AnimTarget</a></li>
<li id="nav-pc.AnimTrack"><a href="pc.AnimTrack.html">AnimTrack</a></li>
<li id="nav-pc.Application"><a href="pc.Application.html">Application</a></li>
<li id="nav-pc.Asset"><a href="pc.Asset.html">Asset</a></li>
<li id="nav-pc.AssetReference"><a href="pc.AssetReference.html">AssetReference</a></li>
<li id="nav-pc.AssetRegistry"><a href="pc.AssetRegistry.html">AssetRegistry</a></li>
<li id="nav-pc.AudioHandler"><a href="pc.AudioHandler.html">AudioHandler</a></li>
<li id="nav-pc.AudioListenerComponent"><a href="pc.AudioListenerComponent.html">AudioListenerComponent</a></li>
<li id="nav-pc.AudioListenerComponentSystem"><a href="pc.AudioListenerComponentSystem.html">AudioListenerComponentSystem</a></li>
<li id="nav-pc.BasicMaterial"><a href="pc.BasicMaterial.html">BasicMaterial</a></li>
<li id="nav-pc.Batch"><a href="pc.Batch.html">Batch</a></li>
<li id="nav-pc.BatchGroup"><a href="pc.BatchGroup.html">BatchGroup</a></li>
<li id="nav-pc.BatchManager"><a href="pc.BatchManager.html">BatchManager</a></li>
<li id="nav-pc.BoundingBox"><a href="pc.BoundingBox.html">BoundingBox</a></li>
<li id="nav-pc.BoundingSphere"><a href="pc.BoundingSphere.html">BoundingSphere</a></li>
<li id="nav-pc.ButtonComponent"><a href="pc.ButtonComponent.html">ButtonComponent</a></li>
<li id="nav-pc.ButtonComponentSystem"><a href="pc.ButtonComponentSystem.html">ButtonComponentSystem</a></li>
<li id="nav-pc.CameraComponent"><a href="pc.CameraComponent.html">CameraComponent</a></li>
<li id="nav-pc.CameraComponentSystem"><a href="pc.CameraComponentSystem.html">CameraComponentSystem</a></li>
<li id="nav-pc.CollisionComponent"><a href="pc.CollisionComponent.html">CollisionComponent</a></li>
<li id="nav-pc.CollisionComponentSystem"><a href="pc.CollisionComponentSystem.html">CollisionComponentSystem</a></li>
<li id="nav-pc.Color"><a href="pc.Color.html">Color</a></li>
<li id="nav-pc.Component"><a href="pc.Component.html">Component</a></li>
<li id="nav-pc.ComponentSystem"><a href="pc.ComponentSystem.html">ComponentSystem</a></li>
<li id="nav-pc.ComponentSystemRegistry"><a href="pc.ComponentSystemRegistry.html">ComponentSystemRegistry</a></li>
<li id="nav-pc.ContactPoint"><a href="pc.ContactPoint.html">ContactPoint</a></li>
<li id="nav-pc.ContactResult"><a href="pc.ContactResult.html">ContactResult</a></li>
<li id="nav-pc.ContainerHandler"><a href="pc.ContainerHandler.html">ContainerHandler</a></li>
<li id="nav-pc.ContainerResource"><a href="pc.ContainerResource.html">ContainerResource</a></li>
<li id="nav-pc.Controller"><a href="pc.Controller.html">Controller</a></li>
<li id="nav-pc.CubemapHandler"><a href="pc.CubemapHandler.html">CubemapHandler</a></li>
<li id="nav-pc.Curve"><a href="pc.Curve.html">Curve</a></li>
<li id="nav-pc.CurveSet"><a href="pc.CurveSet.html">CurveSet</a></li>
<li id="nav-pc.ElementComponent"><a href="pc.ElementComponent.html">ElementComponent</a></li>
<li id="nav-pc.ElementComponentSystem"><a href="pc.ElementComponentSystem.html">ElementComponentSystem</a></li>
<li id="nav-pc.ElementDragHelper"><a href="pc.ElementDragHelper.html">ElementDragHelper</a></li>
<li id="nav-pc.ElementInput"><a href="pc.ElementInput.html">ElementInput</a></li>
<li id="nav-pc.ElementInputEvent"><a href="pc.ElementInputEvent.html">ElementInputEvent</a></li>
<li id="nav-pc.ElementMouseEvent"><a href="pc.ElementMouseEvent.html">ElementMouseEvent</a></li>
<li id="nav-pc.ElementTouchEvent"><a href="pc.ElementTouchEvent.html">ElementTouchEvent</a></li>
<li id="nav-pc.Entity"><a href="pc.Entity.html">Entity</a></li>
<li id="nav-pc.EventHandler"><a href="pc.EventHandler.html">EventHandler</a></li>
<li id="nav-pc.Font"><a href="pc.Font.html">Font</a></li>
<li id="nav-pc.FontHandler"><a href="pc.FontHandler.html">FontHandler</a></li>
<li id="nav-pc.ForwardRenderer"><a href="pc.ForwardRenderer.html">ForwardRenderer</a></li>
<li id="nav-pc.Frustum"><a href="pc.Frustum.html">Frustum</a></li>
<li id="nav-pc.GamePads"><a href="pc.GamePads.html">GamePads</a></li>
<li id="nav-pc.GraphicsDevice"><a href="pc.GraphicsDevice.html">GraphicsDevice</a></li>
<li id="nav-pc.GraphNode"><a href="pc.GraphNode.html">GraphNode</a></li>
<li id="nav-pc.Http"><a href="pc.Http.html">Http</a></li>
<li id="nav-pc.I18n"><a href="pc.I18n.html">I18n</a></li>
<li id="nav-pc.IndexBuffer"><a href="pc.IndexBuffer.html">IndexBuffer</a></li>
<li id="nav-pc.Keyboard"><a href="pc.Keyboard.html">Keyboard</a></li>
<li id="nav-pc.KeyboardEvent"><a href="pc.KeyboardEvent.html">KeyboardEvent</a></li>
<li id="nav-pc.Layer"><a href="pc.Layer.html">Layer</a></li>
<li id="nav-pc.LayerComposition"><a href="pc.LayerComposition.html">LayerComposition</a></li>
<li id="nav-pc.LayoutChildComponent"><a href="pc.LayoutChildComponent.html">LayoutChildComponent</a></li>
<li id="nav-pc.LayoutChildComponentSystem"><a href="pc.LayoutChildComponentSystem.html">LayoutChildComponentSystem</a></li>
<li id="nav-pc.LayoutGroupComponent"><a href="pc.LayoutGroupComponent.html">LayoutGroupComponent</a></li>
<li id="nav-pc.LayoutGroupComponentSystem"><a href="pc.LayoutGroupComponentSystem.html">LayoutGroupComponentSystem</a></li>
<li id="nav-pc.LightComponent"><a href="pc.LightComponent.html">LightComponent</a></li>
<li id="nav-pc.LightComponentSystem"><a href="pc.LightComponentSystem.html">LightComponentSystem</a></li>
<li id="nav-pc.Lightmapper"><a href="pc.Lightmapper.html">Lightmapper</a></li>
<li id="nav-pc.Mat3"><a href="pc.Mat3.html">Mat3</a></li>
<li id="nav-pc.Mat4"><a href="pc.Mat4.html">Mat4</a></li>
<li id="nav-pc.Material"><a href="pc.Material.html">Material</a></li>
<li id="nav-pc.MaterialHandler"><a href="pc.MaterialHandler.html">MaterialHandler</a></li>
<li id="nav-pc.Mesh"><a href="pc.Mesh.html">Mesh</a></li>
<li id="nav-pc.MeshInstance"><a href="pc.MeshInstance.html">MeshInstance</a></li>
<li id="nav-pc.Model"><a href="pc.Model.html">Model</a></li>
<li id="nav-pc.ModelComponent"><a href="pc.ModelComponent.html">ModelComponent</a></li>
<li id="nav-pc.ModelComponentSystem"><a href="pc.ModelComponentSystem.html">ModelComponentSystem</a></li>
<li id="nav-pc.ModelHandler"><a href="pc.ModelHandler.html">ModelHandler</a></li>
<li id="nav-pc.Morph"><a href="pc.Morph.html">Morph</a></li>
<li id="nav-pc.MorphInstance"><a href="pc.MorphInstance.html">MorphInstance</a></li>
<li id="nav-pc.MorphTarget"><a href="pc.MorphTarget.html">MorphTarget</a></li>
<li id="nav-pc.Mouse"><a href="pc.Mouse.html">Mouse</a></li>
<li id="nav-pc.MouseEvent"><a href="pc.MouseEvent.html">MouseEvent</a></li>
<li id="nav-pc.Node"><a href="pc.Node.html">Node</a></li>
<li id="nav-pc.OrientedBox"><a href="pc.OrientedBox.html">OrientedBox</a></li>
<li id="nav-pc.ParticleSystemComponent"><a href="pc.ParticleSystemComponent.html">ParticleSystemComponent</a></li>
<li id="nav-pc.ParticleSystemComponentSystem"><a href="pc.ParticleSystemComponentSystem.html">ParticleSystemComponentSystem</a></li>
<li id="nav-pc.Picker"><a href="pc.Picker.html">Picker</a></li>
<li id="nav-pc.PostEffect"><a href="pc.PostEffect.html">PostEffect</a></li>
<li id="nav-pc.PostEffectQueue"><a href="pc.PostEffectQueue.html">PostEffectQueue</a></li>
<li id="nav-pc.Quat"><a href="pc.Quat.html">Quat</a></li>
<li id="nav-pc.Ray"><a href="pc.Ray.html">Ray</a></li>
<li id="nav-pc.RaycastResult"><a href="pc.RaycastResult.html">RaycastResult</a></li>
<li id="nav-pc.RenderTarget"><a href="pc.RenderTarget.html">RenderTarget</a></li>
<li id="nav-pc.ResourceHandler"><a href="pc.ResourceHandler.html">ResourceHandler</a></li>
<li id="nav-pc.ResourceLoader"><a href="pc.ResourceLoader.html">ResourceLoader</a></li>
<li id="nav-pc.RigidBodyComponent"><a href="pc.RigidBodyComponent.html">RigidBodyComponent</a></li>
<li id="nav-pc.RigidBodyComponentSystem"><a href="pc.RigidBodyComponentSystem.html">RigidBodyComponentSystem</a></li>
<li id="nav-pc.Scene"><a href="pc.Scene.html">Scene</a></li>
<li id="nav-pc.SceneHandler"><a href="pc.SceneHandler.html">SceneHandler</a></li>
<li id="nav-pc.ScopeId"><a href="pc.ScopeId.html">ScopeId</a></li>
<li id="nav-pc.ScopeSpace"><a href="pc.ScopeSpace.html">ScopeSpace</a></li>
<li id="nav-pc.ScreenComponent"><a href="pc.ScreenComponent.html">ScreenComponent</a></li>
<li id="nav-pc.ScreenComponentSystem"><a href="pc.ScreenComponentSystem.html">ScreenComponentSystem</a></li>
<li id="nav-pc.ScriptAttributes"><a href="pc.ScriptAttributes.html">ScriptAttributes</a></li>
<li id="nav-pc.ScriptComponent"><a href="pc.ScriptComponent.html">ScriptComponent</a></li>
<li id="nav-pc.ScriptComponentSystem"><a href="pc.ScriptComponentSystem.html">ScriptComponentSystem</a></li>
<li id="nav-pc.ScriptHandler"><a href="pc.ScriptHandler.html">ScriptHandler</a></li>
<li id="nav-pc.ScriptRegistry"><a href="pc.ScriptRegistry.html">ScriptRegistry</a></li>
<li id="nav-pc.ScriptType"><a href="pc.ScriptType.html">ScriptType</a></li>
<li id="nav-pc.ScrollbarComponent"><a href="pc.ScrollbarComponent.html">ScrollbarComponent</a></li>
<li id="nav-pc.ScrollbarComponentSystem"><a href="pc.ScrollbarComponentSystem.html">ScrollbarComponentSystem</a></li>
<li id="nav-pc.ScrollViewComponent"><a href="pc.ScrollViewComponent.html">ScrollViewComponent</a></li>
<li id="nav-pc.ScrollViewComponentSystem"><a href="pc.ScrollViewComponentSystem.html">ScrollViewComponentSystem</a></li>
<li id="nav-pc.Shader"><a href="pc.Shader.html">Shader</a></li>
<li id="nav-pc.SingleContactResult"><a href="pc.SingleContactResult.html">SingleContactResult</a></li>
<li id="nav-pc.Skeleton"><a href="pc.Skeleton.html">Skeleton</a></li>
<li id="nav-pc.Skin"><a href="pc.Skin.html">Skin</a></li>
<li id="nav-pc.SkinInstance"><a href="pc.SkinInstance.html">SkinInstance</a></li>
<li id="nav-pc.Sound"><a href="pc.Sound.html">Sound</a></li>
<li id="nav-pc.SoundComponent"><a href="pc.SoundComponent.html">SoundComponent</a></li>
<li id="nav-pc.SoundComponentSystem"><a href="pc.SoundComponentSystem.html">SoundComponentSystem</a></li>
<li id="nav-pc.SoundInstance"><a href="pc.SoundInstance.html">SoundInstance</a></li>
<li id="nav-pc.SoundInstance3d"><a href="pc.SoundInstance3d.html">SoundInstance3d</a></li>
<li id="nav-pc.SoundManager"><a href="pc.SoundManager.html">SoundManager</a></li>
<li id="nav-pc.SoundSlot"><a href="pc.SoundSlot.html">SoundSlot</a></li>
<li id="nav-pc.Sprite"><a href="pc.Sprite.html">Sprite</a></li>
<li id="nav-pc.SpriteAnimationClip"><a href="pc.SpriteAnimationClip.html">SpriteAnimationClip</a></li>
<li id="nav-pc.SpriteComponent"><a href="pc.SpriteComponent.html">SpriteComponent</a></li>
<li id="nav-pc.SpriteComponentSystem"><a href="pc.SpriteComponentSystem.html">SpriteComponentSystem</a></li>
<li id="nav-pc.SpriteHandler"><a href="pc.SpriteHandler.html">SpriteHandler</a></li>
<li id="nav-pc.StandardMaterial"><a href="pc.StandardMaterial.html">StandardMaterial</a></li>
<li id="nav-pc.StencilParameters"><a href="pc.StencilParameters.html">StencilParameters</a></li>
<li id="nav-pc.Tags"><a href="pc.Tags.html">Tags</a></li>
<li id="nav-pc.Texture"><a href="pc.Texture.html">Texture</a></li>
<li id="nav-pc.TextureAtlas"><a href="pc.TextureAtlas.html">TextureAtlas</a></li>
<li id="nav-pc.TextureAtlasHandler"><a href="pc.TextureAtlasHandler.html">TextureAtlasHandler</a></li>
<li id="nav-pc.TextureHandler"><a href="pc.TextureHandler.html">TextureHandler</a></li>
<li id="nav-pc.Touch"><a href="pc.Touch.html">Touch</a></li>
<li id="nav-pc.TouchDevice"><a href="pc.TouchDevice.html">TouchDevice</a></li>
<li id="nav-pc.TouchEvent"><a href="pc.TouchEvent.html">TouchEvent</a></li>
<li id="nav-pc.TransformFeedback"><a href="pc.TransformFeedback.html">TransformFeedback</a></li>
<li id="nav-pc.Vec2"><a href="pc.Vec2.html">Vec2</a></li>
<li id="nav-pc.Vec3"><a href="pc.Vec3.html">Vec3</a></li>
<li id="nav-pc.Vec4"><a href="pc.Vec4.html">Vec4</a></li>
<li id="nav-pc.VertexAttributeDescription"><a href="pc.VertexAttributeDescription.html">VertexAttributeDescription</a></li>
<li id="nav-pc.VertexAttributeElement"><a href="pc.VertexAttributeElement.html">VertexAttributeElement</a></li>
<li id="nav-pc.VertexBuffer"><a href="pc.VertexBuffer.html">VertexBuffer</a></li>
<li id="nav-pc.VertexFormat"><a href="pc.VertexFormat.html">VertexFormat</a></li>
<li id="nav-pc.VertexIterator"><a href="pc.VertexIterator.html">VertexIterator</a></li>
<li id="nav-pc.VertexIteratorAccessor"><a href="pc.VertexIteratorAccessor.html">VertexIteratorAccessor</a></li>
<li id="nav-pc.XrInput"><a href="pc.XrInput.html">XrInput</a></li>
<li id="nav-pc.XrInputSource"><a href="pc.XrInputSource.html">XrInputSource</a></li>
<li id="nav-pc.XrManager"><a href="pc.XrManager.html">XrManager</a></li>
</ul>
</nav>
<div class='sidebarToggle'><span></span>Class List</div>
<main class="cls">
<h1>pc.Vec2</h1>
<p><p>A 2-dimensional vector.</p></p>
<pre><code class="javascript">var v = new pc.Vec2(1, 2);</code></pre>
<!-- summary -->
<h1>Summary</h1>
<!--type definitions-->
<!--static properties-->
<h3>Static Properties</h3>
<table class="properties">
<tr>
<td><a href="#DOWN">DOWN</a></td><td><p>A constant vector set to [0, -1].<span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td><a href="#LEFT">LEFT</a></td><td><p>A constant vector set to [-1, 0].<span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td><a href="#ONE">ONE</a></td><td><p>A constant vector set to [1, 1].<span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td><a href="#RIGHT">RIGHT</a></td><td><p>A constant vector set to [1, 0].<span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td><a href="#UP">UP</a></td><td><p>A constant vector set to [0, 1].<span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td><a href="#ZERO">ZERO</a></td><td><p>A constant vector set to [0, 0].<span class='readonly'>[read only]</span></td>
</tr>
</table>
<!--static methods-->
<!--properties-->
<h3>Properties</h3>
<table class="properties">
<tr>
<td><a href="#x">x</a></td><td><p>The first element of the vector.</td>
</tr>
<tr>
<td><a href="#y">y</a></td><td><p>The second element of the vector.</td>
</tr>
</table>
<!--methods-->
<h3>Methods</h3>
<table class="properties">
<tr>
<td><a href="#add">add</a></td><td><p>Adds a 2-dimensional vector to another in place.</td>
</tr>
<tr>
<td><a href="#add2">add2</a></td><td><p>Adds two 2-dimensional vectors together and returns the result.</td>
</tr>
<tr>
<td><a href="#clone">clone</a></td><td><p>Returns an identical copy of the specified 2-dimensional vector.</td>
</tr>
<tr>
<td><a href="#copy">copy</a></td><td><p>Copied the contents of a source 2-dimensional vector to a destination 2-dimensional vector.</td>
</tr>
<tr>
<td><a href="#distance">distance</a></td><td><p>Returns the distance between the two specified 2-dimensional vectors.</td>
</tr>
<tr>
<td><a href="#dot">dot</a></td><td><p>Returns the result of a dot product operation performed on the two specified 2-dimensional vectors.</td>
</tr>
<tr>
<td><a href="#equals">equals</a></td><td><p>Reports whether two vectors are equal.</td>
</tr>
<tr>
<td><a href="#length">length</a></td><td><p>Returns the magnitude of the specified 2-dimensional vector.</td>
</tr>
<tr>
<td><a href="#lengthSq">lengthSq</a></td><td><p>Returns the magnitude squared of the specified 2-dimensional vector.</td>
</tr>
<tr>
<td><a href="#lerp">lerp</a></td><td><p>Returns the result of a linear interpolation between two specified 2-dimensional vectors.</td>
</tr>
<tr>
<td><a href="#mul">mul</a></td><td><p>Multiplies a 2-dimensional vector to another in place.</td>
</tr>
<tr>
<td><a href="#mul2">mul2</a></td><td><p>Returns the result of multiplying the specified 2-dimensional vectors together.</td>
</tr>
<tr>
<td><a href="#normalize">normalize</a></td><td><p>Returns this 2-dimensional vector converted to a unit vector in place.</td>
</tr>
<tr>
<td><a href="#scale">scale</a></td><td><p>Scales each component of the specified 2-dimensional vector by the supplied
scalar value.</td>
</tr>
<tr>
<td><a href="#set">set</a></td><td><p>Sets the specified 2-dimensional vector to the supplied numerical values.</td>
</tr>
<tr>
<td><a href="#sub">sub</a></td><td><p>Subtracts a 2-dimensional vector from another in place.</td>
</tr>
<tr>
<td><a href="#sub2">sub2</a></td><td><p>Subtracts two 2-dimensional vectors from one another and returns the result.</td>
</tr>
<tr>
<td><a href="#toString">toString</a></td><td><p>Converts the vector to string form.</td>
</tr>
</table>
<!--events-->
<h1>Details</h1>
<!--type definitions-->
<!--static members-->
<h2>Static Properties</h2>
<table class="members">
<tr>
<td id="DOWN">DOWN</td><td><p>A constant vector set to [0, -1].</p><span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td id="LEFT">LEFT</td><td><p>A constant vector set to [-1, 0].</p><span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td id="ONE">ONE</td><td><p>A constant vector set to [1, 1].</p><span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td id="RIGHT">RIGHT</td><td><p>A constant vector set to [1, 0].</p><span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td id="UP">UP</td><td><p>A constant vector set to [0, 1].</p><span class='readonly'>[read only]</span></td>
</tr>
<tr>
<td id="ZERO">ZERO</td><td><p>A constant vector set to [0, 0].</p><span class='readonly'>[read only]</span></td>
</tr>
</table>
<!--static methods-->
<h2>Constructor</h2>
<!-- Constructor -->
<div id="Vec2">
<h3 class="methodname">Vec2([x], [y]) <a class="font-icon" href="#Vec2"></a></h3>
<p><p>Creates a new Vec2 object.</p></p>
<pre><code class="javascript">var v = new pc.Vec2(1, 2);</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>x</td><td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number[]</a></td><td><p>The x value. If x is an array of length 2, the array will be used to populate all components.</p></td>
</tr>
<tr>
<td>y</td><td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></td><td><p>The y value.</p></td>
</tr>
</table>
</div>
<!--properties-->
<h2>Properties</h2>
<div id="x">
<span class="property"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span><span class="property">x <a class="font-icon" href="#x"></a></span>
<p><p>The first element of the vector.</p></p>
<pre><code class="javascript">var vec = new pc.Vec2(10, 20);
// Get x
var x = vec.x;
// Set x
vec.x = 0;</code></pre>
</div>
<div id="y">
<span class="property"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></span><span class="property">y <a class="font-icon" href="#y"></a></span>
<p><p>The second element of the vector.</p></p>
<pre><code class="javascript">var vec = new pc.Vec2(10, 20);
// Get y
var y = vec.y;
// Set y
vec.y = 0;</code></pre>
</div>
<!--methods-->
<h2>Methods</h2>
<div id="add">
<h3 class="methodname">add(rhs) <a class="font-icon" href="#add"></a></h3>
<p><p>Adds a 2-dimensional vector to another in place.</p></p>
<pre><code class="javascript">var a = new pc.Vec2(10, 10);
var b = new pc.Vec2(20, 20);
a.add(b);
// Should output [30, 30]
console.log("The result of the addition is: " + a.toString());</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>rhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>The vector to add to the specified vector.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="pc.Vec2.html">pc.Vec2</a> <p>Self for chaining.</p>
</div>
<div id="add2">
<h3 class="methodname">add2(lhs, rhs) <a class="font-icon" href="#add2"></a></h3>
<p><p>Adds two 2-dimensional vectors together and returns the result.</p></p>
<pre><code class="javascript">var a = new pc.Vec2(10, 10);
var b = new pc.Vec2(20, 20);
var r = new pc.Vec2();
r.add2(a, b);
// Should output [30, 30]
console.log("The result of the addition is: " + r.toString());</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>lhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>The first vector operand for the addition.</p></td>
</tr>
<tr>
<td>rhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>The second vector operand for the addition.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="pc.Vec2.html">pc.Vec2</a> <p>Self for chaining.</p>
</div>
<div id="clone">
<h3 class="methodname">clone() <a class="font-icon" href="#clone"></a></h3>
<p><p>Returns an identical copy of the specified 2-dimensional vector.</p></p>
<pre><code class="javascript">var v = new pc.Vec2(10, 20);
var vclone = v.clone();
console.log("The result of the cloning is: " + vclone.toString());</code></pre>
<h4>Returns</h4>
<a href="pc.Vec2.html">pc.Vec2</a> <p>A 2-dimensional vector containing the result of the cloning.</p>
</div>
<div id="copy">
<h3 class="methodname">copy(rhs) <a class="font-icon" href="#copy"></a></h3>
<p><p>Copied the contents of a source 2-dimensional vector to a destination 2-dimensional vector.</p></p>
<pre><code class="javascript">var src = new pc.Vec2(10, 20);
var dst = new pc.Vec2();
dst.copy(src);
console.log("The two vectors are " + (dst.equals(src) ? "equal" : "different"));</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>rhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>A vector to copy to the specified vector.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="pc.Vec2.html">pc.Vec2</a> <p>Self for chaining.</p>
</div>
<div id="distance">
<h3 class="methodname">distance(rhs) <a class="font-icon" href="#distance"></a></h3>
<p><p>Returns the distance between the two specified 2-dimensional vectors.</p></p>
<pre><code class="javascript">var v1 = new pc.Vec2(5, 10);
var v2 = new pc.Vec2(10, 20);
var d = v1.distance(v2);
console.log("The between v1 and v2 is: " + d);</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>rhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>The second 2-dimensional vector to test.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a> <p>The distance between the two vectors.</p>
</div>
<div id="dot">
<h3 class="methodname">dot(rhs) <a class="font-icon" href="#dot"></a></h3>
<p><p>Returns the result of a dot product operation performed on the two specified 2-dimensional vectors.</p></p>
<pre><code class="javascript">var v1 = new pc.Vec2(5, 10);
var v2 = new pc.Vec2(10, 20);
var v1dotv2 = v1.dot(v2);
console.log("The result of the dot product is: " + v1dotv2);</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>rhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>The second 2-dimensional vector operand of the dot product.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a> <p>The result of the dot product operation.</p>
</div>
<div id="equals">
<h3 class="methodname">equals(rhs) <a class="font-icon" href="#equals"></a></h3>
<p><p>Reports whether two vectors are equal.</p></p>
<pre><code class="javascript">var a = new pc.Vec2(1, 2);
var b = new pc.Vec2(4, 5);
console.log("The two vectors are " + (a.equals(b) ? "equal" : "different"));</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>rhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>The vector to compare to the specified vector.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a> <p>True if the vectors are equal and false otherwise.</p>
</div>
<div id="length">
<h3 class="methodname">length() <a class="font-icon" href="#length"></a></h3>
<p><p>Returns the magnitude of the specified 2-dimensional vector.</p></p>
<pre><code class="javascript">var vec = new pc.Vec2(3, 4);
var len = vec.length();
// Should output 5
console.log("The length of the vector is: " + len);</code></pre>
<h4>Returns</h4>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a> <p>The magnitude of the specified 2-dimensional vector.</p>
</div>
<div id="lengthSq">
<h3 class="methodname">lengthSq() <a class="font-icon" href="#lengthSq"></a></h3>
<p><p>Returns the magnitude squared of the specified 2-dimensional vector.</p></p>
<pre><code class="javascript">var vec = new pc.Vec2(3, 4);
var len = vec.lengthSq();
// Should output 25
console.log("The length squared of the vector is: " + len);</code></pre>
<h4>Returns</h4>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a> <p>The magnitude of the specified 2-dimensional vector.</p>
</div>
<div id="lerp">
<h3 class="methodname">lerp(lhs, rhs, alpha) <a class="font-icon" href="#lerp"></a></h3>
<p><p>Returns the result of a linear interpolation between two specified 2-dimensional vectors.</p></p>
<pre><code class="javascript">var a = new pc.Vec2(0, 0);
var b = new pc.Vec2(10, 10);
var r = new pc.Vec2();
r.lerp(a, b, 0); // r is equal to a
r.lerp(a, b, 0.5); // r is 5, 5
r.lerp(a, b, 1); // r is equal to b</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>lhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>The 2-dimensional to interpolate from.</p></td>
</tr>
<tr>
<td>rhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>The 2-dimensional to interpolate to.</p></td>
</tr>
<tr>
<td>alpha</td><td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></td><td><p>The value controlling the point of interpolation. Between 0 and 1, the linear interpolant
will occur on a straight line between lhs and rhs. Outside of this range, the linear interpolant will occur on
a ray extrapolated from this line.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="pc.Vec2.html">pc.Vec2</a> <p>Self for chaining.</p>
</div>
<div id="mul">
<h3 class="methodname">mul(rhs) <a class="font-icon" href="#mul"></a></h3>
<p><p>Multiplies a 2-dimensional vector to another in place.</p></p>
<pre><code class="javascript">var a = new pc.Vec2(2, 3);
var b = new pc.Vec2(4, 5);
a.mul(b);
// Should output 8, 15
console.log("The result of the multiplication is: " + a.toString());</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>rhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>The 2-dimensional vector used as the second multiplicand of the operation.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="pc.Vec2.html">pc.Vec2</a> <p>Self for chaining.</p>
</div>
<div id="mul2">
<h3 class="methodname">mul2(lhs, rhs) <a class="font-icon" href="#mul2"></a></h3>
<p><p>Returns the result of multiplying the specified 2-dimensional vectors together.</p></p>
<pre><code class="javascript">var a = new pc.Vec2(2, 3);
var b = new pc.Vec2(4, 5);
var r = new pc.Vec2();
r.mul2(a, b);
// Should output 8, 15
console.log("The result of the multiplication is: " + r.toString());</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>lhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>The 2-dimensional vector used as the first multiplicand of the operation.</p></td>
</tr>
<tr>
<td>rhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>The 2-dimensional vector used as the second multiplicand of the operation.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="pc.Vec2.html">pc.Vec2</a> <p>Self for chaining.</p>
</div>
<div id="normalize">
<h3 class="methodname">normalize() <a class="font-icon" href="#normalize"></a></h3>
<p><p>Returns this 2-dimensional vector converted to a unit vector in place.
If the vector has a length of zero, the vector's elements will be set to zero.</p></p>
<pre><code class="javascript">var v = new pc.Vec2(25, 0);
v.normalize();
// Should output 1, 0
console.log("The result of the vector normalization is: " + v.toString());</code></pre>
<h4>Returns</h4>
<a href="pc.Vec2.html">pc.Vec2</a> <p>Self for chaining.</p>
</div>
<div id="scale">
<h3 class="methodname">scale(scalar) <a class="font-icon" href="#scale"></a></h3>
<p><p>Scales each component of the specified 2-dimensional vector by the supplied
scalar value.</p></p>
<pre><code class="javascript">var v = new pc.Vec2(2, 4);
// Multiply by 2
v.scale(2);
// Negate
v.scale(-1);
// Divide by 2
v.scale(0.5);</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>scalar</td><td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></td><td><p>The value by which each vector component is multiplied.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="pc.Vec2.html">pc.Vec2</a> <p>Self for chaining.</p>
</div>
<div id="set">
<h3 class="methodname">set(x, y) <a class="font-icon" href="#set"></a></h3>
<p><p>Sets the specified 2-dimensional vector to the supplied numerical values.</p></p>
<pre><code class="javascript">var v = new pc.Vec2();
v.set(5, 10);
// Should output 5, 10
console.log("The result of the vector set is: " + v.toString());</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>x</td><td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></td><td><p>The value to set on the first component of the vector.</p></td>
</tr>
<tr>
<td>y</td><td><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></td><td><p>The value to set on the second component of the vector.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="pc.Vec2.html">pc.Vec2</a> <p>Self for chaining.</p>
</div>
<div id="sub">
<h3 class="methodname">sub(rhs) <a class="font-icon" href="#sub"></a></h3>
<p><p>Subtracts a 2-dimensional vector from another in place.</p></p>
<pre><code class="javascript">var a = new pc.Vec2(10, 10);
var b = new pc.Vec2(20, 20);
a.sub(b);
// Should output [-10, -10]
console.log("The result of the addition is: " + a.toString());</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>rhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>The vector to add to the specified vector.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="pc.Vec2.html">pc.Vec2</a> <p>Self for chaining.</p>
</div>
<div id="sub2">
<h3 class="methodname">sub2(lhs, rhs) <a class="font-icon" href="#sub2"></a></h3>
<p><p>Subtracts two 2-dimensional vectors from one another and returns the result.</p></p>
<pre><code class="javascript">var a = new pc.Vec2(10, 10);
var b = new pc.Vec2(20, 20);
var r = new pc.Vec2();
r.sub2(a, b);
// Should output [-10, -10]
console.log("The result of the addition is: " + r.toString());</code></pre>
<h4>Parameters</h4>
<table>
<tr>
<td>lhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>The first vector operand for the addition.</p></td>
</tr>
<tr>
<td>rhs</td><td><a href="pc.Vec2.html">pc.Vec2</a></td><td><p>The second vector operand for the addition.</p></td>
</tr>
</table>
<h4>Returns</h4>
<a href="pc.Vec2.html">pc.Vec2</a> <p>Self for chaining.</p>
</div>
<div id="toString">
<h3 class="methodname">toString() <a class="font-icon" href="#toString"></a></h3>
<p><p>Converts the vector to string form.</p></p>
<pre><code class="javascript">var v = new pc.Vec2(20, 10);
// Should output '[20, 10]'
console.log(v.toString());</code></pre>
<h4>Returns</h4>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a> <p>The vector in string form.</p>
</div>
<!--events-->
</main>
</div>
</body>
</html>