arcanumcube 0.1.1 → 0.1.3

package/dist/index.html

@@ -46,9 +46,14 @@
                 const light = new THREE.AmbientLight('#fff', 1.0);
                 scene.add(light);
 
+                // sun light
+                const sunLight = new THREE.DirectionalLight('#fff', 1.0);
+                sunLight.position.set(-16, 80, 48);
+                scene.add(sunLight);
+
                 // spot light
-                const spotLight = new THREE.SpotLight('#fff', 2.0, 20, Math.PI / 4, 0.6, 0.01);
-                spotLight.position.set(4, 8, 4);
+                const spotLight = new THREE.SpotLight('#fff', 4, 64, Math.PI / 6, 0.8, 0.01);
+                spotLight.position.set(12, 12, 6);
                 spotLight.target.position.set(0, 0, 0);
                 scene.add(spotLight);
 
@@ -60,11 +65,6 @@
                 scene.add(arccubeGroup);
 
                 renderer.setAnimationLoop((time) => {
-                    /* rotate cube
-                    arccubeGroup.rotation.x -= 0.005;
-                    arccubeGroup.rotation.y += 0.005;
-                    */
-
                     // animate twisting
                     arccube.updateTweens();
 

package/dist/types/core.d.ts

@@ -64,10 +64,12 @@ export declare const TWIST_RULE: Record<Twist, {
 export declare function getStickerIndex(x: number, y: number, z: number, face: Face): number;
 export declare function getCubeFromStickerIndex(index: number): [x: number, y: number, z: number, face: Face];
 export declare function getRandomTwistList(steps?: number): Twist[];
+export declare function MatchGoalState(state: StickerColor[]): boolean;
 export type Sticker = {
     face: Face;
     color: StickerColor;
 };
+/** One small cube class that makes up the Arcanum Cube */
 export declare class Cube {
     type: string;
     position: {
@@ -102,6 +104,7 @@ export declare class ArcanumCube {
     reset(): void;
     scramble(steps?: number): void;
     undo(steps?: number): void;
+    isSolved(): boolean;
     getHistory(): Twist[];
     getUndoList(steps?: number): Twist[];
     twist(twist: Twist | Twist[], reverse?: boolean): void;

package/dist/types/webgl.d.ts

@@ -3,6 +3,12 @@ import { Cube, ArcanumCube } from './core.js';
 import type { Twist, Sticker } from './core.js';
 import { type Skin } from './skins.js';
 export declare const CUBE_SIDE_LEN = 1.9;
+export type TwistOptions = {
+    onStart?: (self: WebGLArcanumCube) => void;
+    onTwisted?: (self: WebGLArcanumCube, twist: Twist, step: number, total: number) => void;
+    onComplete?: (self: WebGLArcanumCube) => void;
+    onSolved?: (self: WebGLArcanumCube) => void;
+};
 type WebGLSticker = Sticker & {
     mesh?: THREE.Mesh;
 };
@@ -14,6 +20,7 @@ export type WebGLCubeConfig = {
     skin: Skin;
     envMap?: THREE.Texture;
     wireframe: boolean;
+    wireframeColor: THREE.ColorRepresentation;
 };
 declare class WebGLCube extends Cube {
     protected _stickers: WebGLSticker[];
@@ -46,11 +53,15 @@ export type WebGLArcanumCubeConfig = {
     envMap?: THREE.Texture;
     showSelectedCube: boolean;
     showTwistGroup: boolean;
-    enableLight: boolean;
+    enableCoreLight: boolean;
+    coreLightColor: THREE.ColorRepresentation;
+    coreLightIntensity: number;
     wireframe: boolean;
+    wireframeColor: THREE.ColorRepresentation;
+    twistOptions?: TwistOptions;
 };
 /** Arcanum Cube object for WebGL class */
-declare class WebGLArcanumCube extends ArcanumCube {
+export declare class WebGLArcanumCube extends ArcanumCube {
     /** config */
     private _config;
     /** cube objects matrix */
@@ -74,13 +85,17 @@ declare class WebGLArcanumCube extends ArcanumCube {
     /** tween group */
     private _tweens;
     /** light at the center of cube */
-    private _pointLights;
+    private _coreLights;
+    /** status of locking the twist */
+    private _lockTwist;
     constructor(options?: Partial<WebGLArcanumCubeConfig>);
     getGroup(): THREE.Group;
     getCubeObjectList(): THREE.Group[];
     init(): Promise<void>;
     private _init;
     setSkin(skin: Skin): Promise<void>;
+    lockTwist(flag: boolean): void;
+    isTwisting(): boolean;
     reset(duration?: number): void;
     selectedCube(): WebGLCube | undefined;
     selectedSticker(): WebGLSticker | undefined;
@@ -99,10 +114,11 @@ declare class WebGLArcanumCube extends ArcanumCube {
     dragTwistEnd(): void;
     scramble(steps?: number, duration?: number): void;
     undo(steps?: number, duration?: number): void;
-    tweenTwist(twist: Twist | Twist[], reverse?: boolean, duration?: number, cancel?: boolean): void;
+    tweenTwist(twist: Twist | Twist[], reverse?: boolean, duration?: number, cancel?: boolean, options?: TwistOptions): void;
     private _immediatelyTwist;
     private _tweenTwist;
     updateTweens(): void;
+    setCoreLightColor(color: THREE.ColorRepresentation): void;
+    setCoreLightIntensity(intensity: number): void;
 }
-export * from './core.js';
-export { WebGLArcanumCube };
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arcanumcube",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Arcanum Cube",
   "type": "module",
   "license": "MIT",
@@ -14,13 +14,18 @@
     "LICENSE",
     "README.md"
   ],
-  "main": "./dist/cjs/arcanumcube.cjs",
+  "main": "./dist/cjs/arcanumcube.js",
   "module": "./dist/esm/arcanumcube.module.js",
   "exports": {
     ".": {
       "types": "./dist/types/arcanumcube.d.ts",
       "import": "./dist/esm/arcanumcube.module.js",
-      "require": "./dist/cjs/arcanumcube.cjs"
+      "require": "./dist/cjs/arcanumcube.js"
+    },
+    "./core": {
+      "types": "./dist/types/core.d.ts",
+      "import": "./dist/esm/core.module.js",
+      "require": "./dist/cjs/core.js"
     }
   },
   "scripts": {
@@ -54,5 +59,11 @@
     "ts-jest": "^29.2.5",
     "typedoc": "^0.27.6",
     "typescript": "^5.7.3"
-  }
+  },
+  "keywords": [
+    "rubiks-cube",
+    "puzzle",
+    "three",
+    "webgl"
+  ]
 }