.. _BlastTool_Editor:

Blast Authoring Tool Editor 
###################################

The *Blast Authoring Tool* is a simple tool for viewing/editing/creating *.Blast Assets* .

User Interface
--------------

.. image:: \_static\BlastToolEditorIntro.jpg
	:width: 1080px
|
:ref:`BlastTool_QuickStart`
Layout
--------------

**1** `Viewport`_ 

**2** `Menu Bar`_  

**3** `Tool Bar`_ - The Toolbar has simulation, damage and other controls that are commonly used for iterating on a project scene wide
.
 
**4** `Filter Properties`_ - The Filter Properties allow you to filter different components of the blast asset such as depth chunks, bonds and all of the componentes of the blast asset. 

**5** `Blast Scene Tree`_ - The Blast Scene Tree displays a graph of meshes, chunks, and bonds for your blast asset. You can select components via the Blast Scene Tree. 

**6** `Output Window`_ - This window shows important information dependent on use. 

**7** :ref:`BlastTool_BlastSettings` - The Toolbar has animation controls and other controls that are commonly used for iterating on a project scene wide.

**8** :ref:`BlastTool_DamageSettings` - The Toolbar has animation controls and other controls that are commonly used for iterating on a project scene wide.

**9** :ref:`BlastTool_MaterialSettings` - The Toolbar has animation controls and other controls that are commonly used for iterating on a project scene wide.

**10** :ref:`BlastTool_EnvSettings` - Environment The Toolbar has animation controls and other controls that are commonly used for iterating on a project scene wide.

.. _`Viewport`:

Viewport
-------------------
In the *Viewport* you can select, view, edit and damage all imported meshes. 

.. _`Menu Bar`:

Menu Bar
-----------------
.. image:: \_static\BLAT_Menu.jpg
|

File
================
.. image:: \_static\BLAT_File.jpg
|

* **Clear Scene** - Resets *Blast Authoring Tool* Viewer to a blank scene. There are no references to any project files, material files, or texture files when a scene is cleared.

* **Open FBX File** -  Launches a file dialog to allow the user to open an FBX file. Only one FBX can be loaded at a time. Opening an FBX file clears the current FBX file from the scene.

* **Recents** - Recents keeps track of previously opened FBX file. When used it will launch the open FBX dialogue. 

* **Exit** - Closes the Blast Authoring Tool

Blast
==============
.. image:: \_static\BLAT_Blast.jpg
|

* **Undo** - Undoes previous action. 

* **Redo** - Does any undo action again. 

* **Open Project File** - Launches a file dialog to allow the user to open a project file.

* **Recents** - Opens recently opened Project files. 

* **Save Project File** - Saves the current project file.

* **Save Project File As** - Launches a file dialog to allow the user to save a project as a new file.

View
==========
.. image:: \_static\BLAT_View.jpg
|

* **Add Bookmark** - Adds a camera bookmark from the cameras current position.

* **Edit Bookmark** - Launches dialog to edit all bookmarks.

Window
================
.. image:: \_static\BLAT_Window.jpg
|

* **Output** - Toggles the Output Window on/off.

* **Attribute Editor** - Toggles the Attribute Editor on/off.

Help
===========
.. image:: \_static\BLAT_Help.jpg
|

* **Documentation** - Launches this help document.

* **About** - Launches a dialog with various information about HairWorks including the version and web links.

.. _`Tool Bar`:

Tool Bar
======================
.. image:: \_static\BLAT_Toolbar.jpg
|
* |BlastProjectOpen| **Open Blast Project** - Launches a file dialog to allow the user to open a project file.
.. |BlastProjectOpen| image:: \_static\BLAT_TBOBP.jpg

* |BlastProjectSave| **Save Blast Project** - Saves the current project file. If Export assets are checked they will be exported on Save. 
.. |BlastProjectSave| image:: \_static\BLAT_TBSP.jpg

* |BlastExport| **Export Blast Files** - Exports the current checked project file exports. Only checked assets in Blast/File References/Export Assets are exported.
.. |BlastExport| image:: \_static\BLAT_TBExp.jpg

* |BlastDepth| **Depth Preview** - Displays current chunk depth.
.. |BlastDepth| image:: \_static\BLAT_DPFC.jpg

* |BlastFull| **Full Coverage** - Toggle shows all depth in the *Blast Scene Tree*.
.. |BlastFull| image:: \_static\BLAT_FC.jpg

* |BlastSelection| **Selection Button** - The Selection Button allows you to select objects in the *Viewport*.
.. |BlastSelection| image:: \_static\BLAT_SelButton.jpg

* |BlastSelectionSquare|  **Rectangle Selection Button** - Default selection button. Allows you to select with a rectangular marquis with left click drag.
.. |BlastSelectionSquare| image:: \_static\BLAT_SelSquare.jpg

* |BlastSelectionCircle| **Circle Selection Button** - Allows you to select with a circular marquis with left click drag.
.. |BlastSelectionCircle| image:: \_static\BLAT_SelCircle.jpg

* |BlastSelectionPolygon| **Polygon Selection Button** - Allows you to select with a polygonal marquis with a sequential left click.
.. |BlastSelectionPolygon| image:: \_static\BLAT_SelPolygon.jpg

* |BlastSelectionCurve| **Curve Selection Button** - Allows you to select with a curve driven marquis with left click drag.
.. |BlastSelectionCurve| image:: \_static\BLAT_SelCurve.jpg

* |BlastExplodeAmount| **Explosion Amount Button** - Click the Explosion Amount Button and drag in the Viewport. To freeze the Explosion amount select the Select button. 
.. |BlastExplodeAmount| image:: \_static\BLAT_ExplodeAmtB.jpg

* |BlastMoveButton| **Move button** - Currently disabled. 
.. |BlastMoveButton| image:: \_static\BLAT_MoveButton.jpg

* |BlastRotateButton| **Rotate button** - Currently disabled. 
.. |BlastRotateButton| image:: \_static\BLAT_RotateButton.jpg

* |BlastGlobalLocal| **Global/Local Orientation** - Currently disabled.
.. |BlastGlobalLocal| image:: \_static\BLAT_GlobalLocal.jpg

* |BlastResetSim| **Reset Simulation Button** - Resets simulation. 
.. |BlastResetSim| image:: \_static\BLAT_ResetSim.jpg

* |BlastSim| **Toggle Simulate Button** - Toggles playback of the simulation.
.. |BlastSim| image:: \_static\BLAT_Sim.jpg

* |BlastSim| **Simualation Step Button** - Steps the simulation forward 1 frame.
.. |BlastSim| image:: \_static\BLAT_GlobalLocal.jpg

* |BlastSimStep| **Simualation Step Button** - Steps the simulation forward 1 frame.
.. |BlastSimStep| image:: \_static\BLAT_FrameStep.jpg

* |BlastDMGButton| **Damage Button** - Allows clickable damage in the *Viewport* Works in tandem with the Damage Tab.
.. |BlastDMGButton| image:: \_static\BLAT_DmgButton.jpg

* |BlastDMGThrow| **Throw Object Button** - Throws object aimed at Blast object in the viewport per click. 
.. |BlastDMGThrow| image:: \_static\BLAT_DmgThrowButton.jpg

* |BlastDMGDrop| **Drop Object Button** - Drops Blast object in the viewport per click. 
.. |BlastDMGDrop| image:: \_static\BLAT_DmgDropButton.jpg



.. _`Filter Properties`:

Filter Properties
======================
.. image:: \_static\BLAT_FliterBase.jpg
|

The Blast *Filters* Window allows you to filter the fractured *Blast Asset* in a two step process. First you set you parameters of the filter then you click an *Action*. Yoo can select, view or hide as an action in the blast asset. 

Filter Options
++++++++++++++++++
The following are a list of Filtering options in the Filter window. 

Rule
++++
* All Descendants
* All Parents

Depth
+++++
* All
* Depth 0
* Depth 1
* Depth 2
* Depth 3
* Depth 4
* Depth 5

Item Type
++++++++++
* All
* Chunk
* Suppot Chunk
* Static Support Chunk
* Bond
* World Bond

Operator
+++++++++
* Equal To 
* Not Equal To

Filter Buttons
=================
Preset
+++++++++++

* |AddFPreset| **Add Preset** -Add a new Preset which starts by launching a select name dialog.

.. |AddFPreset| image:: \_static\BLAT_Playlists_Add.jpg

* |EditFPreset| **Edit Selected Preset** - Edit the name of the selected Preset. 

.. |EditFPreset| image:: \_static\BLAT_Playlists_Edit.jpg

* |DeleteFPreset| **Delete Selected Preset** - Delete the selected Preset. 

.. |DeleteFPreset| image:: \_static\BLAT_TextureRemove.jpg

* |SaveFPreset| **Save Preset** - Save selected Preset.  

.. |SaveFPreset| image:: \_static\BLAT_SaveOpen.jpg

Action
++++++++

* |FSelect| **Select** - Select based on Filter Parameters.  

.. |FSelect| image:: \_static\BLAT_Select.jpg

* |FShow| **Show** - Save selected Preset.  

.. |FShow| image:: \_static\BLAT_Show.jpg

* |FHide| **Save Preset** - Save selected Preset.  

.. |FHide| image:: \_static\BLAT_Hide.jpg


.. _`Blast Scene Tree`:

Blast Scene Tree
======================
The Blast Scene Tree allows you to select, show and hide chunks in your Blast Object. You can set Support Chunks, World Support and Static Chunks here. This is a dockable window. 

.. image:: \_static\BLAT_SceneTree.jpg
|

.. image:: \_static\BLAT_Support.jpg
|

* **Make Support** - Make a chunk into a support chunk. 
* **Make Static Support** - Make a chunk into a static support chunk. This chunk or chunks will be static and not destroyable. 
* **Remove Support** - Remove support from a chunk.
* **Add World** - Add a world bond to a chunk. This bond can be destroyed with enough damage. 
* **Remove World** - Remove World bond.  

Icons
++++++++++++++++++++++++

* |BlastExpandCollapse| **Expand/Collapse** - Toggle expands and collapses the Blast Scene Tree
.. |BlastExpandCollapse| image:: \_static\BLAT_ExpandCollapse.jpg

* |BlastCompAsset| **Blast Composite Asset** 
.. |BlastCompAsset| image:: \_static\BLAT_CompositeAsset.jpg

* |BlastCompAsset| **Blast Asset**  
.. |BlastCompAsset| image:: \_static\BLAT_Asset.jpg

* |BlastChunkSupport| **Support Chunk**  
.. |BlastChunkSupport| image:: \_static\BLAT_Chunk.jpg

* |BlastChunkSupportWorld| **Support Chunk World Support** 
.. |BlastChunkSupportWorld| image:: \_static\BLAT_ChunkWorld.jpg

* |BlastChunk| **Chunk** - just a chunk
.. |BlastChunk| image:: \_static\BLAT_ChunkSupport.jpg

* |BlastChunkSupportWorld| **Chunk World Support**
.. |BlastChunkSupportWorld| image:: \_static\BLAT_ChunkSupWorld.jpg

* |BlastChunkSupportStatic| **Static Chunk** 
.. |BlastChunkSupportStatic| image:: \_static\BLAT_ChunkSupportStatic.jpg

* |BlastChunkSupportStaticWorld| **Static Chunk World Support** 
.. |BlastChunkSupportStaticWorld| image:: \_static\BLAT_ChunkSSWorld.jpg

* |BlastBond| **Bond**  
.. |BlastBond| image:: \_static\BLAT_Bond.jpg

Chunk Options
++++++++++++++++




.. _`Output Window`:

Output Window
=====================
.. image:: \_static\BLAT_OutputWindow.jpg
|

The output window displays important information depending on use. Information dependendent on user interaction. 

Keyboard Shortcuts
-------------------------
General
+++++++++++

* **H** - Show/Hide HUD gpu info.

* **G** - Show/Hide HUD asset stats.

* **L + Left Mouse:** Rotate active Light.

* **Ctrl +O:** Open project file.

* **Ctrl + S:** Saves project file.

* **Ctrl + X:** Toggles presentation mode on/off.

* **Ctrl + space:** Undo/Redo of last UI action.

* **Right Arrow:** Open next project in selected playlist.

* **Left Arrow:** Open previous project in selected playlist.

Maya Navigation
+++++++++++++++++

* **Alt + Left Mouse:** Rotate.
* **Alt + Middle Mouse:** Translate.
* **Alt + Right Mouse:** Zoom.

3dsMax Navigation
+++++++++++++++++++++

* **Alt + Middle Mouse:** Rotate.
* **Middle Mouse:** Translate.
* **Middle Mouse Scroll Wheel:** Zoom.

Game Pad Controls
+++++++++++++++++++

Each button on the controller offers a different function, typically used for navigating Playlists in Demo Mode. The following controls are based on a Microsoft XBOX Controller layout.

* **Right Bumper** - Loads the next project in the selected Playlist.
* **Left Bumper** - Loads the previous project in the selected Playlist.
* **B** - Resets the animation to the start of the animation clip.
* **Y** - Switch the Viewer between Presentation view and the standard view.
* **Left Analog Stick** - Zoom in and out from the asset.
* **Right Analog Stick** - Rotate the camera.
* **D-Pad Up** - Show/Hide HUD gpu info.
* **D-Pad Left** - Show/Hide HUD asset stats.
* **Left Trigger + Left Stick** - Move the light located in the scene.




