threedviewer 0.0.0 → 0.2.0

package/README.md

@@ -57,6 +57,92 @@ The main component for displaying 3D objects.
 
 Props:
 - `object` (required): A Three.js Object3D to be displayed in the viewer.
+- `options` (optional): An object containing viewer options (see below).
+
+## Configuration Options
+
+SimpleViewer accepts an `options` prop for customization. Here's an overview of available options:
+
+```javascript
+const defaultOptions = {
+  backgroundColor: '#f0f0f7',
+  camera: {
+    position: [6, 2, 1.2],
+    target: [0, 0, 0],
+    fov: 75,
+    near: 0.1,
+    far: 100000
+  },
+  lights: {
+    ambient: { color: '#404040', intensity: 1 },
+    hemisphere: { 
+      skyColor: '#ffffbb', 
+      groundColor: '#080820', 
+      intensity: 1 
+    },
+    directional: {
+      color: '#ffffff',
+      intensity: 1,
+      position: [6, 6, 6],
+      castShadow: true
+    }
+  },
+  controls: {
+    enableDamping: true,
+    dampingFactor: 0.25,
+    enableZoom: true,
+    enableRotate: true,
+    enablePan: true
+  },
+  helpers: {
+    grid: true,
+    axes: false,
+    boundingBox: true
+  }
+}
+```
+
+To use custom options:
+
+```jsx
+import React from 'react';
+import { SimpleViewer, defaultOptions } from 'threedviewer';
+import * as THREE from 'three';
+
+function App() {
+  const geometry = new THREE.BoxGeometry(1, 1, 1);
+  const material = new THREE.MeshStandardMaterial({ color: 0x00ff00 });
+  const cube = new THREE.Mesh(geometry, material);
+
+  const customOptions = {
+      ...defaultOptions,
+      backgroundColor: '#000000',
+      camera: {
+        ...defaultOptions.camera,
+        cameraPosition: [12 * 6, 12 * 6, 12 * 6],
+        cameraTarget: [0, 0, 0],
+        fov: 60,
+        autoFitToObject: false,
+      },
+      lights: {
+        ambient: { intensity: 0.5 },
+        directional: { position: [10, 10, 5] }
+      },
+  };
+
+  return (
+    <div style={{ width: '100%', height: '400px' }}>
+      <SimpleViewer object={cube} options={customOptions} />
+    </div>
+  );
+}
+
+export default App;
+```
+
+This example demonstrates how to override specific options while leaving others at their default values. You only need to specify the options you want to change.
+
+For detailed explanations of each option, please refer to our [API documentation](link-to-api-docs).
 
 ## Development
 

package/dist/FloorAligner.d.ts

@@ -0,0 +1,10 @@
+import * as THREE from 'three';
+declare class FloorAligner {
+    private object;
+    private boundingBox;
+    constructor(object: THREE.Object3D);
+    alignToFloor(): void;
+    private calculateFloorOffset;
+    private applyOffset;
+}
+export default FloorAligner;

package/dist/Resizer.d.ts

@@ -0,0 +1,5 @@
+import * as THREE from 'three';
+declare class Resizer {
+    resize(object: THREE.Object3D, targetSize: THREE.Vector3): void;
+}
+export default Resizer;

package/dist/SimpleViewer.d.ts

@@ -1,7 +1,4 @@
 import { default as React } from 'react';
-import * as THREE from 'three';
-interface SimpleViewerProps {
-    object: THREE.Object3D | null;
-}
+import { SimpleViewerProps } from './types';
 declare const SimpleViewer: React.FC<SimpleViewerProps>;
 export default SimpleViewer;

package/dist/ThreeSceneSetup/HexGrid/HexGrid.d.ts

@@ -0,0 +1,10 @@
+import { default as HexTile } from './HexTile';
+import * as THREE from 'three';
+declare class HexGrid {
+    radius: number;
+    tileSize: number;
+    constructor(radius: number, tileSize: number);
+    generateGrid(): HexTile[];
+    addToScene(scene: THREE.Scene): void;
+}
+export default HexGrid;

package/dist/ThreeSceneSetup/HexGrid/HexTile.d.ts

@@ -0,0 +1,8 @@
+import * as THREE from 'three';
+declare class HexTile {
+    position: THREE.Vector3;
+    size: number;
+    constructor(position: THREE.Vector3, size: number);
+    createMesh(): THREE.LineSegments;
+}
+export default HexTile;

package/dist/ThreeSceneSetup/addHelpers.d.ts

@@ -0,0 +1,3 @@
+import { HelperOptions } from '../types';
+import * as THREE from 'three';
+export declare const addHelpers: (scene: THREE.Scene, object: THREE.Object3D | null, options: HelperOptions) => void;

package/dist/ThreeSceneSetup/addLighting.d.ts

@@ -0,0 +1,3 @@
+import { LightningOptions } from '../types';
+import * as THREE from 'three';
+export declare const addLighting: (scene: THREE.Scene, options: LightningOptions) => void;

package/dist/ThreeSceneSetup/cleanupScene.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+import * as THREE from 'three';
+export declare const cleanupScene: (mountRef: React.RefObject<HTMLDivElement>, renderer: THREE.WebGLRenderer, resizeHandler: () => void) => void;

package/dist/ThreeSceneSetup/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const BACKGROUND_COLOR = 15790327;
+export declare const UNITS_PER_INCH = 1;
+export declare const UNITS_PER_FOOT: number;

package/dist/ThreeSceneSetup/fitCameraToObject.d.ts

@@ -0,0 +1,2 @@
+import * as THREE from 'three';
+export declare const fitCameraToObject: (scene: THREE.Scene, camera: THREE.PerspectiveCamera) => void;

package/dist/ThreeSceneSetup/initializeCamera.d.ts

@@ -0,0 +1,3 @@
+import { CameraOptions } from '../types';
+import * as THREE from 'three';
+export declare const initializeCamera: (aspectRatio: number, cameraOptions: CameraOptions) => THREE.PerspectiveCamera;

package/dist/ThreeSceneSetup/initializeRenderer.d.ts

@@ -0,0 +1,3 @@
+import { RendererOptions } from '../types';
+import * as THREE from 'three';
+export declare const initializeRenderer: (rendererOptions: RendererOptions) => THREE.WebGLRenderer;

package/dist/ThreeSceneSetup/initializeScene.d.ts

@@ -0,0 +1,3 @@
+import { SimpleViewerOptions } from '../types';
+import * as THREE from 'three';
+export declare const initializeScene: (options: SimpleViewerOptions) => THREE.Scene;

package/dist/ThreeSceneSetup/setupScene.d.ts

@@ -0,0 +1,10 @@
+import { OrbitControls } from 'three/examples/jsm/controls/OrbitControls';
+import { THREEBase } from './types';
+import { SimpleViewerOptions } from '../types';
+import * as THREE from 'three';
+export declare const setupScene: (threeBase: THREEBase, object: THREE.Object3D | null, options: SimpleViewerOptions) => {
+    scene: THREE.Scene;
+    camera: THREE.PerspectiveCamera;
+    renderer: THREE.WebGLRenderer;
+    controls: OrbitControls;
+};

package/dist/ThreeSceneSetup/types.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+import * as THREE from 'three';
+export type THREEBase = {
+    mountRef: React.RefObject<HTMLDivElement>;
+    rendererRef: React.MutableRefObject<THREE.WebGLRenderer | null>;
+    cameraRef: React.MutableRefObject<THREE.PerspectiveCamera | null>;
+    sceneRef: React.MutableRefObject<THREE.Scene | null>;
+};

package/dist/ThreeSceneSetup/updateSize.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+import * as THREE from 'three';
+export declare const updateSize: (renderer: THREE.WebGLRenderer, camera: THREE.PerspectiveCamera, mountRef: React.RefObject<HTMLDivElement>, scene: THREE.Scene) => void;

package/dist/defaultOptions.d.ts

@@ -0,0 +1,3 @@
+import { SimpleViewerOptions } from './types';
+declare const defaultOptions: SimpleViewerOptions;
+export default defaultOptions;

package/dist/index.d.ts

@@ -1,2 +1,4 @@
 export { default as SimpleViewer } from './SimpleViewer';
-export * from './simpleViewerUtils';
+export { type SimpleViewerProps } from './types';
+export { type SimpleViewerOptions } from './types';
+export { default as defaultOptions } from './defaultOptions';

package/dist/loadModel.d.ts

@@ -0,0 +1,3 @@
+import { LoaderGLB } from './types';
+import * as THREE from 'three';
+export declare const loadModel: (url: string, loader: LoaderGLB, targetSize?: THREE.Vector3) => Promise<THREE.Object3D>;