[cig-commits] commit: Updating these metas, they were a bit backwards
Mercurial
hg at geodynamics.org
Mon Nov 24 11:28:55 PST 2008
changeset: 17:357744bd5367
user: JulianGiordani
date: Wed Jul 18 01:38:08 2007 +0000
files: DrawingObjects/src/SwarmViewer.meta DrawingObjects/src/SwarmViewerBase.meta
description:
Updating these metas, they were a bit backwards
diff -r 3d5ccaddac1c -r 357744bd5367 DrawingObjects/src/SwarmViewer.meta
--- a/DrawingObjects/src/SwarmViewer.meta Tue Jul 17 05:43:47 2007 +0000
+++ b/DrawingObjects/src/SwarmViewer.meta Wed Jul 18 01:38:08 2007 +0000
@@ -10,55 +10,13 @@
<param name="Project Web">http://mcc.monash.edu.au/gLucifer</param>
<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="Parent">lucSwarmViewerBase</param>
<param name="Reference">...</param>
<param name="Summary">...</param>
<param name="Description">Plots particles in a swarm as small dots.</param>
<!--Now the interesting stuff-->
<list name="Params">
- <struct>
- <param name="Name">ColourVariable</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">drawParticleNumber</param>
- <param name="Type">Bool</param>
- <param name="Default">False</param>
- <param name="Description">If set to True, draws the particle number next to the particle</param>
- </struct>
- <struct>
- <param name="Name">sameParticleColour</param>
- <param name="Type">Bool</param>
- <param name="Default">False</param>
- <param name="Description">If set to True and drawParticleNumber is True as well, then display the partivcle number in ths same colour than the particle itself</param>
- </struct>
- <struct>
- <param name="Name">subSetEvery</param>
- <param name="Type">Int</param>
- <param name="Default">1</param>
- <param name="Description">Display one particle every "subSetVery"</param>
- </struct>
- <struct>
- <param name="Name">colour</param>
- <param name="Type">String</param>
- <param name="Default">"black"</param>
- <param name="Description">The colour of the particles. (If a lucColourMap and a colour variable is given - then this colour will not be used)</param>
- </struct>
<struct>
<param name="Name">pointSize</param>
<param name="Type">Double</param>
@@ -69,36 +27,7 @@
</list>
<list name="Dependencies">
- <struct>
- <param name="Essential">True</param>
- <param name="Name">Swarm</param>
- <param name="Type">Swarm</param>
- <param name="Description">The swarm containing the particles to be plotted.</param>
- </struct>
- <struct>
- <param name="Essential">False</param>
- <param name="Name">ColourVariable</param>
- <param name="Type">SwarmVariable</param>
- <param name="Description">You may colour each of the dots with a colour derived from the value of from another SwarmVariable if you specify it here. A colour map must be specified as well. This will override the 'colour' given as a parameter. </param>
- </struct>
- <struct>
- <param name="Essential">No</param>
- <param name="Name">ColourMap</param>
- <param name="Type">lucColourMap</param>
- <param name="Description">This is the colour map to get the coresponding colour from the value of the ColourVariable at any particle. If no ColourVariable is specified then this colour map is not used.</param>
- </struct>
- <struct>
- <param name="Essential">False</param>
- <param name="Name">OpacityVariable</param>
- <param name="Type">SwarmVariable</param>
- <param name="Description">Sets the opacity of the dot according to a SwarmVariable.</param>
- </struct>
- <struct>
- <param name="Essential">False</param>
- <param name="Name">MaskVariable</param>
- <param name="Type">SwarmVariable</param>
- <param name="Description"></param>
- </struct>
+
</list>
<!-- Add an exmaple XML if possible -->
<param name="Example">gLucifer/DrawingObjects/tests/testSwarmViewer</param>
diff -r 3d5ccaddac1c -r 357744bd5367 DrawingObjects/src/SwarmViewerBase.meta
--- a/DrawingObjects/src/SwarmViewerBase.meta Tue Jul 17 05:43:47 2007 +0000
+++ b/DrawingObjects/src/SwarmViewerBase.meta Wed Jul 18 01:38:08 2007 +0000
@@ -6,96 +6,104 @@
<param name="Author">...</param>
<param name="Organisation">MCC</param>
<param name="Project">gLucifer</param>
-<param name="Location">./</param>
+<param name="Location">./gLucifer/DrawingObjects/src</param>
<param name="Project Web">http://mcc.monash.edu.au/gLucifer</param>
<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">...</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-->
<list name="Params">
+
<struct>
- <param name="Name">OpacityVariable</param>
+ <param name="Name">MaskType</param>
<param name="Type">String</param>
- <param name="Default">""</param>
- <param name="Description">...</param>
+ <param name="Default">GreaterThan</param>
+ <param name="Description">The type of mask that will be used. Options are: GreaterThan, LesserThen, EqualTo</param>
</struct>
<struct>
- <param name="Name">MaskVariable</param>
- <param name="Type">String</param>
- <param name="Default">""</param>
- <param name="Description">...</param>
+ <param name="Name">MaskValue</param>
+ <param name="Type">double</param>
+ <param name="Default">0.0</param>
+ <param name="Description">Value of the MaskType</param>
</struct>
+ <struct>
+ <param name="Name">MaskTolerance</param>
+ <param name="Type">double</param>
+ <param name="Default">0.001</param>
+ <param name="Description">Tolerance of the masking condition in the case it's a floating point operation.</param>
+ </struct>
+
<struct>
<param name="Name">drawParticleNumber</param>
<param name="Type">Bool</param>
<param name="Default">False</param>
- <param name="Description">...</param>
+ <param name="Description">Draw the particle IDs next each particle</param>
</struct>
<struct>
<param name="Name">sameParticleColour</param>
<param name="Type">Bool</param>
<param name="Default">False</param>
- <param name="Description">...</param>
+ <param name="Description">If set to True and drawParticleNumber is True as well, then display the partivcle number in ths same colour than the particle itself</param>
</struct>
<struct>
<param name="Name">subSetEvery</param>
<param name="Type">Int</param>
<param name="Default">1</param>
- <param name="Description">...</param>
+ <param name="Description">Display one particle every "subSetVery"</param>
</struct>
<struct>
<param name="Name">positionRange</param>
<param name="Type">Bool</param>
<param name="Default">False</param>
- <param name="Description">...</param>
+ <param name="Description">Set to true if you wish to set a position range, see below</param>
</struct>
<struct>
<param name="Name">minPositionX</param>
<param name="Type">Double</param>
<param name="Default">-100000.0</param>
- <param name="Description">...</param>
+ <param name="Description">Depened on positionRange and sets the volume this swarm viewer operates in</param>
</struct>
<struct>
<param name="Name">minPositionY</param>
<param name="Type">Double</param>
<param name="Default">-100000.0</param>
- <param name="Description">...</param>
+ <param name="Description">Depened on positionRange and sets the volume this swarm viewer operates in</param>
</struct>
<struct>
<param name="Name">minPositionZ</param>
<param name="Type">Double</param>
<param name="Default">-100000.0</param>
- <param name="Description">...</param>
+ <param name="Description">Depened on positionRange and sets the volume this swarm viewer operates in</param>
</struct>
<struct>
<param name="Name">maxPositionX</param>
<param name="Type">Double</param>
<param name="Default">100000.0</param>
- <param name="Description">...</param>
+ <param name="Description">Depened on positionRange and sets the volume this swarm viewer operates in</param>
</struct>
<struct>
<param name="Name">maxPositionY</param>
<param name="Type">Double</param>
<param name="Default">100000.0</param>
- <param name="Description">...</param>
+ <param name="Description">Depened on positionRange and sets the volume this swarm viewer operates in</param>
</struct>
<struct>
<param name="Name">maxPositionZ</param>
<param name="Type">Double</param>
<param name="Default">100000.0</param>
- <param name="Description">...</param>
+ <param name="Description">Depened on positionRange and sets the volume this swarm viewer operates in</param>
</struct>
<struct>
<param name="Name">pointSize</param>
<param name="Type">Double</param>
<param name="Default">1.0</param>
- <param name="Description">...</param>
+ <param name="Description">Size of particle dots</param>
</struct>
</list>
@@ -105,29 +113,32 @@
<param name="Essential">True</param>
<param name="Name">Swarm</param>
<param name="Type">Swarm</param>
- <param name="Description">...</param>
+ <param name="Description">The swarm containing the particles to be plotted.</param>
</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 217 of the c file and then remove this comment afterwards -->
-
+ <struct>
+ <param name="Essential">False</param>
+ <param name="Name">ColourVariable</param>
+ <param name="Type">SwarmVariable</param>
+ <param name="Description">You may colour each of the dots with a colour derived from the value of from another SwarmVariable if you specify it here. A colour map must be specified as well. This will override the 'colour' given as a parameter. </param>
+ </struct>
+ <struct>
+ <param name="Essential">False</param>
+ <param name="Name">OpacityVariable</param>
+ <param name="Type">SwarmVariable</param>
+ <param name="Description">Optional. This is the name of the swarm variable which will set the opacity of each particle</param>
+ </struct>
+ <struct>
+ <param name="Name">MaskVariable</param>
+ <param name="Type">String</param>
+ <param name="Default">""</param>
+ <param name="Description">Optional. If you wish to set a condition on viewing swarm output you use a mask. This is the name of the swarm variable on which the mask will act</param>
+ </struct>
<struct>
<param name="Essential">No</param>
<param name="Name">ColourMap</param>
<param name="Type">lucColourMap</param>
- <param name="Description">...</param>
+ <param name="Description">This is the colour map to get the coresponding colour from the value of the ColourVariable at any particle. If no ColourVariable is specified then this colour map is not used.</param>
</struct>
-
-<!-- PLEASE, check the above struct information is accurate, in line number 230 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 254 of the c file and then remove this comment afterwards -->
-
</list>
<!-- Add an exmaple XML if possible -->
More information about the CIG-COMMITS
mailing list