Class Vec3

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

The contents of the #graphene_vec3_t structure are private and should never be accessed directly.

record

Hierarchy

Vec3

Index

Constructors

constructor

Properties

name

Constructors

constructor

new Vec3(): Graphene.Vec3

Returns Graphene.Vec3

Properties

Static name

name: string

Methods

add

add(b: Graphene.Vec3): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:2896
Adds each component of the two given vectors.

Parameters
- b: Graphene.Vec3
  
  a #graphene_vec3_t
Returns Graphene.Vec3

cross

cross(b: Graphene.Vec3): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:2901
Computes the cross product of the two given vectors.

Parameters
- b: Graphene.Vec3
  
  a #graphene_vec3_t
Returns Graphene.Vec3

divide

divide(b: Graphene.Vec3): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:2908
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: Graphene.Vec3
  
  a #graphene_vec3_t
Returns Graphene.Vec3

dot

dot(b: Graphene.Vec3): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:2913
Computes the dot product of the two given vectors.

Parameters
- b: Graphene.Vec3
  
  a #graphene_vec3_t
Returns number

equal

equal(v2: Graphene.Vec3): boolean

- Defined in @types/Gjs/Graphene-1.0.d.ts:2918
Checks whether the two given #graphene_vec3_t are equal.

Parameters
- v2: Graphene.Vec3
  
  a #graphene_vec3_t
Returns boolean

free

free(): void

- Defined in @types/Gjs/Graphene-1.0.d.ts:2922
Frees the resources allocated by v

Returns void

get_x

get_x(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:2926
Retrieves the first component of the given vector v.

Returns number

get_xy

get_xy(): Vec2

- Defined in @types/Gjs/Graphene-1.0.d.ts:2931
Creates a #graphene_vec2_t that contains the first and second components of the given #graphene_vec3_t.

Returns Vec2

get_xy0

get_xy0(): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:2936
Creates a #graphene_vec3_t that contains the first two components of the given #graphene_vec3_t, and the third component set to 0.

Returns Graphene.Vec3

get_xyz0

get_xyz0(): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:2941
Converts a #graphene_vec3_t in a #graphene_vec4_t using 0.0 as the value for the fourth component of the resulting vector.

Returns Vec4

get_xyz1

get_xyz1(): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:2946
Converts a #graphene_vec3_t in a #graphene_vec4_t using 1.0 as the value for the fourth component of the resulting vector.

Returns Vec4

get_xyzw

get_xyzw(w: number): Vec4

- Defined in @types/Gjs/Graphene-1.0.d.ts:2952
Converts a #graphene_vec3_t in a #graphene_vec4_t using w as the value of the fourth component of the resulting vector.

Parameters
- w: number
  
  the value of the W component
Returns Vec4

get_y

get_y(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:2956
Retrieves the second component of the given vector v.

Returns number

get_z

get_z(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:2960
Retrieves the third component of the given vector v.

Returns number

init

init(x: number, y: number, z: number): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:2969
Initializes a #graphene_vec3_t 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 Graphene.Vec3

init_from_float

init_from_float(src: number[]): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:2974
Initializes a #graphene_vec3_t with the values from an array.

Parameters
- src: number[]
  
  an array of 3 floating point values
Returns Graphene.Vec3

init_from_vec3

init_from_vec3(src: Graphene.Vec3): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:2980
Initializes a #graphene_vec3_t with the values of another #graphene_vec3_t.

Parameters
- src: Graphene.Vec3
  
  a #graphene_vec3_t
Returns Graphene.Vec3

interpolate

interpolate(v2: Graphene.Vec3, factor: number): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:2986
Linearly interpolates v1 and v2 using the given factor.

Parameters
- v2: Graphene.Vec3
  
  a #graphene_vec3_t
- factor: number
  
  the interpolation factor
Returns Graphene.Vec3

length

length(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:2990
Retrieves the length of the given vector v.

Returns number

max

max(b: Graphene.Vec3): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:2996
Compares each component of the two given vectors and creates a vector that contains the maximum values.

Parameters
- b: Graphene.Vec3
  
  a #graphene_vec3_t
Returns Graphene.Vec3

min

min(b: Graphene.Vec3): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:3002
Compares each component of the two given vectors and creates a vector that contains the minimum values.

Parameters
- b: Graphene.Vec3
  
  a #graphene_vec3_t
Returns Graphene.Vec3

multiply

multiply(b: Graphene.Vec3): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:3007
Multiplies each component of the two given vectors.

Parameters
- b: Graphene.Vec3
  
  a #graphene_vec3_t
Returns Graphene.Vec3

near

near(v2: Graphene.Vec3, epsilon: number): boolean

- Defined in @types/Gjs/Graphene-1.0.d.ts:3014
Compares the two given #graphene_vec3_t vectors and checks whether their values are within the given epsilon.

Parameters
- v2: Graphene.Vec3
  
  a #graphene_vec3_t
- epsilon: number
  
  the threshold between the two vectors
Returns boolean

negate

negate(): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:3018
Negates the given #graphene_vec3_t.

Returns Graphene.Vec3

normalize

normalize(): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:3022
Normalizes the given #graphene_vec3_t.

Returns Graphene.Vec3

scale

scale(factor: number): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:3027
Multiplies all components of the given vector with the given scalar factor.

Parameters
- factor: number
  
  the scalar factor
Returns Graphene.Vec3

subtract

subtract(b: Graphene.Vec3): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:3034
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: Graphene.Vec3
  
  a #graphene_vec3_t
Returns Graphene.Vec3

to_float

to_float(): number[]

- Defined in @types/Gjs/Graphene-1.0.d.ts:3038
Copies the components of a #graphene_vec3_t into the given array.

Returns number[]

Static alloc

alloc(): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:3064
Allocates a new #graphene_vec3_t structure.

The contents of the returned structure are undefined.

Use graphene_vec3_init() to initialize the vector.

Returns Graphene.Vec3

Static one

one(): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:3069
Provides a constant pointer to a vector with three components, all sets to 1.

Returns Graphene.Vec3

Static x_axis

x_axis(): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:3074
Provides a constant pointer to a vector with three components with values set to (1, 0, 0).

Returns Graphene.Vec3

Static y_axis

y_axis(): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:3079
Provides a constant pointer to a vector with three components with values set to (0, 1, 0).

Returns Graphene.Vec3

Static z_axis

z_axis(): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:3084
Provides a constant pointer to a vector with three components with values set to (0, 0, 1).

Returns Graphene.Vec3

Static zero

zero(): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:3089
Provides a constant pointer to a vector with three components, all sets to 0.

Returns Graphene.Vec3