API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Polar

Class used to store (r, theta) vector representation

Hierarchy

  • Polar

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Polar(radius: number, theta: number): Polar

  • Creates a new Polar object

    Parameters

    • radius: number

      the radius of the vector

    • theta: number

      the angle of the vector

    Returns Polar

Properties

radiusSearch playground for radius

radius: number

thetaSearch playground for theta

theta: number

Methods

addSearch playground for add

  • Adds the current Polar and the given Polar

    Parameters

    • polar: Polar

      the polar to add

    Returns Polar

    the sum polar

addInPlaceSearch playground for addInPlace

  • Adds the given polar to the current polar

    Parameters

    • polar: Polar

      the polar to add

    Returns Polar

    the current polar

addInPlaceFromFloatsSearch playground for addInPlaceFromFloats

  • addInPlaceFromFloats(radius: number, theta: number): Polar

  • Adds the provided values to the current polar

    Parameters

    • radius: number

      the amount to add to the radius

    • theta: number

      the amount to add to the theta

    Returns Polar

    the current polar

addToRefSearch playground for addToRef

  • Adds the current Polar and the given Polar and stores the result

    Parameters

    • polar: Polar

      the polar to add

    • ref: Polar

      the polar to store the result in

    Returns Polar

    the updated ref

asArraySearch playground for asArray

  • asArray(): number[]

  • Converts the current polar to an array

    reutrns

    the current polar as an array

    Returns number[]

cloneSearch playground for clone

  • Clones the current polar

    Returns Polar

    a clone of the current polar

copyFromSearch playground for copyFrom

  • Copies the source polar into the current polar

    Parameters

    • source: Polar

      the polar to copy from

    Returns Polar

    the current polar

copyFromFloatsSearch playground for copyFromFloats

  • copyFromFloats(radius: number, theta: number): Polar

  • Copies the given values into the current polar

    Parameters

    • radius: number

      the radius to use

    • theta: number

      the theta to use

    Returns Polar

    the current polar

divideSearch playground for divide

  • Divides the current Polar by the given Polar

    Parameters

    • polar: Polar

      the polar to divide

    Returns Polar

    the quotient polar

divideInPlaceSearch playground for divideInPlace

  • Divides the current Polar by the given Polar

    Parameters

    • polar: Polar

      the polar to divide

    Returns Polar

    the current polar

divideToRefSearch playground for divideToRef

  • Divides the current Polar by the given Polar and stores the result

    Parameters

    • polar: Polar

      the polar to divide

    • ref: Polar

      the polar to store the result in

    Returns Polar

    the updated ref

getClassNameSearch playground for getClassName

  • getClassName(): string

  • Gets the class name

    Returns string

    the string "Polar"

multiplySearch playground for multiply

  • Multiplies the given Polar with the current Polar

    Parameters

    • polar: Polar

      the polar to multiply

    Returns Polar

    the product polar

multiplyInPlaceSearch playground for multiplyInPlace

  • Multiplies the given Polar with the current Polar

    Parameters

    • polar: Polar

      the polar to multiply

    Returns Polar

    the current polar

multiplyToRefSearch playground for multiplyToRef

  • Multiplies the given Polar with the current Polar and stores the result

    Parameters

    • polar: Polar

      the polar to multiply

    • ref: Polar

      the polar to store the result in

    Returns Polar

    the updated ref

scaleSearch playground for scale

  • scale(scale: number): Polar

  • Scales the current polar and returns a new polar with the scaled coordinates

    Parameters

    • scale: number

      defines the multiplication factor

    Returns Polar

    the scaled polar

scaleInPlaceSearch playground for scaleInPlace

  • scaleInPlace(scale: number): Polar

  • Scales the current polar

    Parameters

    • scale: number

      defines the multiplication factor

    Returns Polar

    the current polar

scaleToRefSearch playground for scaleToRef

  • Scales the current polar and stores the result

    Parameters

    • scale: number

      defines the multiplication factor

    • ref: Polar

      where to store the result

    Returns Polar

    the updated ref

setSearch playground for set

  • set(radius: number, theta: number): Polar

  • Sets the values of the current polar

    Parameters

    • radius: number

      the new radius

    • theta: number

      the new theta

    Returns Polar

    the current polar

setAllSearch playground for setAll

  • setAll(value: number): Polar

  • Sets the values of the current polar

    Parameters

    • value: number

      the new values

    Returns Polar

    the current polar

subtractSearch playground for subtract

  • Subtracts the given Polar from the current Polar

    Parameters

    • polar: Polar

      the polar to subtract

    Returns Polar

    the difference polar

subtractFromFloatsSearch playground for subtractFromFloats

  • subtractFromFloats(radius: number, theta: number): Polar

  • Subtracts the given floats from the current polar

    Parameters

    • radius: number

      the amount to subtract from the radius

    • theta: number

      the amount to subtract from the theta

    Returns Polar

    the difference polar

subtractFromFloatsToRefSearch playground for subtractFromFloatsToRef

  • subtractFromFloatsToRef(radius: number, theta: number, ref: Polar): Polar

  • Subtracts the given floats from the current polar

    Parameters

    • radius: number

      the amount to subtract from the radius

    • theta: number

      the amount to subtract from the theta

    • ref: Polar

      the polar to store the result in

    Returns Polar

    the updated ref

subtractInPlaceSearch playground for subtractInPlace

  • Subtracts the given Polar from the current Polar

    Parameters

    • polar: Polar

      the polar to subtract

    Returns Polar

    the current polar

subtractToRefSearch playground for subtractToRef

  • Subtracts the given Polar from the current Polar and stores the result

    Parameters

    • polar: Polar

      the polar to subtract

    • ref: Polar

      the polar to store the result in

    Returns Polar

    the updated ref

toStringSearch playground for toString

  • toString(): string

  • Converts the current polar to a string

    Returns string

    the current polar as a string

toVector2Search playground for toVector2

  • Gets the rectangular coordinates of the current Polar

    Returns Vector2

    the rectangular coordinates

toVector2ToRefSearch playground for toVector2ToRef

  • Gets the rectangular coordinates of the current Polar

    Parameters

    • ref: Vector2

      the reference to assign the result

    Returns Vector2

    the updated reference

Static FromArraySearch playground for FromArray

  • FromArray(array: number[]): Polar

  • Converts an array of floats to a polar

    Parameters

    • array: number[]

      the array to convert

    Returns Polar

    the converted polar

Static FromVector2Search playground for FromVector2

  • Converts a given Vector2 to its polar coordinates

    Parameters

    Returns Polar

    a Polar

Static FromVector2ToRefSearch playground for FromVector2ToRef

  • Converts a given Vector2 to its polar coordinates

    Parameters

    • v: Vector2

      the Vector2 to convert

    • ref: Polar

      the reference to assign the result

    Returns Polar

    the updated reference

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property
  • Method
  • Static method

Settings

Theme