@shopware-ag/dive 1.5.0 → 1.6.0

package/README.md

@@ -77,6 +77,18 @@ module.exports = () => {
 };
 ```
 
+# Quick View
+QuickView is used to quickly display your assets with as few lines of code as possible. Simply call the static ``QuickView()`` method (with your data-uri as a parameter) to create an instance of DIVE with your asset to use in further code.
+```ts
+import { DIVE } from '@shopware-ag/dive';
+
+const dive = DIVE.QuickView('your/asset/uri.glb'); // <-- call QuickView()
+
+const myCanvasWrapper = document.createElement('div');
+myCanvasWrapper.appendChild(dive.Canvas);
+
+```
+
 # Getting started
 Import:
 ```ts
@@ -159,28 +171,29 @@ unsubscribe(); // <-- execute unsubscribe callback when done
 
 In the following you find a list of all available actions to perform on DIVECommunication class via `com.PerformAction()`.
 
-| Action                                                                         | Description
-|:-------------------------------------------------------------------------------| :---
-| [GET_ALL_SCENE_DATA](./src/com/actions/scene/getallscenedata.ts)               | Return all scene data that is currently set
-| [GET_ALL_OBJECTS](./src/com/actions/object/getallobjects.ts)                   | Return a map of all objects
-| [GET_OBJECTS](./src/com/actions/object/getobjects.ts)                          | Return an array of all objects with given ids
-| [PLACE_ON_FLOOR](./src/com/actions/object/model/placeonfloor.ts)               | Set a model onto to the floor
-| [ADD_OBJECT](./src/com/actions/object/addobject.ts)                            | Add an object to the scene
-| [UPDATE_OBJECT](./src/com/actions/object/updateobject.ts)                      | Update an existing object
-| [DELETE_OBJECT](./src/com/actions/object/deleteobject.ts)                      | Delete an existing object
-| [SELECT_OBJECT](./src/com/actions/object/selectobject.ts)                      | Select an existing object in the scene
-| [DESELECT_OBJECT](./src/com/actions/object/deselectobject.ts)                  | Deselect an existing object in the scene
-| [SET_BACKGROUND](./src/com/actions/scene/setbackground.ts)                     | Set a background color
-| [DROP_IT](./src/com/actions/object/model/dropit.ts)                            | Places the model onto the next underlying object's bounding box
-| [PLACE_ON_FLOOR](./src/com/actions/object/model/placeonfloor.ts)               | Places the model onto the floor (zero plane)
-| [SET_CAMERA_TRANSFORM](./src/com/actions/camera/setcameratransform.ts)         | Set camera transformation (w/o animation, used to initially set up camera)
-| [GET_CAMERA_TRANSFORM](./src/com/actions/camera/getcameratransform.ts)         | Return currenty camera transformation
-| [MOVE_CAMERA](./src/com/actions/camera/movecamera.ts)                          | Move camera to a specific position or the position of a previously defined POV (with an animation)
-| [RESET_CAMERA](./src/com/actions/camera/resetcamera.ts)                        | Reset camera to original position after MOVE_CAMERA was performed
-| [SET_CAMERA_LAYER](./src/com/actions/camera/setcameralayer.ts)                 | Set camera layer to switch between live view and editor view
-| [ZOOM_CAMERA](./src/com/actions/camera/zoomcamera.ts)                          | Zoom in or out
-| [SET_GIZMO_MODE](./src/com/actions/toolbox/select/setgizmomode.ts)             | Set gizmo mode
-| [SET_GIZMO_VISIBILITY](./src/com/actions/toolbox/select/setgizmovisibility.ts) | Set gizmo visibility
-| [MODEL_LOADED](./src/com/actions/object/model/modelloaded.ts)                  | Is performed when a model file is completely loaded
-| [UPDATE_SCENE](./src/com/actions/scene/updatescene.ts)                         | Update scene data
-| [GENERATE_MEDIA](./src/com/actions/media/generatemedia.ts)                     | Generate a screenshot with the specified parameters
+| Action                                                                                | Description
+|:--------------------------------------------------------------------------------------| :---
+| [GET_ALL_SCENE_DATA](./src/com/actions/scene/getallscenedata.ts)                      | Return all scene data that is currently set
+| [GET_ALL_OBJECTS](./src/com/actions/object/getallobjects.ts)                          | Return a map of all objects
+| [GET_OBJECTS](./src/com/actions/object/getobjects.ts)                                 | Return an array of all objects with given ids
+| [PLACE_ON_FLOOR](./src/com/actions/object/model/placeonfloor.ts)                      | Set a model onto to the floor
+| [ADD_OBJECT](./src/com/actions/object/addobject.ts)                                   | Add an object to the scene
+| [UPDATE_OBJECT](./src/com/actions/object/updateobject.ts)                             | Update an existing object
+| [DELETE_OBJECT](./src/com/actions/object/deleteobject.ts)                             | Delete an existing object
+| [SELECT_OBJECT](./src/com/actions/object/selectobject.ts)                             | Select an existing object in the scene
+| [DESELECT_OBJECT](./src/com/actions/object/deselectobject.ts)                         | Deselect an existing object in the scene
+| [SET_BACKGROUND](./src/com/actions/scene/setbackground.ts)                            | Set a background color
+| [DROP_IT](./src/com/actions/object/model/dropit.ts)                                   | Places the model onto the next underlying object's bounding box
+| [PLACE_ON_FLOOR](./src/com/actions/object/model/placeonfloor.ts)                      | Places the model onto the floor (zero plane)
+| [SET_CAMERA_TRANSFORM](./src/com/actions/camera/setcameratransform.ts)                | Set camera transformation (w/o animation, used to initially set up camera)
+| [GET_CAMERA_TRANSFORM](./src/com/actions/camera/getcameratransform.ts)                | Return currenty camera transformation
+| [MOVE_CAMERA](./src/com/actions/camera/movecamera.ts)                                 | Move camera to a specific position or the position of a previously defined POV (with an animation)
+| [RESET_CAMERA](./src/com/actions/camera/resetcamera.ts)                               | Reset camera to original position after MOVE_CAMERA was performed
+| [COMPUTE_ENCOMPASSING_VIEW](./src/com/actions/camera/computeencompassingview.ts),     | Calculates the camera position and target to view the whole scene
+| [SET_CAMERA_LAYER](./src/com/actions/camera/setcameralayer.ts)                        | Set camera layer to switch between live view and editor view
+| [ZOOM_CAMERA](./src/com/actions/camera/zoomcamera.ts)                                 | Zoom in or out
+| [SET_GIZMO_MODE](./src/com/actions/toolbox/select/setgizmomode.ts)                    | Set gizmo mode
+| [SET_GIZMO_VISIBILITY](./src/com/actions/toolbox/select/setgizmovisibility.ts)        | Set gizmo visibility
+| [MODEL_LOADED](./src/com/actions/object/model/modelloaded.ts)                         | Is performed when a model file is completely loaded
+| [UPDATE_SCENE](./src/com/actions/scene/updatescene.ts)                                | Update scene data
+| [GENERATE_MEDIA](./src/com/actions/media/generatemedia.ts)                            | Generate a screenshot with the specified parameters