A brief user's manual for the server application can be found here.

The user interface

Warning: Work in progress...

The frame concept

TODO

We believe in a non-overlapping user interface, which is the rationale and motivation behind introducing frames. This way of working should be familiar to anyone that's used a 3D modelling program such as Blender or 3DSMax.

While they at the moment frames are utterly broken, the idea is that you should be able to divide the screen estate as you please. Each region of the screen then contains a frame. Our frame concept mimics that found in webpages, and, consequently, aren't just only the borders around a region but the region itself.

For each region on the screen you can choose which frame is shown in it. This is done through the blue drop-down menu at the top-left of every frame.

Workspaces

TODO

At the moment, the workspace feature is broken. Don't try to use workspace 2!

The 3D View

Moving around in the world is currently done using all three buttons on the mouse.

• Use the left button to pan, i.e. change the focus point of the active camera.
• Use the right button to rotate (you can rotate about the world Z-axis and the camera's X-axis).
• "Zoom" by using the middle mouse button. As an alternative you can also use the mouse wheel (if there's one present) for this chore.

You can also interactively select objects in the View frame. This is done in "select mode", which you access by holding in the s-key. The following commands are available in select mode:

• Left click - select.
• Right click - deselect all.
• Ctrl + left click - toggle select.
• Shift + left click - Selects any picked objects, but never deselects one, on the contrary to the toggle select feature.

Move mode is accessed by holding in the m key. Use the left mouse button to move any selected objects. Objects are moved "in the camera plane", or perpendicular to the camera's near plane's normal to be more correct.

The Tree browser

TODO

The Console

TODO

Basically, this is just a way of providing information to the user.

The Property Inspector

TODO

Don't try to change the color of a camera!''' It will crash! :)

Using the proxy

TODO

There's a nicer variant of the documentation from Proxy.hh available here.