Class Vec4

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

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

record

Hierarchy

Vec4

Index

Constructors

constructor

Properties

name

Constructors

constructor

new Vec4(): Vec4

Returns Vec4

Properties

Static name

name: string

Methods

add

add(b: Vec4): Vec4

- Defined in Graphene-1.0.d.ts:3099
Adds each component of the two given vectors.

Parameters
- b: Vec4
  
  a #graphene_vec4_t
Returns Vec4

divide

divide(b: Vec4): Vec4

- Defined in Graphene-1.0.d.ts:3106
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_t
Returns Vec4

dot

dot(b: Vec4): number

- Defined in Graphene-1.0.d.ts:3111
Computes the dot product of the two given vectors.

Parameters
- b: Vec4
  
  a #graphene_vec4_t
Returns number

equal

equal(v2: Vec4): boolean

- Defined in Graphene-1.0.d.ts:3116
Checks whether the two given #graphene_vec4_t are equal.

Parameters
- v2: Vec4
  
  a #graphene_vec4_t
Returns boolean

free

free(): void

- Defined in Graphene-1.0.d.ts:3120
Frees the resources allocated by v

Returns void

getW

getW(): number

- Defined in Graphene-1.0.d.ts:3124
Retrieves the value of the fourth component of the given #graphene_vec4_t.

Returns number

getX

getX(): number

- Defined in Graphene-1.0.d.ts:3128
Retrieves the value of the first component of the given #graphene_vec4_t.

Returns number

getXy

getXy(): Vec2

- Defined in Graphene-1.0.d.ts:3133
Creates a #graphene_vec2_t that contains the first two components of the given #graphene_vec4_t.

Returns Vec2

getXyz

getXyz(): Graphene.Vec3

- Defined in Graphene-1.0.d.ts:3138
Creates a #graphene_vec3_t that contains the first three components of the given #graphene_vec4_t.

Returns Graphene.Vec3

getY

getY(): number

- Defined in Graphene-1.0.d.ts:3142
Retrieves the value of the second component of the given #graphene_vec4_t.

Returns number

getZ

getZ(): number

- Defined in Graphene-1.0.d.ts:3146
Retrieves the value of the third component of the given #graphene_vec4_t.

Returns number

init

init(x: number, y: number, z: number, w: number): Vec4

- Defined in Graphene-1.0.d.ts:3156
Initializes a #graphene_vec4_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
- w: number
  
  the W field of the vector
Returns Vec4

initFromFloat

initFromFloat(src: number[]): Vec4

- Defined in Graphene-1.0.d.ts:3161
Initializes a #graphene_vec4_t with the values inside the given array.

Parameters
- src: number[]
  
  an array of four floating point values
Returns Vec4

initFromVec2

initFromVec2(src: Vec2, z: number, w: number): Vec4

- Defined in Graphene-1.0.d.ts:3169
Initializes a #graphene_vec4_t using the components of a #graphene_vec2_t and the values of z and w.

Parameters
- src: Vec2
  
  a #graphene_vec2_t
- z: number
  
  the value for the third component of v
- w: number
  
  the value for the fourth component of v
Returns Vec4

initFromVec3

initFromVec3(src: Graphene.Vec3, w: number): Vec4

- Defined in Graphene-1.0.d.ts:3176
Initializes a #graphene_vec4_t using the components of a #graphene_vec3_t and the value of w.

Parameters
- src: Graphene.Vec3
  
  a #graphene_vec3_t
- w: number
  
  the value for the fourth component of v
Returns Vec4

initFromVec4

initFromVec4(src: Vec4): Vec4

- Defined in Graphene-1.0.d.ts:3182
Initializes a #graphene_vec4_t using the components of another #graphene_vec4_t.

Parameters
- src: Vec4
  
  a #graphene_vec4_t
Returns Vec4

interpolate

interpolate(v2: Vec4, factor: number): Vec4

- Defined in Graphene-1.0.d.ts:3188
Linearly interpolates v1 and v2 using the given factor.

Parameters
- v2: Vec4
  
  a #graphene_vec4_t
- factor: number
  
  the interpolation factor
Returns Vec4

length

length(): number

- Defined in Graphene-1.0.d.ts:3192
Computes the length of the given #graphene_vec4_t.

Returns number

max

max(b: Vec4): Vec4

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

Parameters
- b: Vec4
  
  a #graphene_vec4_t
Returns Vec4

min

min(b: Vec4): Vec4

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

Parameters
- b: Vec4
  
  a #graphene_vec4_t
Returns Vec4

multiply

multiply(b: Vec4): Vec4

- Defined in Graphene-1.0.d.ts:3209
Multiplies each component of the two given vectors.

Parameters
- b: Vec4
  
  a #graphene_vec4_t
Returns Vec4

near

near(v2: Vec4, epsilon: number): boolean

- Defined in Graphene-1.0.d.ts:3216
Compares the two given #graphene_vec4_t vectors and checks whether their values are within the given epsilon.

Parameters
- v2: Vec4
  
  a #graphene_vec4_t
- epsilon: number
  
  the threshold between the two vectors
Returns boolean

negate

negate(): Vec4

- Defined in Graphene-1.0.d.ts:3220
Negates the given #graphene_vec4_t.

Returns Vec4

normalize

normalize(): Vec4

- Defined in Graphene-1.0.d.ts:3224
Normalizes the given #graphene_vec4_t.

Returns Vec4

scale

scale(factor: number): Vec4

- Defined in Graphene-1.0.d.ts:3229
Multiplies all components of the given vector with the given scalar factor.

Parameters
- factor: number
  
  the scalar factor
Returns Vec4

subtract

subtract(b: Vec4): Vec4

- Defined in Graphene-1.0.d.ts:3236
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_t
Returns Vec4

toFloat

toFloat(): number[]

- Defined in Graphene-1.0.d.ts:3241
Stores the components of the given #graphene_vec4_t into an array of floating point values.

Returns number[]

Static alloc

alloc(): Vec4

- Defined in Graphene-1.0.d.ts:3267
Allocates a new #graphene_vec4_t structure.

The contents of the returned structure are undefined.

Use graphene_vec4_init() to initialize the vector.

Returns Vec4

Static one

one(): Vec4

- Defined in Graphene-1.0.d.ts:3272
Retrieves a pointer to a #graphene_vec4_t with all its components set to 1.

Returns Vec4

Static wAxis

wAxis(): Vec4

- Defined in Graphene-1.0.d.ts:3277
Retrieves a pointer to a #graphene_vec4_t with its components set to (0, 0, 0, 1).

Returns Vec4

Static xAxis

xAxis(): Vec4

- Defined in Graphene-1.0.d.ts:3282
Retrieves a pointer to a #graphene_vec4_t with its components set to (1, 0, 0, 0).

Returns Vec4

Static yAxis

yAxis(): Vec4

- Defined in Graphene-1.0.d.ts:3287
Retrieves a pointer to a #graphene_vec4_t with its components set to (0, 1, 0, 0).

Returns Vec4

Static zAxis

zAxis(): Vec4

- Defined in Graphene-1.0.d.ts:3292
Retrieves a pointer to a #graphene_vec4_t with its components set to (0, 0, 1, 0).

Returns Vec4

Static zero

zero(): Vec4

- Defined in Graphene-1.0.d.ts:3297
Retrieves a pointer to a #graphene_vec4_t with all its components set to 0.

Returns Vec4