Graphene-1.0 ▶ Graphene ▶ Vec3

constructor

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

  Parameters

  • Optionalproperties: Partial<{}>

  Returns Vec3

Static$gtype

Since 1.0add

• add(b: Vec3): Vec3

  Adds each component of the two given vectors.

  Parameters

  • b: Vec3

    a Graphene.Vec3

  Returns Vec3

  Since

  1.0

Since 1.0cross

• cross(b: Vec3): Vec3

  Computes the cross product of the two given vectors.

  Parameters

  • b: Vec3

    a Graphene.Vec3

  Returns Vec3

  Since

  1.0

Since 1.0divide

• divide(b: Vec3): Vec3

  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: Vec3

    a Graphene.Vec3

  Returns Vec3

  Since

  1.0

Since 1.0dot

• dot(b: Vec3): number

  Computes the dot product of the two given vectors.

  Parameters

  • b: Vec3

    a Graphene.Vec3

  Returns number

  the value of the dot product

  Since

  1.0

Since 1.2equal

• equal(v2: Vec3): boolean

  Checks whether the two given Graphene.Vec3 are equal.

  Parameters

  • v2: Vec3

    a Graphene.Vec3

  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 first component of the given vector v.

  Returns number

  the value of the first component of the vector

  Since

  1.0

Since 1.0get_xy

• get_xy(): Vec2

  Creates a Graphene.Vec2 that contains the first and second components of the given Graphene.Vec3.

  Returns Vec2

  Since

  1.0

Since 1.0get_xy0

• get_xy0(): Vec3

  Creates a Graphene.Vec3 that contains the first two components of the given Graphene.Vec3, and the third component set to 0.

  Returns Vec3

  Since

  1.0

Since 1.0get_xyz0

• get_xyz0(): Vec4

  Converts a Graphene.Vec3 in a Graphene.Vec4 using 0.0 as the value for the fourth component of the resulting vector.

  Returns Vec4

  Since

  1.0

Since 1.0get_xyz1

• get_xyz1(): Vec4

  Converts a Graphene.Vec3 in a Graphene.Vec4 using 1.0 as the value for the fourth component of the resulting vector.

  Returns Vec4

  Since

  1.0

Since 1.0get_xyzw

• get_xyzw(w: number): Vec4

  Converts a Graphene.Vec3 in a Graphene.Vec4 using w as the value of the fourth component of the resulting vector.

  Parameters

  • w: number

    the value of the W component

  Returns Vec4

  Since

  1.0

Since 1.0get_y

• get_y(): number

  Retrieves the second component of the given vector v.

  Returns number

  the value of the second component of the vector

  Since

  1.0

Since 1.0get_z

• get_z(): number

  Retrieves the third component of the given vector v.

  Returns number

  the value of the third component of the vector

  Since

  1.0

Since 1.0init

• init(x: number, y: number, z: number): Vec3

  Initializes a Graphene.Vec3 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

  • z: number

    the Z field of the vector

  Returns Vec3

  a pointer to the initialized vector

  Since

  1.0

Since 1.0init_from_float

• init_from_float(src: number[]): Vec3

  Initializes a Graphene.Vec3 with the values from an array.

  Parameters

  • src: number[]

    an array of 3 floating point values

  Returns Vec3

  the initialized vector

  Since

  1.0

Since 1.0init_from_vec3

• init_from_vec3(src: Vec3): Vec3

  Initializes a Graphene.Vec3 with the values of another Graphene.Vec3.

  Parameters

  • src: Vec3

    a Graphene.Vec3

  Returns Vec3

  the initialized vector

  Since

  1.0

Since 1.10interpolate

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

  Linearly interpolates v1 and v2 using the given factor.

  Parameters

  • v2: Vec3

    a Graphene.Vec3

  • factor: number

    the interpolation factor

  Returns Vec3

  Since

  1.10

Since 1.0length

• length(): number

  Retrieves the length of the given vector v.

  Returns number

  the value of the length of the vector

  Since

  1.0

Since 1.0max

• max(b: Vec3): Vec3

  Compares each component of the two given vectors and creates a vector that contains the maximum values.

  Parameters

  • b: Vec3

    a Graphene.Vec3

  Returns Vec3

  Since

  1.0

Since 1.0min

• min(b: Vec3): Vec3

  Compares each component of the two given vectors and creates a vector that contains the minimum values.

  Parameters

  • b: Vec3

    a Graphene.Vec3

  Returns Vec3

  Since

  1.0

Since 1.0multiply

• multiply(b: Vec3): Vec3

  Multiplies each component of the two given vectors.

  Parameters

  • b: Vec3

    a Graphene.Vec3

  Returns Vec3

  Since

  1.0

Since 1.2near

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

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

  Parameters

  • v2: Vec3

    a Graphene.Vec3

  • 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(): Vec3

  Negates the given Graphene.Vec3.

  Returns Vec3

  Since

  1.2

Since 1.0normalize

• normalize(): Vec3

  Normalizes the given Graphene.Vec3.

  Returns Vec3

  Since

  1.0

Since 1.2scale

• scale(factor: number): Vec3

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

  Parameters

  • factor: number

    the scalar factor

  Returns Vec3

  Since

  1.2

Since 1.0subtract

• subtract(b: Vec3): Vec3

  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: Vec3

    a Graphene.Vec3

  Returns Vec3

  Since

  1.0

Since 1.0to_float

• to_float(): number[]

  Copies the components of a Graphene.Vec3 into the given array.

  Returns number[]

  Since

  1.0

Staticalloc

• alloc(): Vec3

  Returns Vec3

StaticSince 1.0one

• one(): Vec3

  Provides a constant pointer to a vector with three components, all sets to 1.

  Returns Vec3

  Since

  1.0

StaticSince 1.0x_axis

• x_axis(): Vec3

  Provides a constant pointer to a vector with three components with values set to (1, 0, 0).

  Returns Vec3

  Since

  1.0

StaticSince 1.0y_axis

• y_axis(): Vec3

  Provides a constant pointer to a vector with three components with values set to (0, 1, 0).

  Returns Vec3

  Since

  1.0

StaticSince 1.0z_axis

• z_axis(): Vec3

  Provides a constant pointer to a vector with three components with values set to (0, 0, 1).

  Returns Vec3

  Since

  1.0

StaticSince 1.0zero

• zero(): Vec3

  Provides a constant pointer to a vector with three components, all sets to 0.

  Returns Vec3

  Since

  1.0