Metadata-Version: 2.1
Name: SceneEditor
Version: 22.4.1
Summary: A scene editor for the Panda3D engine
Home-page: https://github.com/fireclawthefox/SceneEditor
Author: Fireclaw
Author-email: fireclawthefox@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Artistic Software
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Multimedia :: Graphics :: Editors
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# SceneEditor
A simple Scene editor for the Panda3D game engine

## Requirements
- Python 3.x
- Panda3D 1.10.4.1+
- DirectFolderBrowser
- DirectGuiExtension

To install them, using pip:
<code>pip install -r requirements.txt</code>

## Manual
NOTE: Currently the editor is heavily work in progress so things may change later

### Starting the editor
To start the Scene Editor, simply run the main.py script

<code>python main.py</code>

### Shortcuts
#### Basic
|shortcut|action|
|---|---|
|Ctrl-Q|Quit the editor|
|Ctrl-N|New Scene|
|Ctrl-O|Open Scene from JSON format|
|Ctrl-S|Save Scene to JSON format|
|Ctrl-E|Export Scene to Python format|

#### Navigation
Navigating the scene is similar to Blender in that you can move around with the mouse.
|shortcut|action|
|---|---|
|Middle mouse button|Rotate around pivot|
|Shift + Middle mouse button|Pan|
|mouse wheel|Zoom|
|Left mouse button|Select|
|Shift + Left mouse button|Multiselect|
|Ctrl-G|Toggle grid|
|5|Toggle Perspective/Orthographic lense|
|7|Show top|
|Ctrl-7|Show bottom|
|1|Show front|
|Ctrl-1|Show back|
|3|Show right|
|Ctrl-3|Show left|

#### Editing
|shortcut|action|
|---|---|
|G|Move selected objects|
|R|Rotate selected objects around objects center|
|S|Scale selected objects|
|X, Y and Z|During moving and rotating clips to the respective axis|
|Del|Remove objects|
|Ctrl-Z|Undo|
|Ctrl-Y|Redo|
|Ctrl-Shift-Y|Switch between redo branches|
|C|Show collision solids|
|H|Toggle model hidden status|
|Ctrl-C|Copy|
|Ctrl-X|Cut|
|Ctrl-V|Paste (makes last selected object parent or render if none is selected)|
|Page Up|Increase objects sort value|
|Page Down|Decrease objects sort value|

### Save and export
To save The Scene as a project file, hit Ctrl-S or the respective button in the toolbar.
This will save a Json file that can later be loaded by the editor again.

To export as a python script that can directly be used in projects, either hit Ctrl-E or click the button in the toolbar.

### Use exported scripts
The python script will always contain a class called Scene which you can pass a NodePath to be used as root parent element for the scene. Simply instancing the class will load and show the scene by default. If this is not desired, hide the root NodePath as given on initialization. As you shouldn't edit the exported class due to edits being overwritten with a new export, you should create another python module which will handle the logic for the scene. This dedicated module could for example implement a show and hide method to easily change the visibility of the scene. All objects can be accessed from the instantiated scene by their name with special characters being replaced with an underscore.

Here is a small example of how to load and instantiate a Scene. We expect the scene to be exported to a file called myScene.py and contain a model named panda:
<code><pre>from myScene import Scene as MyScene
myScene = MyScene()
myScene.panda.set_pos(0,0,0)
</pre></code>

## Screenshots
<img src="https://raw.githubusercontent.com/fireclawthefox/SceneEditor/main/Screenshots/SceneEditor.png" />

## WIP
Not all values will be saved and loaded yet
Property editor is heavily work in progress


