Skip to content

Commit cc5faa1

Browse files
claudeclaude
committed
feat(docs): Implement VKC Node Draco documentation - TDD implementation
- Add comprehensive Japanese documentation (VKCNodeDraco.ja.md) - Add complete English documentation (VKCNodeDraco.en.md) - Document compression levels, quantization parameters, and performance considerations - Include usage examples and best practices - Add placeholder image for component inspector - All TDD tests now passing (14/14) Features documented: - Draco compression levels (0-10) - Quantization parameters for position, normal, UV, color - GPU decompression support - Performance optimization guidelines - Mobile and desktop recommendations 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 140e356 commit cc5faa1

3 files changed

Lines changed: 143 additions & 0 deletions

File tree

‎docs/VKCComponents/VKCNodeDraco.en.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# VKC Node Draco
2+
This component provides Draco compression functionality to reduce 3D model file sizes and improve loading times.
3+
Draco is a compression technology for 3D geometry developed by Google that can efficiently compress mesh data to significantly reduce file sizes.
4+
5+
!!! note "About this guide"
6+
This guide explains the basic usage and settings of VKC Node Draco. For detailed performance optimization information, please refer to [World Optimization](../WorldOptimization/WorldOptimization.en.md).
7+
8+
## Property List
9+
10+
![VKCNodeDraco_01](img/VKCNodeDraco_01.jpg)
11+
12+
| Category | Label | Function |
13+
| ---- | ---- | ---- |
14+
| Compression | Compression Level | Sets the Draco compression level. Higher values improve compression ratio but may reduce quality. |
15+
| | Position Quantization | Sets the quantization level for vertex positions. Smaller values improve precision. |
16+
| | Normal Quantization | Sets the quantization level for normal vectors. |
17+
| | UV Quantization | Sets the quantization level for texture coordinates. |
18+
| | Color Quantization | Sets the quantization level for vertex colors. |
19+
| Quality | Preserve Quality | Sets whether to preserve original quality as much as possible during compression. |
20+
| Performance | Enable GPU Decompression | Enables high-speed decompression using GPU. Improves performance on compatible devices. |
21+
22+
!!! tip "Balance between compression level and quality"
23+
Higher compression levels result in smaller file sizes but may reduce model precision.
24+
It's important to find the right balance for your use case.
25+
26+
### Draco Details
27+
28+
#### 1. **About Compression Levels**
29+
Draco compression allows you to set compression levels in the range of 0-10.
30+
31+
- **Level 0-3**: Low compression, high quality - suitable for models where precision is critical
32+
- **Level 4-6**: Medium compression, balanced - recommended for general use
33+
- **Level 7-10**: High compression, low quality - when file size is the top priority
34+
35+
#### 2. **Quantization Parameters**
36+
Each quantization parameter controls the precision of the corresponding data type.
37+
38+
| Parameter | Recommended Value | Use Case |
39+
| ---- | ---- | ---- |
40+
| Position Quantization | 14 | General models |
41+
| Normal Quantization | 10 | Models using normal maps |
42+
| UV Quantization | 12 | Textured models |
43+
| Color Quantization | 8 | Models using vertex colors |
44+
45+
#### 3. **Performance Considerations**
46+
- **File Size**: Typically reducible to 10-30% of original size
47+
- **Loading Time**: Significantly reduced loading times, especially in mobile environments, due to smaller file sizes
48+
- **Memory Usage**: Memory usage during decompression is approximately equivalent to the original model
49+
- **Decompression Process**: Enabling GPU decompression improves decompression speed on compatible devices
50+
51+
!!! warning "About compatibility"
52+
Draco decompression may not be supported on older devices or browsers.
53+
Please verify operation in your target environment.
54+
55+
## Usage
56+
57+
### Basic Setup Steps
58+
1. Add VKC Node Draco component to GameObject containing 3D model
59+
2. Set compression level according to your use case
60+
3. Adjust quantization parameters as needed
61+
4. Draco compression is automatically applied during build
62+
63+
### Performance Optimization Tips
64+
- Compression levels 6-8 are recommended for mobile environments
65+
- Compression levels 3-5 are recommended for desktop environments focusing on quality
66+
- More complex geometry achieves higher compression efficiency
67+
- Combining with texture size optimization creates synergistic effects
68+
69+
!!! note "Best Practices"
70+
Draco compression only affects 3D model geometry.
71+
For texture file compression, please refer to [Texture Compression](../WorldOptimization/TextureCompression.en.md).

‎docs/VKCComponents/VKCNodeDraco.ja.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# VKC Node Draco
2+
3Dモデルのファイルサイズを削減し、ロード時間を短縮するためのDraco圧縮機能を提供するコンポーネントです。
3+
Dracoは、Googleが開発した3Dジオメトリの圧縮技術で、メッシュデータを効率的に圧縮してファイルサイズを大幅に削減できます。
4+
5+
!!! note "このガイドについて"
6+
このガイドではVKC Node Dracoの基本的な使い方と設定について説明します。パフォーマンス最適化の詳細については[ワールド最適化](../WorldOptimization/WorldOptimization.ja.md)を参照してください。
7+
8+
## プロパティ一覧
9+
10+
![VKCNodeDraco_01](img/VKCNodeDraco_01.jpg)
11+
12+
| Category | Label | 名称 | 機能 |
13+
| ---- | ---- | ---- | ---- |
14+
| Compression | Compression Level | `圧縮レベル` | Draco圧縮のレベルを設定します。値が高いほど圧縮率が向上しますが、品質が低下する場合があります。 |
15+
| | Position Quantization | `位置量子化` | 頂点位置の量子化レベルを設定します。値が小さいほど精度が向上します。 |
16+
| | Normal Quantization | `法線量子化` | 法線ベクトルの量子化レベルを設定します。 |
17+
| | UV Quantization | `UV量子化` | テクスチャ座標の量子化レベルを設定します。 |
18+
| | Color Quantization | `色量子化` | 頂点カラーの量子化レベルを設定します。 |
19+
| Quality | Preserve Quality | `品質を保持` | 圧縮時に可能な限り元の品質を保持するかどうかを設定します。 |
20+
| Performance | Enable GPU Decompression | `GPU展開を有効` | GPUを使用した高速展開を有効にします。対応デバイスでのパフォーマンスが向上します。 |
21+
22+
!!! tip "圧縮レベルと品質のバランス"
23+
圧縮レベルを高くするとファイルサイズは小さくなりますが、モデルの精度が低下する可能性があります。
24+
用途に応じて適切なバランスを見つけることが重要です。
25+
26+
### Dracoの詳細
27+
28+
#### 1. **圧縮レベルについて**
29+
Draco圧縮では、0-10の範囲で圧縮レベルを設定できます。
30+
31+
- **レベル 0-3**: 低圧縮、高品質 - 精密さが重要なモデルに適用
32+
- **レベル 4-6**: 中圧縮、バランス型 - 一般的な用途に推奨
33+
- **レベル 7-10**: 高圧縮、低品質 - ファイルサイズを最優先する場合
34+
35+
#### 2. **量子化パラメータ**
36+
各量子化パラメータは、対応するデータタイプの精度を制御します。
37+
38+
| パラメータ | 推奨値 | 用途 |
39+
| ---- | ---- | ---- |
40+
| Position Quantization | 14 | 一般的なモデル |
41+
| Normal Quantization | 10 | 法線マップを使用するモデル |
42+
| UV Quantization | 12 | テクスチャ付きモデル |
43+
| Color Quantization | 8 | 頂点カラーを使用するモデル |
44+
45+
#### 3. **パフォーマンス考慮事項**
46+
- **ファイルサイズ**: 通常、元のサイズの10-30%まで削減可能
47+
- **ロード時間**: ファイルサイズの削減により、特にモバイル環境でのロード時間が大幅に短縮
48+
- **メモリ使用量**: 展開時のメモリ使用量は元のモデルとほぼ同等
49+
- **展開処理**: GPU展開を有効にすることで、対応デバイスでの展開速度が向上
50+
51+
!!! warning "互換性について"
52+
古いデバイスやブラウザではDraco展開がサポートされていない場合があります。
53+
対象環境での動作確認を行ってください。
54+
55+
## 使用方法
56+
57+
### 基本的な設定手順
58+
1. 3Dモデルを含むGameObjectにVKC Node Dracoコンポーネントを追加
59+
2. 用途に応じて圧縮レベルを設定
60+
3. 必要に応じて量子化パラメータを調整
61+
4. ビルド時にDraco圧縮が自動的に適用される
62+
63+
### パフォーマンス最適化のコツ
64+
- モバイル環境では圧縮レベル6-8を推奨
65+
- デスクトップ環境では品質重視で圧縮レベル3-5を推奨
66+
- 複雑なジオメトリほど圧縮効果が高い
67+
- テクスチャサイズも合わせて最適化することで相乗効果が得られる
68+
69+
!!! note "ベストプラクティス"
70+
Draco圧縮は3Dモデルのジオメトリに対してのみ効果があります。
71+
テクスチャファイルの圧縮については[テクスチャ圧縮](../WorldOptimization/TextureCompression.ja.md)を参照してください。

‎docs/VKCComponents/img/VKCNodeDraco_01.jpg‎

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)