arcanumcube 0.1.0 → 0.1.2

package/dist/index.html

@@ -9,8 +9,9 @@
             {
                 "imports": {
                     "arcanumcube": "./esm/arcanumcube.module.min.js",
-                    "three": "https://cdn.jsdelivr.net/npm/three@0.173.0/build/three.module.min.js",
+                    "three": "https://cdn.jsdelivr.net/npm/three@0.173.0/+esm",
                     "three/examples/jsm/": "https://cdn.jsdelivr.net/npm/three@0.173.0/examples/jsm/",
+                    "three/addons/": "https://cdn.jsdelivr.net/npm/three@0.173.0/examples/jsm/",
                     "@tweenjs/tween.js": "https://cdn.jsdelivr.net/npm/@tweenjs/tween.js@25.0.0/+esm"
                 }
             }
@@ -18,6 +19,7 @@
         <script type="module">
             import * as THREE from 'three';
             import * as ARCCUBE from 'arcanumcube';
+            import { OrbitControls } from 'three/addons/controls/OrbitControls.js';
 
             async function onLoad() {
                 const w = viewarea.clientWidth;
@@ -37,14 +39,21 @@
 
                 const camera = new THREE.PerspectiveCamera(45, w / h);
                 camera.position.set(0, 0, 30);
+                const controls = new OrbitControls(camera, viewarea);
+                controls.autoRotate = true;
 
                 // ambient light
                 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);
 
@@ -56,13 +65,12 @@
                 scene.add(arccubeGroup);
 
                 renderer.setAnimationLoop((time) => {
-                    // rotate cube
-                    arccubeGroup.rotation.x -= 0.005;
-                    arccubeGroup.rotation.y += 0.005;
-
                     // animate twisting
                     arccube.updateTweens();
 
+                    // orbit control
+                    controls.update();
+
                     renderer.render(scene, camera);
                 });
 

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/skins.d.ts

@@ -1,5 +1,7 @@
 import * as THREE from 'three';
 import * as ARCCUBE from './core.js';
+export declare function GetSkinByName(name: string): Skin;
+export declare function GetSkinNameList(): string[];
 export type Skin = {
     name: string;
     enableEnvMap: boolean;

package/dist/types/webgl.d.ts

@@ -1,7 +1,13 @@
 import * as THREE from 'three';
 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;
+};
 type WebGLSticker = Sticker & {
     mesh?: THREE.Mesh;
 };
@@ -10,8 +16,10 @@ export type WebGLCubeConfig = {
     stickerScale: number;
     gap: number;
     enableShadow: boolean;
-    skin: string;
+    skin: Skin;
     envMap?: THREE.Texture;
+    wireframe: boolean;
+    wireframeColor: THREE.ColorRepresentation;
 };
 declare class WebGLCube extends Cube {
     protected _stickers: WebGLSticker[];
@@ -40,11 +48,17 @@ export type WebGLArcanumCubeConfig = {
     stickerScale: number;
     gap: number;
     enableShadow: boolean;
-    skin: string;
+    skin: Skin;
     envMap?: THREE.Texture;
     showSelectedCube: boolean;
     showTwistGroup: boolean;
-    enableLight: boolean;
+    autoReset: 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 {
@@ -71,14 +85,13 @@ declare class WebGLArcanumCube extends ArcanumCube {
     /** tween group */
     private _tweens;
     /** light at the center of cube */
-    private _pointLights;
+    private _coreLights;
     constructor(options?: Partial<WebGLArcanumCubeConfig>);
     getGroup(): THREE.Group;
     getCubeObjectList(): THREE.Group[];
-    static getSkinNameList(): string[];
     init(): Promise<void>;
     private _init;
-    setSkin(name: string): Promise<void>;
+    setSkin(skin: Skin): Promise<void>;
     reset(duration?: number): void;
     selectedCube(): WebGLCube | undefined;
     selectedSticker(): WebGLSticker | undefined;
@@ -97,10 +110,12 @@ 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 };

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "arcanumcube",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Arcanum Cube",
   "type": "module",
   "license": "MIT",
   "author": "mawxiwtz",
   "repository": {
     "type": "git",
-    "url": "https://github.com/mawxiwtz/arcanumcube"
+    "url": "git+https://github.com/mawxiwtz/arcanumcube.git"
   },
   "files": [
     "dist",