packages
This commit is contained in:
@@ -0,0 +1,103 @@
|
||||
# @pascal-app/viewer
|
||||
|
||||
3D viewer component for Pascal building editor.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @pascal-app/viewer @pascal-app/core
|
||||
```
|
||||
|
||||
## Peer Dependencies
|
||||
|
||||
```bash
|
||||
npm install react three @react-three/fiber @react-three/drei
|
||||
```
|
||||
|
||||
## What's Included
|
||||
|
||||
- **Viewer Component** - WebGPU-powered 3D viewer with camera controls
|
||||
- **Node Renderers** - React Three Fiber components for all node types
|
||||
- **Post-Processing** - SSGI (ambient occlusion + global illumination), TRAA (anti-aliasing), outline effects
|
||||
- **Level System** - Level visibility and positioning (stacked/exploded/solo modes)
|
||||
- **Wall Cutout System** - Dynamic wall hiding based on camera position
|
||||
- **Asset URL Helpers** - CDN URL resolution for models and textures
|
||||
|
||||
## Usage
|
||||
|
||||
```typescript
|
||||
import { Viewer, useViewer } from '@pascal-app/viewer'
|
||||
import { useScene } from '@pascal-app/core'
|
||||
|
||||
function App() {
|
||||
return (
|
||||
<div style={{ width: '100vw', height: '100vh' }}>
|
||||
<Viewer />
|
||||
</div>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
## Custom Camera Controls
|
||||
|
||||
```typescript
|
||||
import { Viewer } from '@pascal-app/viewer'
|
||||
import { CameraControls } from '@react-three/drei'
|
||||
|
||||
function App() {
|
||||
return (
|
||||
<Viewer selectionManager="custom">
|
||||
<CameraControls />
|
||||
</Viewer>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
## Viewer State
|
||||
|
||||
```typescript
|
||||
import { useViewer } from '@pascal-app/viewer'
|
||||
|
||||
function ViewerControls() {
|
||||
const levelMode = useViewer(s => s.levelMode)
|
||||
const setLevelMode = useViewer(s => s.setLevelMode)
|
||||
const wallMode = useViewer(s => s.wallMode)
|
||||
const setWallMode = useViewer(s => s.setWallMode)
|
||||
|
||||
return (
|
||||
<div>
|
||||
<button onClick={() => setLevelMode('stacked')}>Stacked</button>
|
||||
<button onClick={() => setLevelMode('exploded')}>Exploded</button>
|
||||
<button onClick={() => setWallMode('cutaway')}>Cutaway</button>
|
||||
<button onClick={() => setWallMode('up')}>Full Height</button>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
## Asset CDN Helpers
|
||||
|
||||
```typescript
|
||||
import { resolveCdnUrl, ASSETS_CDN_URL } from '@pascal-app/viewer'
|
||||
|
||||
// Resolves relative paths to CDN URLs
|
||||
const url = resolveCdnUrl('/items/chair/model.glb')
|
||||
// → 'https://pascal-cdn.wawasensei.dev/items/chair/model.glb'
|
||||
|
||||
// Handles external URLs and asset:// protocol
|
||||
const externalUrl = resolveCdnUrl('https://example.com/model.glb')
|
||||
// → 'https://example.com/model.glb' (unchanged)
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- **WebGPU Rendering** - Hardware-accelerated rendering via Three.js WebGPU
|
||||
- **Post-Processing** - SSGI for realistic lighting, outline effects for selection
|
||||
- **Level Modes** - Stacked, exploded, or solo level display
|
||||
- **Wall Cutaway** - Automatic wall hiding for interior views
|
||||
- **Camera Modes** - Perspective and orthographic projection
|
||||
- **Scan/Guide Support** - 3D scans and 2D guide images
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@pascal-app/viewer",
|
||||
"version": "0.1.8",
|
||||
"version": "0.1.9",
|
||||
"description": "3D viewer component for Pascal building editor",
|
||||
"type": "module",
|
||||
"main": "./dist/index.js",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { loadAssetUrl } from '@pascal-app/core'
|
||||
|
||||
export const ASSETS_CDN_URL = 'https://pascal-cdn.wawasensei.dev'
|
||||
export const ASSETS_CDN_URL = 'https://editor.pascal.app'
|
||||
|
||||
/**
|
||||
* Resolves an asset URL to the appropriate format:
|
||||
|
||||
Reference in New Issue
Block a user