Skip to content

Commit b56d6fe

Browse files
AlexDenfordSkyboxLabsAlexDenfordSkyboxLabs
authored
Added constants VECTOR3_HALF and VECTOR3_NEGATIVE_ONE (#56)
* Added constants VECTOR3_HALF and VECTOR3_NEGATIVE_ONE * Change files * Revert version bump * Fixes
1 parent e01bb9a commit b56d6fe

File tree

3 files changed

+168
-139
lines changed

3 files changed

+168
-139
lines changed

‎change/@minecraft-math-a0e5e874-12d3-460f-8ff5-0cfcd06a2e9d.json

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"type": "minor",
3+
"comment": "Added constants VECTOR3_HALF and VECTOR3_NEGATIVE_ONE",
4+
"packageName": "@minecraft/math",
5+
"email": "[email protected]",
6+
"dependentChangeType": "patch"
7+
}

‎libraries/math/api-report/math.api.md

+145-139
Original file line numberDiff line numberDiff line change
@@ -1,139 +1,145 @@
1-
## API Report File for "@minecraft/math"
2-
3-
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4-
5-
```ts
6-
7-
import type { Vector2 } from '@minecraft/server';
8-
import type { Vector3 } from '@minecraft/server';
9-
10-
// @public
11-
export function clampNumber(val: number, min: number, max: number): number;
12-
13-
// @public
14-
export class Vector2Builder implements Vector2 {
15-
constructor(vec: Vector2, arg?: never);
16-
constructor(x: number, y: number);
17-
// (undocumented)
18-
toString(options?: {
19-
decimals?: number;
20-
delimiter?: string;
21-
}): string;
22-
// (undocumented)
23-
x: number;
24-
// (undocumented)
25-
y: number;
26-
}
27-
28-
// @public
29-
export class Vector2Utils {
30-
static toString(v: Vector2, options?: {
31-
decimals?: number;
32-
delimiter?: string;
33-
}): string;
34-
}
35-
36-
// @public
37-
export const VECTOR3_BACK: Vector3;
38-
39-
// @public
40-
export const VECTOR3_DOWN: Vector3;
41-
42-
// @public
43-
export const VECTOR3_EAST: Vector3;
44-
45-
// @public
46-
export const VECTOR3_FORWARD: Vector3;
47-
48-
// @public
49-
export const VECTOR3_LEFT: Vector3;
50-
51-
// @public
52-
export const VECTOR3_NORTH: Vector3;
53-
54-
// @public
55-
export const VECTOR3_ONE: Vector3;
56-
57-
// @public
58-
export const VECTOR3_RIGHT: Vector3;
59-
60-
// @public
61-
export const VECTOR3_SOUTH: Vector3;
62-
63-
// @public
64-
export const VECTOR3_UP: Vector3;
65-
66-
// @public
67-
export const VECTOR3_WEST: Vector3;
68-
69-
// @public
70-
export const VECTOR3_ZERO: Vector3;
71-
72-
// @public
73-
export class Vector3Builder implements Vector3 {
74-
constructor(vec: Vector3, arg?: never, arg2?: never);
75-
constructor(x: number, y: number, z: number);
76-
add(v: Vector3): this;
77-
assign(vec: Vector3): this;
78-
clamp(limits: {
79-
min?: Partial<Vector3>;
80-
max?: Partial<Vector3>;
81-
}): this;
82-
cross(vec: Vector3): this;
83-
distance(vec: Vector3): number;
84-
dot(vec: Vector3): number;
85-
equals(v: Vector3): boolean;
86-
floor(): this;
87-
lerp(vec: Vector3, t: number): this;
88-
magnitude(): number;
89-
multiply(vec: Vector3): this;
90-
normalize(): this;
91-
rotateX(a: number): this;
92-
rotateY(a: number): this;
93-
rotateZ(a: number): this;
94-
scale(val: number): this;
95-
slerp(vec: Vector3, t: number): this;
96-
subtract(v: Vector3): this;
97-
toString(options?: {
98-
decimals?: number;
99-
delimiter?: string;
100-
}): string;
101-
// (undocumented)
102-
x: number;
103-
// (undocumented)
104-
y: number;
105-
// (undocumented)
106-
z: number;
107-
}
108-
109-
// @public
110-
export class Vector3Utils {
111-
static add(v1: Vector3, v2: Vector3): Vector3;
112-
static clamp(v: Vector3, limits?: {
113-
min?: Partial<Vector3>;
114-
max?: Partial<Vector3>;
115-
}): Vector3;
116-
static cross(a: Vector3, b: Vector3): Vector3;
117-
static distance(a: Vector3, b: Vector3): number;
118-
static dot(a: Vector3, b: Vector3): number;
119-
static equals(v1: Vector3, v2: Vector3): boolean;
120-
static floor(v: Vector3): Vector3;
121-
static lerp(a: Vector3, b: Vector3, t: number): Vector3;
122-
static magnitude(v: Vector3): number;
123-
static multiply(a: Vector3, b: Vector3): Vector3;
124-
static normalize(v: Vector3): Vector3;
125-
static rotateX(v: Vector3, a: number): Vector3;
126-
static rotateY(v: Vector3, a: number): Vector3;
127-
static rotateZ(v: Vector3, a: number): Vector3;
128-
static scale(v1: Vector3, scale: number): Vector3;
129-
static slerp(a: Vector3, b: Vector3, t: number): Vector3;
130-
static subtract(v1: Vector3, v2: Vector3): Vector3;
131-
static toString(v: Vector3, options?: {
132-
decimals?: number;
133-
delimiter?: string;
134-
}): string;
135-
}
136-
137-
// (No @packageDocumentation comment for this package)
138-
139-
```
1+
## API Report File for "@minecraft/math"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import type { Vector2 } from '@minecraft/server';
8+
import type { Vector3 } from '@minecraft/server';
9+
10+
// @public
11+
export function clampNumber(val: number, min: number, max: number): number;
12+
13+
// @public
14+
export class Vector2Builder implements Vector2 {
15+
constructor(vec: Vector2, arg?: never);
16+
constructor(x: number, y: number);
17+
// (undocumented)
18+
toString(options?: {
19+
decimals?: number;
20+
delimiter?: string;
21+
}): string;
22+
// (undocumented)
23+
x: number;
24+
// (undocumented)
25+
y: number;
26+
}
27+
28+
// @public
29+
export class Vector2Utils {
30+
static toString(v: Vector2, options?: {
31+
decimals?: number;
32+
delimiter?: string;
33+
}): string;
34+
}
35+
36+
// @public
37+
export const VECTOR3_BACK: Vector3;
38+
39+
// @public
40+
export const VECTOR3_DOWN: Vector3;
41+
42+
// @public
43+
export const VECTOR3_EAST: Vector3;
44+
45+
// @public
46+
export const VECTOR3_FORWARD: Vector3;
47+
48+
// @public
49+
export const VECTOR3_HALF: Vector3;
50+
51+
// @public
52+
export const VECTOR3_LEFT: Vector3;
53+
54+
// @public
55+
export const VECTOR3_NEGATIVE_ONE: Vector3;
56+
57+
// @public
58+
export const VECTOR3_NORTH: Vector3;
59+
60+
// @public
61+
export const VECTOR3_ONE: Vector3;
62+
63+
// @public
64+
export const VECTOR3_RIGHT: Vector3;
65+
66+
// @public
67+
export const VECTOR3_SOUTH: Vector3;
68+
69+
// @public
70+
export const VECTOR3_UP: Vector3;
71+
72+
// @public
73+
export const VECTOR3_WEST: Vector3;
74+
75+
// @public
76+
export const VECTOR3_ZERO: Vector3;
77+
78+
// @public
79+
export class Vector3Builder implements Vector3 {
80+
constructor(vec: Vector3, arg?: never, arg2?: never);
81+
constructor(x: number, y: number, z: number);
82+
add(v: Vector3): this;
83+
assign(vec: Vector3): this;
84+
clamp(limits: {
85+
min?: Partial<Vector3>;
86+
max?: Partial<Vector3>;
87+
}): this;
88+
cross(vec: Vector3): this;
89+
distance(vec: Vector3): number;
90+
dot(vec: Vector3): number;
91+
equals(v: Vector3): boolean;
92+
floor(): this;
93+
lerp(vec: Vector3, t: number): this;
94+
magnitude(): number;
95+
multiply(vec: Vector3): this;
96+
normalize(): this;
97+
rotateX(a: number): this;
98+
rotateY(a: number): this;
99+
rotateZ(a: number): this;
100+
scale(val: number): this;
101+
slerp(vec: Vector3, t: number): this;
102+
subtract(v: Vector3): this;
103+
toString(options?: {
104+
decimals?: number;
105+
delimiter?: string;
106+
}): string;
107+
// (undocumented)
108+
x: number;
109+
// (undocumented)
110+
y: number;
111+
// (undocumented)
112+
z: number;
113+
}
114+
115+
// @public
116+
export class Vector3Utils {
117+
static add(v1: Vector3, v2: Vector3): Vector3;
118+
static clamp(v: Vector3, limits?: {
119+
min?: Partial<Vector3>;
120+
max?: Partial<Vector3>;
121+
}): Vector3;
122+
static cross(a: Vector3, b: Vector3): Vector3;
123+
static distance(a: Vector3, b: Vector3): number;
124+
static dot(a: Vector3, b: Vector3): number;
125+
static equals(v1: Vector3, v2: Vector3): boolean;
126+
static floor(v: Vector3): Vector3;
127+
static lerp(a: Vector3, b: Vector3, t: number): Vector3;
128+
static magnitude(v: Vector3): number;
129+
static multiply(a: Vector3, b: Vector3): Vector3;
130+
static normalize(v: Vector3): Vector3;
131+
static rotateX(v: Vector3, a: number): Vector3;
132+
static rotateY(v: Vector3, a: number): Vector3;
133+
static rotateZ(v: Vector3, a: number): Vector3;
134+
static scale(v1: Vector3, scale: number): Vector3;
135+
static slerp(a: Vector3, b: Vector3, t: number): Vector3;
136+
static subtract(v1: Vector3, v2: Vector3): Vector3;
137+
static toString(v: Vector3, options?: {
138+
decimals?: number;
139+
delimiter?: string;
140+
}): string;
141+
}
142+
143+
// (No @packageDocumentation comment for this package)
144+
145+
```

‎libraries/math/src/vector3/coreHelpers.ts

+16
Original file line numberDiff line numberDiff line change
@@ -341,3 +341,19 @@ export const VECTOR3_NORTH: Vector3 = { x: 0, y: 0, z: 1 };
341341
* @public
342342
*/
343343
export const VECTOR3_SOUTH: Vector3 = { x: 0, y: 0, z: -1 };
344+
/**
345+
* half
346+
*
347+
* A unit vector representing the value of 0.5 in all directions (0.5,0.5,0.5)
348+
*
349+
* @public
350+
*/
351+
export const VECTOR3_HALF: Vector3 = { x: 0.5, y: 0.5, z: 0.5 };
352+
/**
353+
* negative
354+
*
355+
* A unit vector representing the value of -1 in all directions (-1,-1,-1)
356+
*
357+
* @public
358+
*/
359+
export const VECTOR3_NEGATIVE_ONE: Vector3 = { x: -1, y: -1, z: -1 };

0 commit comments

Comments
 (0)