API Docs for: v2.1.0
Show:

CGSGDimension Class

Extends CGSGVector2D
Defined in: src\utils\class.region.js:216
Module: Util

A Dimension object

Constructor

CGSGDimension

(
  • width
  • height
)

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

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

() CGSGDimension

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

Return a new object with these attributes

Returns:

CGSGDimension:

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

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:

isEmpty

() Boolean

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

Return true if no pixels are inside the dimension

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

resizeBy

(
  • widthFactor
  • heightFactor
)

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

Multiply current dimension by these new ones

Parameters:

resizeTo

(
  • newWidth
  • newHeight
)

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

Replace current dimension by these new ones

Parameters:

resizeWith

(
  • width
  • height
)

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

Increase/decrease current dimension with adding values

Parameters:

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

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

Properties

height

Number

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

Alias to the y attribute

width

Number

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

Alias to the x attribute