From aa9d90c49505ef8a9aace416a298e2f29a9ec15b Mon Sep 17 00:00:00 2001
From: Andrew Heather <a.heather@opencfd.co.uk>
Date: Tue, 6 Dec 2016 09:23:55 +0000
Subject: [PATCH] ENH: runTime pp - updated header documentation
---
.../graphics/runTimePostProcessing/scene.H | 22 +++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/src/functionObjects/graphics/runTimePostProcessing/scene.H b/src/functionObjects/graphics/runTimePostProcessing/scene.H
index 3350b946de6..e2f5d87e122 100644
--- a/src/functionObjects/graphics/runTimePostProcessing/scene.H
+++ b/src/functionObjects/graphics/runTimePostProcessing/scene.H
@@ -25,6 +25,28 @@ Class
Foam::functionObjects::runTimePostPro::scene
Description
+ Class to control scene construction and provide main rendering loop
+
+Usage
+ \verbatim
+ camera
+ {
+ // Total number of frames to generate
+ nFrameTotal 1;
+
+ // Parallel projection flag
+ parallelProjection no;
+
+ focalPoint (0 0 0);
+ up (0 1 0);
+ position (0 0 1);
+
+ // Optional entries
+ clipBox (-0.0206 -0.0254 -0.0005) (0.29 0.0254 0.0005);
+ viewAngle 20;
+ zoom 1.1;
+ }
+ \endverbatim
SourceFiles
scene.C
--
GitLab