Class (GI Struct)

Graphene-1.0 ▶ Graphene ▶ Vec4

A structure capable of holding a vector with four dimensions: x, y, z, and w.

The contents of the Graphene.Vec4 structure are private and should never be accessed directly.

Index

Constructors

Properties

Constructors

constructor

new Vec4(properties?: Partial<{}>): Vec4
Parameters
- Optionalproperties: Partial<{}>
Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3189

Properties

`Static`$gtype

$gtype: GType<Vec4>

Methods

add

add(b: Vec4): Vec4
Adds each component of the two given vectors.
Parameters
- b: Vec4
  a Graphene.Vec4
Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3232

divide

divide(b: Vec4): Vec4
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: Vec4
  a Graphene.Vec4
Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3239

dot

dot(b: Vec4): number
Computes the dot product of the two given vectors.
Parameters
- b: Vec4
  a Graphene.Vec4
Returns number
the value of the dot product
- Defined in graphene-1.0/graphene-1.0.d.ts:3245

equal

equal(v2: Vec4): boolean
Checks whether the two given Graphene.Vec4 are equal.
Parameters
- v2: Vec4
  a Graphene.Vec4
Returns boolean
true if the two vectors are equal, and false otherwise
- Defined in graphene-1.0/graphene-1.0.d.ts:3251

free

free(): void
Frees the resources allocated by v

Returns void
- Defined in graphene-1.0/graphene-1.0.d.ts:3255

get_w

get_w(): number
Retrieves the value of the fourth component of the given Graphene.Vec4.

Returns number
the value of the fourth component
- Defined in graphene-1.0/graphene-1.0.d.ts:3260

get_x

get_x(): number
Retrieves the value of the first component of the given Graphene.Vec4.

Returns number
the value of the first component
- Defined in graphene-1.0/graphene-1.0.d.ts:3265

get_xy

get_xy(): Vec2
Creates a Graphene.Vec2 that contains the first two components of the given Graphene.Vec4.

Returns Vec2
- Defined in graphene-1.0/graphene-1.0.d.ts:3270

get_xyz

get_xyz(): Vec3
Creates a Graphene.Vec3 that contains the first three components of the given Graphene.Vec4.

Returns Vec3
- Defined in graphene-1.0/graphene-1.0.d.ts:3275

get_y

get_y(): number
Retrieves the value of the second component of the given Graphene.Vec4.

Returns number
the value of the second component
- Defined in graphene-1.0/graphene-1.0.d.ts:3280

get_z

get_z(): number
Retrieves the value of the third component of the given Graphene.Vec4.

Returns number
the value of the third component
- Defined in graphene-1.0/graphene-1.0.d.ts:3285

init

init(x: number, y: number, z: number, w: number): Vec4
Initializes a Graphene.Vec4 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
- w: number
  the W field of the vector
Returns Vec4
a pointer to the initialized vector
- Defined in graphene-1.0/graphene-1.0.d.ts:3296

init_from_float

init_from_float(src: number[]): Vec4
Initializes a Graphene.Vec4 with the values inside the given array.
Parameters
- src: number[]
  an array of four floating point values
Returns Vec4
the initialized vector
- Defined in graphene-1.0/graphene-1.0.d.ts:3302

init_from_vec2

init_from_vec2(src: Vec2, z: number, w: number): Vec4
Initializes a Graphene.Vec4 using the components of a Graphene.Vec2 and the values of z and w.
Parameters
- src: Vec2
  a Graphene.Vec2
- z: number
  the value for the third component of v
- w: number
  the value for the fourth component of v
Returns Vec4
the initialized vector
- Defined in graphene-1.0/graphene-1.0.d.ts:3311

init_from_vec3

init_from_vec3(src: Vec3, w: number): Vec4
Initializes a Graphene.Vec4 using the components of a Graphene.Vec3 and the value of w.
Parameters
- src: Vec3
  a Graphene.Vec3
- w: number
  the value for the fourth component of v
Returns Vec4
the initialized vector
- Defined in graphene-1.0/graphene-1.0.d.ts:3319

init_from_vec4

init_from_vec4(src: Vec4): Vec4
Initializes a Graphene.Vec4 using the components of another Graphene.Vec4.
Parameters
- src: Vec4
  a Graphene.Vec4
Returns Vec4
the initialized vector
- Defined in graphene-1.0/graphene-1.0.d.ts:3326

interpolate

interpolate(v2: Vec4, factor: number): Vec4
Linearly interpolates v1 and v2 using the given factor.
Parameters
- v2: Vec4
  a Graphene.Vec4
- factor: number
  the interpolation factor
Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3332

length

length(): number
Computes the length of the given Graphene.Vec4.

Returns number
the length of the vector
- Defined in graphene-1.0/graphene-1.0.d.ts:3337

max

max(b: Vec4): Vec4
Compares each component of the two given vectors and creates a vector that contains the maximum values.
Parameters
- b: Vec4
  a Graphene.Vec4
Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3343

min

min(b: Vec4): Vec4
Compares each component of the two given vectors and creates a vector that contains the minimum values.
Parameters
- b: Vec4
  a Graphene.Vec4
Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3349

multiply

multiply(b: Vec4): Vec4
Multiplies each component of the two given vectors.
Parameters
- b: Vec4
  a Graphene.Vec4
Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3354

near

near(v2: Vec4, epsilon: number): boolean
Compares the two given Graphene.Vec4 vectors and checks whether their values are within the given epsilon.
Parameters
- v2: Vec4
  a Graphene.Vec4
- epsilon: number
  the threshold between the two vectors
Returns boolean
true if the two vectors are near each other
- Defined in graphene-1.0/graphene-1.0.d.ts:3362

negate

negate(): Vec4
Negates the given Graphene.Vec4.

Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3366

normalize

normalize(): Vec4
Normalizes the given Graphene.Vec4.

Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3370

scale

scale(factor: number): Vec4
Multiplies all components of the given vector with the given scalar factor.
Parameters
- factor: number
  the scalar factor
Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3375

subtract

subtract(b: Vec4): Vec4
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: Vec4
  a Graphene.Vec4
Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3382

to_float

to_float(): number[]
Stores the components of the given Graphene.Vec4 into an array of floating point values.

Returns number[]
- Defined in graphene-1.0/graphene-1.0.d.ts:3387

`Static`alloc

alloc(): Vec4
Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3191

`Static`one

one(): Vec4
Retrieves a pointer to a Graphene.Vec4 with all its components set to 1.

Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3199

`Static`w_axis

w_axis(): Vec4
Retrieves a pointer to a Graphene.Vec4 with its components set to (0, 0, 0, 1).

Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3204

`Static`x_axis

x_axis(): Vec4
Retrieves a pointer to a Graphene.Vec4 with its components set to (1, 0, 0, 0).

Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3209

`Static`y_axis

y_axis(): Vec4
Retrieves a pointer to a Graphene.Vec4 with its components set to (0, 1, 0, 0).

Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3214

`Static`z_axis

z_axis(): Vec4
Retrieves a pointer to a Graphene.Vec4 with its components set to (0, 0, 1, 0).

Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3219

`Static`zero

zero(): Vec4
Retrieves a pointer to a Graphene.Vec4 with all its components set to 0.

Returns Vec4
- Defined in graphene-1.0/graphene-1.0.d.ts:3224