API Docs for: v2.1.0
Show:

CGSGScale Class

Extends CGSGPosition
Defined in: src\utils\class.region.js:111
Module: Util

A Scale object

Constructor

CGSGScale

(
  • x
  • y
)

Defined in src\utils\class.region.js:111

Parameters:

Methods

add

(
  • vector
)
public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:61

returns a new vector added to the value passed in parameter

Parameters:

addEquals

(
  • vector
)
public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:71

add to this vector, the value passed in parameter

Parameters:

copy

() CGSGPosition public

Inherited from CGSGVector2D but overwritten in src\utils\class.region.js:55

return a new object with these attributes

Returns:

CGSGPosition:

cross

() public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:271

Get cross product of this vector and another vector

divide

(
  • vector
)
public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:124

return a new vector divided by the value passed in parameter

Parameters:

divideByFloat

(
  • f
)
public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:166

Divide x and y by f

Parameters:

divideByFloatEquals

(
  • f
)
public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:176

Divide x and y by f

Parameters:

divideEquals

(
  • vector
)
public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:134

divide to this vector, the value passed in parameter

Parameters:

dot

() public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:262

Get dot product of this vector and another vector

equalsTo

(
  • position
)
Boolean public

Inherited from CGSGPosition: src\utils\class.region.js:44

Indicates if this position meaningfully equals to the given position.

Parameters:

  • position CGSGPosition

    the position to compare to this position

Returns:

Boolean:

true if given position exists and has same coordinates as this position, false otherwise

getDistance

(
  • vector
)
Number public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:187

Compute the euclidian distance between this vector and the one passe in parameter

Parameters:

Returns:

Number:

getLength

() Number public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:214

Returns:

Number:

getSquaredLength

() Number public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:223

Returns:

Number:

isNegative

() Boolean

Inherited from CGSGPosition: src\utils\class.region.js:100

Return true if x<0 || y<0

Returns:

Boolean:

multiply

(
  • vector
)
public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:103

returns a new vector multiplied to the value passed in parameter

Parameters:

multiplyByFloat

(
  • f
)
public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:145

Multiply x and y by f

Parameters:

multiplyByFloatEquals

(
  • f
)
public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:155

Multiply x and y by f

Parameters:

multiplyEquals

(
  • vector
)
public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:113

multiply to this vector, the value passed in parameter

Parameters:

normalize

() public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:232

Normalize this vector

perp

() public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:315

Get a perpendicular vector of this vector

perpendicular

() public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:324

Get a vector perpendicular to this vector and another vector

project

() public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:333

Get a projected vector of this vector and another vector

rotate

(
  • angle
)
public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:201

rotate this vector around its origin

Parameters:

sign

() public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:251

Determines if a given vector is to the right or left of this vector.

subtract

(
  • vector
)
public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:82

returns a new vector subtracted from the value passed in parameter

Parameters:

subtractEquals

(
  • vector
)
public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:92

subtract to this vector, the value passed in parameter

Parameters:

toString

() public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:344

Get a string representing this vector

translateBy

(
  • x
  • y
)
public

Inherited from CGSGPosition: src\utils\class.region.js:88

Add new coordinate to the current relative one

Parameters:

translateTo

(
  • newX
  • newY
)

Inherited from CGSGPosition: src\utils\class.region.js:65

Replace current relative position by this new one

Parameters:

translateWith

(
  • x
  • y
)
public

Inherited from CGSGPosition: src\utils\class.region.js:76

Add new coordinate to the current relative one

Parameters:

unit

() public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:280

Get unit vector of this vector and another vector

unitEquals

() public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:306

Get unit vector of this vector and another vector

unitFast

() public

Inherited from CGSGVector2D: src\utils\math\class.vector2D.js:289

Get approximation of unit vector of this vector and another vector