Graphene-1.0 ▶ Graphene ▶ Vec2

constructor

• new Vec2(properties?: Partial<{}>): Vec2

  Parameters

  • Optionalproperties: Partial<{}>

  Returns Vec2

Static$gtype

Since 1.0add

• add(b: Vec2): Vec2

  Adds each component of the two passed vectors and places each result into the components of res.

  Parameters

  • b: Vec2

    a Graphene.Vec2

  Returns Vec2

  Since

  1.0

Since 1.0divide

• divide(b: Vec2): Vec2

  Divides each component of the first operand a by the corresponding component of the second operand b, and places the results into the vector res.

  Parameters

  • b: Vec2

    a Graphene.Vec2

  Returns Vec2

  Since

  1.0

Since 1.0dot

• dot(b: Vec2): number

  Computes the dot product of the two given vectors.

  Parameters

  • b: Vec2

    a Graphene.Vec2

  Returns number

  the dot product of the vectors

  Since

  1.0

Since 1.2equal

• equal(v2: Vec2): boolean

  Checks whether the two given Graphene.Vec2 are equal.

  Parameters

  • v2: Vec2

    a Graphene.Vec2

  Returns boolean

  true if the two vectors are equal, and false otherwise

  Since

  1.2

Since 1.0free

• free(): void

  Frees the resources allocated by v

  Returns void

  Since

  1.0

Since 1.0get_x

• get_x(): number

  Retrieves the X component of the Graphene.Vec2.

  Returns number

  the value of the X component

  Since

  1.0

Since 1.0get_y

• get_y(): number

  Retrieves the Y component of the Graphene.Vec2.

  Returns number

  the value of the Y component

  Since

  1.0

Since 1.0init

• init(x: number, y: number): Vec2

  Initializes a Graphene.Vec2 using the given values.

  This function can be called multiple times.

  Parameters

  • x: number

    the X field of the vector

  • y: number

    the Y field of the vector

  Returns Vec2

  the initialized vector

  Since

  1.0

Since 1.0init_from_float

• init_from_float(src: number[]): Vec2

  Initializes v with the contents of the given array.

  Parameters

  • src: number[]

    an array of floating point values with at least two elements

  Returns Vec2

  the initialized vector

  Since

  1.0

Since 1.0init_from_vec2

• init_from_vec2(src: Vec2): Vec2

  Copies the contents of src into v.

  Parameters

  • src: Vec2

    a Graphene.Vec2

  Returns Vec2

  the initialized vector

  Since

  1.0

Since 1.10interpolate

• interpolate(v2: Vec2, factor: number): Vec2

  Linearly interpolates v1 and v2 using the given factor.

  Parameters

  • v2: Vec2

    a Graphene.Vec2

  • factor: number

    the interpolation factor

  Returns Vec2

  Since

  1.10

Since 1.0length

• length(): number

  Computes the length of the given vector.

  Returns number

  the length of the vector

  Since

  1.0

Since 1.0max

• max(b: Vec2): Vec2

  Compares the two given vectors and places the maximum values of each component into res.

  Parameters

  • b: Vec2

    a Graphene.Vec2

  Returns Vec2

  Since

  1.0

Since 1.0min

• min(b: Vec2): Vec2

  Compares the two given vectors and places the minimum values of each component into res.

  Parameters

  • b: Vec2

    a Graphene.Vec2

  Returns Vec2

  Since

  1.0

Since 1.0multiply

• multiply(b: Vec2): Vec2

  Multiplies each component of the two passed vectors and places each result into the components of res.

  Parameters

  • b: Vec2

    a Graphene.Vec2

  Returns Vec2

  Since

  1.0

Since 1.2near

• near(v2: Vec2, epsilon: number): boolean

  Compares the two given Graphene.Vec2 vectors and checks whether their values are within the given epsilon.

  Parameters

  • v2: Vec2

    a Graphene.Vec2

  • epsilon: number

    the threshold between the two vectors

  Returns boolean

  true if the two vectors are near each other

  Since

  1.2

Since 1.2negate

• negate(): Vec2

  Negates the given Graphene.Vec2.

  Returns Vec2

  Since

  1.2

Since 1.0normalize

• normalize(): Vec2

  Computes the normalized vector for the given vector v.

  Returns Vec2

  Since

  1.0

Since 1.2scale

• scale(factor: number): Vec2

  Multiplies all components of the given vector with the given scalar factor.

  Parameters

  • factor: number

    the scalar factor

  Returns Vec2

  Since

  1.2

Since 1.0subtract

• subtract(b: Vec2): Vec2

  Subtracts from each component of the first operand a the corresponding component of the second operand b and places each result into the components of res.

  Parameters

  • b: Vec2

    a Graphene.Vec2

  Returns Vec2

  Since

  1.0

Since 1.0to_float

• to_float(): number[]

  Stores the components of v into an array.

  Returns number[]

  Since

  1.0

Staticalloc

• alloc(): Vec2

  Returns Vec2

StaticSince 1.0one

• one(): Vec2

  Retrieves a constant vector with (1, 1) components.

  Returns Vec2

  Since

  1.0

StaticSince 1.0x_axis

• x_axis(): Vec2

  Retrieves a constant vector with (1, 0) components.

  Returns Vec2

  Since

  1.0

StaticSince 1.0y_axis

• y_axis(): Vec2

  Retrieves a constant vector with (0, 1) components.

  Returns Vec2

  Since

  1.0

StaticSince 1.0zero

• zero(): Vec2

  Retrieves a constant vector with (0, 0) components.

  Returns Vec2

  Since

  1.0