Skip to content

Commit 5dbd8f2

Browse files
Create workspace.md
1 parent bc9676b commit 5dbd8f2

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

documentation/workspace.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# The Workspace: A Minimal 3D Mesh Viewer
2+
3+
The Workspace is a streamlined tool designed for visualizing and inspecting 3D models. It's tightly integrated
4+
with the Processing environment, leveraging its powerful rendering capabilities. While it doesn't aspire
5+
to be a comprehensive 3D modeling suite, it provides essential features for working with mesh data.
6+
7+
## Getting Started
8+
To use the Workspace, simply create an instance and provide a reference to your Processing
9+
sketch (PApplet). No immediate interaction with the Workspace is necessary in the draw() method.
10+
The Workspace is ready to use with its default functionalities.
11+
12+
```java
13+
package workspace.examples;
14+
15+
import processing.core.PApplet;
16+
import workspace.Workspace;
17+
18+
public class WS_MinimalSetup extends PApplet {
19+
20+
public static void main(String[] args) {
21+
PApplet.main(WS_MinimalSetup.class.getName());
22+
}
23+
24+
private Workspace workspace;
25+
26+
@Override
27+
public void settings() {
28+
size(1000, 1000, P3D);
29+
}
30+
31+
@Override
32+
public void setup() {
33+
workspace = new Workspace(this);
34+
}
35+
36+
@Override
37+
public void draw() {
38+
39+
}
40+
41+
}
42+
```
43+
44+
### Key Features
45+
46+
**Camera Control**
47+
48+
* **Zoom:** Scroll the mouse wheel.
49+
* **Rotate:** Drag with the middle mouse button.
50+
* **Pan:** Drag with the middle mouse button while holding Shift.
51+
* **First-Person Navigation:** Use WASD keys.
52+
53+
**Scene Manipulation**
54+
55+
* **Reset Camera:** Press C.
56+
* **Toggle UI:** Press Y.
57+
* **Toggle Grid:** Press G.
58+
* **Show/Hide Normals:** Press N for face normals, V for vertex normals.
59+
* **Wireframe/Solid View:** Press Z.
60+
* **Show/Hide Axes:** Press 1, 2, or 3.
61+
* **Show/Hide Edges:** Press E.
62+
* **Smooth/Flat Shading:** Press S.
63+
* **First-Person Mode:** Press 4.
64+
* **Toggle Rendering Loop:** Use the UI control.

0 commit comments

Comments
 (0)