Update the documentation to explain new features.

- Add command demos into commands_demo.ipynb - Add command help text into commands.rst - Upgrade plugin version
unrealcv · Oct 18, 2017 · 5bebff4 · 5bebff4
1 parent 1388521
commit 5bebff4
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 4 deletions.
diff --git a/UnrealCV.uplugin b/UnrealCV.uplugin
@@ -1,7 +1,7 @@
 {
     "FileVersion" : 3,
     "Version" : 4,
-    "VersionName": "0.3.9",
+    "VersionName": "0.3.10",
     "FriendlyName": "Unreal CV",
     "Description": "UnrealCV is a plugin to connect computer vision algorithm and the games built by Unreal Engine",
     "Category" : "Science",

diff --git a/docs/reference/commands.rst b/docs/reference/commands.rst
@@ -56,6 +56,24 @@ vset /viewmode [viewmode]
 vget /viewmode
     (v0.2) Get current ViewMode
 
+vget /camera/[id]/pose
+    (v0.3.10) Get camera location [x, y, z] and rotation [pitch, yaw, roll]
+
+vset /camera/[id]/pose [x] [y] [z] [pitch] [yaw] [roll]
+    (v0.3.10) Teleport camera to location [x, y, z] and rotation [pitch, yaw, roll]
+
+vget /camera/[uint]/horizontal_fieldofview
+    (v0.3.10) Get camera horizontal field of view
+
+vset /camera/[uint]/horizontal_fieldofview [FOV]
+    (v0.3.10) Set camera horizontal field of view
+
+vget /camera/[uint]/vis_depth npy
+    (v0.3.10)
+
+vget /camera/[uint]/plane_depth npy
+    (v0.3.10)
+
 2. Object interaction
 ---------------------
 
@@ -70,6 +88,12 @@ vget /object/[obj_name]/color
 vset /object/[obj_name]/color [r] [g] [b]
     (v0.2) Set the labeling color of an object
 
+vset /object/[str]/show
+    (v0.3.10) Show object
+
+vset /object/[str]/hide
+    (v0.3.10) Hide object
+
 3. Plugin commands
 ------------------
 
@@ -89,6 +113,21 @@ See :file:`Source/UnrealCV/Private/Commands/ActionHandler.h(.cpp)`
 vset /action/keyboard [key_name] [delta]
     (v0.3.6) Valid key_name can be found in `here <https://wiki.unrealengine.com/List_of_Key/Gamepad_Input_Names>`__
 
+vset /action/game/pause
+    (v0.3.10) Pause the game
+
+vset /action/game/level [level_name]
+    (v0.3.10) Open a new level
+
+vset /action/input/enable
+    (v0.3.10) Enable input
+
+vset /action/input/disable
+    (v0.3.10) Disable input
+
+vset /action/eyes_distance [eye_distance]
+    (v0.3.10) Set the eye distance between left eye and right eye (camera 1). This command might be marked as deprecated when we finish multiple camera support.
+
 Run UE4 built-in commands
 -------------------------
 

diff --git a/docs/reference/commands_demo.ipynb b/docs/reference/commands_demo.ipynb
diff --git a/examples/commands_demo.ipynb b/examples/commands_demo.ipynb