[cig-commits] commit: Filling out meta files for swarm viewer stuff
Mercurial
hg at geodynamics.org
Mon Nov 24 11:29:43 PST 2008
changeset: 89:f49fe434cc69
user: rob at hijiki.maths.monash.edu.au
date: Mon Nov 17 17:09:52 2008 +1100
files: DrawingObjects/src/SwarmRGBColourViewer.meta DrawingObjects/src/SwarmSquares.meta DrawingObjects/src/SwarmVectors.meta DrawingObjects/src/SwarmViewer.meta DrawingObjects/src/SwarmViewerBase.meta
description:
Filling out meta files for swarm viewer stuff
diff -r c2f9576fc655 -r f49fe434cc69 DrawingObjects/src/SwarmRGBColourViewer.meta
--- a/DrawingObjects/src/SwarmRGBColourViewer.meta Wed Nov 05 17:18:15 2008 +1100
+++ b/DrawingObjects/src/SwarmRGBColourViewer.meta Mon Nov 17 17:09:52 2008 +1100
@@ -3,7 +3,7 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">lucSwarmRGBColourViewer</param>
-<param name="Author">...</param>
+<param name="Author">Cecile Duboz</param>
<param name="Organisation">MCC</param>
<param name="Project">gLucifer</param>
<param name="Location">./gLucifer/DrawingObjects/src/</param>
@@ -11,90 +11,49 @@
<param name="Copyright">Copyright (c) 2005, Monash Cluster Computing</param>
<param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
<param name="Parent">lucOpenGLDrawingObject</param>
-<param name="Reference">...</param>
-<param name="Summary">...</param>
-<param name="Description"> This is equivalent to the lucSwarmViewer but one can apply a different variable to each of the R, G and B channels individually. If the channel is not attached to a swarm variable then it assumes the value 0.0. The colour variable is not used ? </param>
+<param name="Reference">N/A</param>
+<param name="Summary">N/A</param>
+<param name="Description"> This is equivalent to the lucSwarmViewer but one can apply a different variable to each of the Red, Green and Blue channels individually. If a colour channel is not associated to any swarm variable, then the value defaults to the corresponding value set with the parameter "colour". The colour variable is not used.</param>
<!--Now the interesting stuff-->
-
-
<list name="Params">
- <struct>
- <param name="Name">ColourRedVariable</param>
- <param name="Type">String</param>
- <param name="Default">""</param>
- <param name="Description">...</param>
- </struct>
- <struct>
- <param name="Name">ColourGreenVariable</param>
- <param name="Type">String</param>
- <param name="Default">""</param>
- <param name="Description">...</param>
- </struct>
- <struct>
- <param name="Name">ColourBlueVariable</param>
- <param name="Type">String</param>
- <param name="Default">""</param>
- <param name="Description">...</param>
- </struct>
- <struct>
- <param name="Name">OpacityVariable</param>
- <param name="Type">String</param>
- <param name="Default">""</param>
- <param name="Description">...</param>
- </struct>
- <struct>
- <param name="Name">MaskVariable</param>
- <param name="Type">String</param>
- <param name="Default">""</param>
- <param name="Description">...</param>
- </struct>
- <struct>
- <param name="Name">colour</param>
- <param name="Type">String</param>
- <param name="Default">"black"</param>
- <param name="Description">...</param>
- </struct>
- <struct>
- <param name="Name">pointSize</param>
- <param name="Type">Double</param>
- <param name="Default">1.0</param>
- <param name="Description">...</param>
- </struct>
-
</list>
<list name="Dependencies">
<struct>
- <param name="Essential">True</param>
- <param name="Name">Swarm</param>
- <param name="Type">Swarm</param>
- <param name="Description">...</param>
+ <param name="Name">ColourRedVariable</param>
+ <param name="Type">SwarmVariable</param>
+ <param name="Essential">False</param>
+ <param name="Description">The Swarm Variable by which you may define the red value of the colour of the particle.</param>
</struct>
+ <struct>
+ <param name="Name">ColourGreenVariable</param>
+ <param name="Type">SwarmVariable</param>
+ <param name="Essential">False</param>
+ <param name="Description">The Swarm Variable by which you may define the green value of the colour of the particle.</param>
+ </struct>
+ <struct>
+ <param name="Name">ColourBlueVariable</param>
+ <param name="Type">SwarmVariable</param>
+ <param name="Essential">False</param>
+ <param name="Description">The Swarm Variable by which you may define the blue value of the colour of the particle.</param>
+ </struct>
+</list>
-<!-- PLEASE, check the above struct information is accurate, in line number 153 of the c file and then remove this comment afterwards -->
-
- <struct>
- <param name="Essential">No</param>
- <param name="Name">ColourMap</param>
- <param name="Type">lucColourMap</param>
- <param name="Description">...</param>
+<!-- Add an exmaple XML if possible -->
+<param name="Example">
+ <struct name="yteparticleDotsrgb">
+ <param name="Type">lucSwarmRGBColourViewer</param>
+ <param name="Swarm">materialSwarm</param>
+ <param name="MaskVariable">materialSwarm-HasYielded</param>
+ <param name="maskValue">1</param>
+ <param name="maskType">EqualTo</param>
+ <param name="OpacityVariable">materialSwarm-YieldTypeOpacity</param>
+ <param name="ColourRedVariable">materialSwarm-YieldTypeExtension</param>
+ <param name="ColourBlueVariable">materialSwarm-YieldTypeCompression</param>
+ <param name="ColourGreenVariable">materialSwarm-YieldTypeShear</param>
+ <param name="pointSize">2.0</param>
</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 154 of the c file and then remove this comment afterwards -->
-
- <struct>
- <param name="Essential">No</param>
- <param name="Name">Material</param>
- <param name="Type">Material</param>
- <param name="Description">...</param>
- </struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 163 of the c file and then remove this comment afterwards -->
-
-
-</list>
-<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+</param>
</StGermainData>
diff -r c2f9576fc655 -r f49fe434cc69 DrawingObjects/src/SwarmSquares.meta
--- a/DrawingObjects/src/SwarmSquares.meta Wed Nov 05 17:18:15 2008 +1100
+++ b/DrawingObjects/src/SwarmSquares.meta Mon Nov 17 17:09:52 2008 +1100
@@ -3,7 +3,7 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">lucSwarmSquares</param>
-<param name="Author">...</param>
+<param name="Author">Robert Turnbull and Cecile Duboz</param>
<param name="Organisation">MCC</param>
<param name="Project">gLucifer</param>
<param name="Location">./gLucifer/DrawingObjects/src/</param>
@@ -11,8 +11,8 @@
<param name="Copyright">Copyright (c) 2005, Monash Cluster Computing</param>
<param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
<param name="Parent">lucSwarmViewer</param>
-<param name="Reference">...</param>
-<param name="Summary">...</param>
+<param name="Reference">N/A</param>
+<param name="Summary">N/A</param>
<param name="Description">Plots a square on each of the particles in a swarm.</param>
<!--Now the interesting stuff-->
@@ -25,7 +25,6 @@
<param name="Default">0.2</param>
<param name="Description">This is a factor to scale the size of the squares by.</param>
</struct>
-
</list>
<list name="Dependencies">
@@ -33,16 +32,36 @@
<param name="Essential">True</param>
<param name="Name">NormalVariable</param>
<param name="Type">SwarmViewer</param>
- <param name="Description">This is the vector quantity to define the normal for the square drawn on each particle.</param>
+ <param name="Description">This is the vector to define the normal for the square drawn on each particle.</param>
+ </struct>
+ <struct>
+ <param name="Essential">True</param>
+ <param name="Name">PlaneVectorVariable</param>
+ <param name="Type">SwarmViewer</param>
+ <param name="Description">This is the vector to define the orientation of the square drawn on each particle.</param>
</struct>
<struct>
<param name="Essential">True</param>
<param name="Name">LengthVariable</param>
<param name="Type">SwarmViewer</param>
- <param name="Description">This is a scalar quantity used to scale the length of the squares. This overrides the value of the 'length' parameter.</param>
+ <param name="Description">This is a scalar used to scale the length of the squares. This overrides the value of the 'length' parameter.</param>
</struct>
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+ <struct name="faultSquares">
+ <param name="Type">lucSwarmSquares</param>
+ <param name="Swarm">materialSwarm</param>
+ <param name="OpacityVariable">materialSwarm-Opacity</param>
+ <param name="ColourVariable">materialSwarm-Brightness</param>
+ <param name="ColourMap">brightnessColourMap</param>
+ <param name="maskValue">2</param>
+ <param name="maskType">EqualTo</param>
+ <param name="MaskVariable">materialSwarm-MaterialIndex</param>
+ <param name="NormalVariable">materialSwarm-Director</param>
+ <param name="PlaneVectorVariable">materialSwarm-SlipVector</param>
+ <param name="LengthVariable">materialSwarm-Length</param>
+ </struct>
+</param>
</StGermainData>
diff -r c2f9576fc655 -r f49fe434cc69 DrawingObjects/src/SwarmVectors.meta
--- a/DrawingObjects/src/SwarmVectors.meta Wed Nov 05 17:18:15 2008 +1100
+++ b/DrawingObjects/src/SwarmVectors.meta Mon Nov 17 17:09:52 2008 +1100
@@ -3,7 +3,7 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">lucSwarmVectors</param>
-<param name="Author">...</param>
+<param name="Author">Robert Turnbull and Cecile Duboz</param>
<param name="Organisation">MCC</param>
<param name="Project">gLucifer</param>
<param name="Location">./gLucifer/DrawingObjects/src/</param>
@@ -11,8 +11,8 @@
<param name="Copyright">Copyright (c) 2005, Monash Cluster Computing</param>
<param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
<param name="Parent">lucSwarmViewer</param>
-<param name="Reference">...</param>
-<param name="Summary">...</param>
+<param name="Reference">N/A</param>
+<param name="Summary">N/A</param>
<param name="Description">Plots a vector quantity on particles in a swarm as arrows.</param>
<!--Now the interesting stuff-->
@@ -59,6 +59,16 @@
</struct>
</list>
<!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+ <struct name="faults">
+ <param name="Type">lucSwarmVectors</param>
+ <param name="Swarm">materialSwarm</param>
+ <param name="ColourVariable">materialSwarm-HasYielded</param>
+ <param name="ColourMap">hasyieldedColourMap</param>
+ <param name="DirectionVariable">materialSwarm-Vector</param>
+ <param name="arrowHeadSize">0.0</param>
+ <param name="LengthVariable">materialSwarm-Length</param>
+ </struct>
+</param>
</StGermainData>
diff -r c2f9576fc655 -r f49fe434cc69 DrawingObjects/src/SwarmViewer.meta
--- a/DrawingObjects/src/SwarmViewer.meta Wed Nov 05 17:18:15 2008 +1100
+++ b/DrawingObjects/src/SwarmViewer.meta Mon Nov 17 17:09:52 2008 +1100
@@ -3,7 +3,7 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">lucSwarmViewer</param>
-<param name="Author">...</param>
+<param name="Author">Robert Turnbull</param>
<param name="Organisation">MCC</param>
<param name="Project">gLucifer</param>
<param name="Location">./gLucifer/DrawingObjects/src/</param>
@@ -11,8 +11,8 @@
<param name="Copyright">Copyright (c) 2005, Monash Cluster Computing</param>
<param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
<param name="Parent">lucSwarmViewerBase</param>
-<param name="Reference">...</param>
-<param name="Summary">...</param>
+<param name="Reference">N/A</param>
+<param name="Summary">N/A</param>
<param name="Description">Plots particles in a particular swarm as individual dots.</param>
<!--Now the interesting stuff-->
@@ -27,16 +27,24 @@
<struct>
<param name="Name">pointSmoothing</param>
<param name="Type">Bool</param>
- <param name="Default">0</param>
+ <param name="Default">False</param>
<param name="Description">Whether the points should be rendered with GL_POINT_SMOOTH switched on (t) or off (f). You should test the performance implications of switching this on if the number of particles in the swarm is large </param>
</struct>
</list>
<list name="Dependencies">
-
</list>
+
<!-- Add an exmaple XML if possible -->
-<param name="Example">gLucifer/DrawingObjects/tests/testSwarmViewer</param>
+<param name="Example">
+ <struct name="particleDots">
+ <param name="Type">lucSwarmViewer</param>
+ <param name="Swarm">materialSwarm</param>
+ <param name="ColourVariable">materialSwarm-Density</param>
+ <param name="ColourMap">densityColourMap</param>
+ <param name="pointSize">2.0</param>
+ </struct>
+</param>
</StGermainData>
diff -r c2f9576fc655 -r f49fe434cc69 DrawingObjects/src/SwarmViewerBase.meta
--- a/DrawingObjects/src/SwarmViewerBase.meta Wed Nov 05 17:18:15 2008 +1100
+++ b/DrawingObjects/src/SwarmViewerBase.meta Mon Nov 17 17:09:52 2008 +1100
@@ -3,7 +3,7 @@
<StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
<param name="Name">lucSwarmViewerBase</param>
-<param name="Author">...</param>
+<param name="Author">Cecile Duboz and Robert Turnbull</param>
<param name="Organisation">MCC</param>
<param name="Project">gLucifer</param>
<param name="Location">./gLucifer/DrawingObjects/src</param>
@@ -11,8 +11,8 @@
<param name="Copyright">Copyright (c) 2005, Monash Cluster Computing</param>
<param name="License">http://www.opensource.org/licenses/bsd-license.php</param>
<param name="Parent">lucOpenGLDrawingObject</param>
-<param name="Reference">...</param>
-<param name="Summary">...</param>
+<param name="Reference">N/A</param>
+<param name="Summary">N/A</param>
<param name="Description">SwarmViewerBase is an abstract class. It provides the main functionaily for a variable on a Swarm to be viewed as output.</param>
<!--Now the interesting stuff-->
More information about the CIG-COMMITS
mailing list