Skip to content

Commit d7c373a

Browse files
committed
add accurate property names
1 parent 1ed95d2 commit d7c373a

File tree

1 file changed

+69
-40
lines changed

1 file changed

+69
-40
lines changed

src/index.ts

Lines changed: 69 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,6 @@ export type Value =
8585
| PathValue;
8686

8787
export class Property<T extends Value> {
88-
readonly name: string = "Property Name";
8988
readonly velocity: number | Vector = 0;
9089
readonly speed: number | Vector = 0;
9190
readonly numKeys: number = 0;
@@ -141,7 +140,7 @@ export class Property<T extends Value> {
141140
propertyGroup(countUp: number): PropertyGroup {
142141
return new PropertyGroup("property group from function");
143142
}
144-
constructor(readonly value: T) {}
143+
constructor(readonly value: T, readonly name: string = "Property name") {}
145144
}
146145

147146
export class PathProperty<T> extends Property<T> {
@@ -203,17 +202,20 @@ export class Transform extends PropertyGroup {
203202
constructor() {
204203
super("Transform");
205204
}
206-
readonly anchorPoint: Property<Vector> = new Property([0, 0]);
207-
readonly position: Property<Vector> = new Property([0, 0]);
208-
readonly xPosition: Property<number> = new Property(0);
209-
readonly yPosition: Property<number> = new Property(0);
210-
readonly zPosition: Property<number> = new Property(0);
211-
readonly scale: Property<Vector> = new Property([0, 0]);
212-
readonly rotation: Property<number> = new Property(0);
213-
readonly orientation?: Property<Vector3D> = new Property([0, 0, 0]);
214-
readonly rotationX?: Property<number> = new Property(0);
215-
readonly rotationY?: Property<number> = new Property(0);
216-
readonly rotationZ?: Property<number> = new Property(0);
205+
readonly anchorPoint: Property<Vector> = new Property([0, 0], "Anchor Point");
206+
readonly position: Property<Vector> = new Property([0, 0], "Position");
207+
readonly xPosition: Property<number> = new Property(0, "X Position");
208+
readonly yPosition: Property<number> = new Property(0, "Y Position");
209+
readonly zPosition: Property<number> = new Property(0, "Z Position");
210+
readonly scale: Property<Vector> = new Property([0, 0], "Scale");
211+
readonly rotation: Property<number> = new Property(0, "Rotation");
212+
readonly orientation?: Property<Vector3D> = new Property(
213+
[0, 0, 0],
214+
"Orientation"
215+
);
216+
readonly rotationX?: Property<number> = new Property(0, "X Rotation");
217+
readonly rotationY?: Property<number> = new Property(0, "Y Rotation");
218+
readonly rotationZ?: Property<number> = new Property(0, "Z Rotation");
217219
}
218220

219221
export class TextStyle {
@@ -313,18 +315,27 @@ export class TextPathOptions extends PropertyGroup {
313315
}
314316
readonly path: string | undefined = "Mask 1";
315317
readonly reversePath?: boolean = false;
316-
readonly perpendicularToPath?: Property<boolean> = new Property(false);
317-
readonly forceAlignment?: Property<boolean> = new Property(false);
318-
readonly firstMargin?: Property<number> = new Property(0);
319-
readonly lastMargin?: Property<number> = new Property(0);
318+
readonly perpendicularToPath?: Property<boolean> = new Property(
319+
false,
320+
"Perpendicular To Path"
321+
);
322+
readonly forceAlignment?: Property<boolean> = new Property(
323+
false,
324+
"Force Alignment"
325+
);
326+
readonly firstMargin?: Property<number> = new Property(0, "First Margin");
327+
readonly lastMargin?: Property<number> = new Property(0, "Last Margin");
320328
}
321329

322330
export class TextMoreOptions extends PropertyGroup {
323331
constructor() {
324332
super("More Options");
325333
}
326334
readonly anchorPointGrouping: number = 1;
327-
readonly groupingAlignment: Property<[number, number]> = new Property([0, 0]);
335+
readonly groupingAlignment: Property<[number, number]> = new Property(
336+
[0, 0],
337+
"Grouping Alignment"
338+
);
328339
readonly fillANdStroke: number = 1;
329340
readonly interCharacterBlending: number = 1;
330341
}
@@ -342,15 +353,24 @@ export class MaterialOptions extends PropertyGroup {
342353
constructor() {
343354
super("Material Options");
344355
}
345-
readonly lightTransmission: Property<number> = new Property(0);
346-
readonly castShadows: Property<boolean> = new Property(false);
347-
readonly acceptsShadows: Property<boolean> = new Property(false);
348-
readonly acceptsLights: Property<boolean> = new Property(false);
349-
readonly ambient: Property<number> = new Property(100);
350-
readonly diffuse: Property<number> = new Property(100);
351-
readonly specular: Property<number> = new Property(100);
352-
readonly shininess: Property<number> = new Property(100);
353-
readonly metal: Property<number> = new Property(100);
356+
readonly lightTransmission: Property<number> = new Property(
357+
0,
358+
"Light Transmission"
359+
);
360+
readonly castShadows: Property<boolean> = new Property(false, "Cast Shadows");
361+
readonly acceptsShadows: Property<boolean> = new Property(
362+
false,
363+
"Accept Shadows"
364+
);
365+
readonly acceptsLights: Property<boolean> = new Property(
366+
false,
367+
"Accepts Lights"
368+
);
369+
readonly ambient: Property<number> = new Property(100, "Ambient");
370+
readonly diffuse: Property<number> = new Property(100, "Diffuse");
371+
readonly specular: Property<number> = new Property(100, "Specular");
372+
readonly shininess: Property<number> = new Property(100, "Shininess");
373+
readonly metal: Property<number> = new Property(100, "Metal");
354374
}
355375

356376
export class Effects extends PropertyGroup {}
@@ -372,20 +392,29 @@ export class Effect {
372392
}
373393

374394
export class Mask {
375-
readonly maskOpacity: Property<number> = new Property(100);
376-
readonly maskFeather: Property<number> = new Property(100);
377-
readonly maskExpansion: Property<number> = new Property(0);
378-
readonly invert: Property<boolean> = new Property(false);
395+
readonly maskOpacity: Property<number> = new Property(100, "Mask Opacity");
396+
readonly maskFeather: Property<number> = new Property(100, "Mask Feather");
397+
readonly maskExpansion: Property<number> = new Property(0, "Mask Expansion");
398+
readonly invert: Property<boolean> = new Property(false, "Invert");
379399
}
380400

381401
export class Light {
382-
readonly pointOfInterest: Property<Vector3D> = new Property([0, 0, 0]);
383-
readonly intensity: Property<number> = new Property(100);
384-
readonly color: Property<Color> = new Property([1, 1, 1, 1]);
385-
readonly shadowDarkness: Property<number> = new Property(100);
386-
readonly shadowDiffusion: Property<number> = new Property(0);
387-
readonly coneAngle?: Property<number> = new Property(90);
388-
readonly coneFeather?: Property<number> = new Property(50);
402+
readonly pointOfInterest: Property<Vector3D> = new Property(
403+
[0, 0, 0],
404+
"Point of Interest"
405+
);
406+
readonly intensity: Property<number> = new Property(100, "Intensity");
407+
readonly color: Property<Color> = new Property([1, 1, 1, 1], "Color");
408+
readonly shadowDarkness: Property<number> = new Property(
409+
100,
410+
"Shadow Darkness"
411+
);
412+
readonly shadowDiffusion: Property<number> = new Property(
413+
0,
414+
"Shadow Diffusion"
415+
);
416+
readonly coneAngle?: Property<number> = new Property(90, "Cone Angle");
417+
readonly coneFeather?: Property<number> = new Property(50, "Cone Feather");
389418
}
390419

391420
export class Camera {}
@@ -410,8 +439,8 @@ export class Layer {
410439
readonly active: boolean = true;
411440
readonly enabled: boolean = true;
412441
readonly audioActive?: boolean = true;
413-
readonly audioLevels?: Property<number> = new Property(0);
414-
readonly timeRemap?: Property<number> = new Property(0);
442+
readonly audioLevels?: Property<number> = new Property(0, "Audio Levels");
443+
readonly timeRemap?: Property<number> = new Property(0, "Time Remap");
415444
readonly marker?: MarkerProperty;
416445
readonly transform?: Transform = new Transform();
417446
readonly text?: Text = new Text();

0 commit comments

Comments
 (0)