Explorar o código

Updated documentation

Jorrit Rouwe %!s(int64=3) %!d(string=hai) anos
pai
achega
d2ae231ecb
Modificáronse 2 ficheiros con 11 adicións e 1 borrados
  1. 2 0
      Docs/PerformanceTest.md
  2. 9 1
      Docs/Samples.md

+ 2 - 0
Docs/PerformanceTest.md

@@ -15,6 +15,8 @@ The performance test application contains a couple of simple scenes to test perf
 - -r: Outputs a performance_test_[tag].jor file that contains a recording to be played back with JoltViewer
 - -f: Outputs the time taken per frame to per_frame_[tag].csv
 - -h: Displays a help text
+- -rs: Record the simulation state in state_[tag].bin.
+- -vs: Validate the recorded simulation state from state_[tag].bin. This will after every simulation step check that the state is the same as the recorded state and trigger a breakpoint if this is not the case. This is used to validate cross platform determinism.
 
 ## Output
 

+ 9 - 1
Docs/Samples.md

@@ -89,10 +89,18 @@ This category shows the various constraints that are supported. Constraints conn
 |:-|
 |*Showing the path constraint in action.*|
 
-|[![Swing Twist Constraing](https://img.youtube.com/vi/8aQ9x8SQSuM/hqdefault.jpg)](https://www.youtube.com/watch?v=8aQ9x8SQSuM)|
+|[![Swing Twist Constraint](https://img.youtube.com/vi/8aQ9x8SQSuM/hqdefault.jpg)](https://www.youtube.com/watch?v=8aQ9x8SQSuM)|
 |:-|
 |*Demonstrates a chain of swing-twist constraints (usable for humanoid shoulders). The green cones show the swing limit and the pink pie shows the twist limit.*|
 
+|[![Gear constraint](https://img.youtube.com/vi/3w5SgElroBw/hqdefault.jpg)](https://www.youtube.com/watch?v=3w5SgElroBw)|
+|:-|
+|*Demonstrates a gear constraint. Note that the gears can be placed at any relative angle of each other, so you could e.g. create a bevel or worm gear.*|
+
+|[![Rack and pinion constraint](https://img.youtube.com/vi/e588KG-ZSxc/hqdefault.jpg)](https://www.youtube.com/watch?v=e588KG-ZSxc)|
+|:-|
+|*Demonstrates a rack and pinion constraint.*|
+
 ### General
 
 This category contains general simulation tests. It demonstrates things like friction, restitution, damping, modifying gravity and continous collision detection. Some highlights: