[cig-commits] commit: Updated some of the documentation meta files for the Swarm viewers

[Mercurial]

changeset:   40:95a89a4ff012
user:        LouisMoresi
date:        Thu Nov 22 01:08:41 2007 +0000
files:       DrawingObjects/src/SwarmRGBColourViewer.c DrawingObjects/src/SwarmRGBColourViewer.meta DrawingObjects/src/SwarmViewerBase.meta ModelComponents/window.xml
description:
Updated some of the documentation meta files for the Swarm viewers


diff -r 6a8564968fcd -r 95a89a4ff012 DrawingObjects/src/SwarmRGBColourViewer.c
--- a/DrawingObjects/src/SwarmRGBColourViewer.c	Tue Nov 06 04:15:09 2007 +0000
+++ b/DrawingObjects/src/SwarmRGBColourViewer.c	Thu Nov 22 01:08:41 2007 +0000
@@ -194,9 +194,9 @@ void _lucSwarmRGBColourViewer_Build( voi
 void _lucSwarmRGBColourViewer_Build( void* drawingObject, void* data ) {}
 
 void _lucSwarmRGBColourViewer_Initialise( void* drawingObject, void* data ) {
-	lucSwarmRGBColourViewer*          self                   = (lucSwarmRGBColourViewer*)drawingObject;
-	SwarmVariable_Register*  swarmVariable_Register = self->swarm->swarmVariable_Register;
-	Stream*                  errorStr               = Journal_Register( Error_Type, self->type );
+	lucSwarmRGBColourViewer*	self                   = (lucSwarmRGBColourViewer*)drawingObject;
+	SwarmVariable_Register*  	swarmVariable_Register = self->swarm->swarmVariable_Register;
+	Stream*                  	errorStr               = Journal_Register( Error_Type, self->type );
 
 	_lucSwarmViewer_Initialise( self, data );
 
diff -r 6a8564968fcd -r 95a89a4ff012 DrawingObjects/src/SwarmRGBColourViewer.meta
--- a/DrawingObjects/src/SwarmRGBColourViewer.meta	Tue Nov 06 04:15:09 2007 +0000
+++ b/DrawingObjects/src/SwarmRGBColourViewer.meta	Thu Nov 22 01:08:41 2007 +0000
@@ -13,14 +13,26 @@
 <param name="Parent">lucOpenGLDrawingObject</param>
 <param name="Reference">...</param>
 <param name="Summary">...</param>
-<param name="Description">...</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>
 
 <!--Now the interesting stuff-->
 
 
 <list name="Params">
 	<struct>
-		<param name="Name">ColourVariable</param>
+		<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>
diff -r 6a8564968fcd -r 95a89a4ff012 DrawingObjects/src/SwarmViewerBase.meta
--- a/DrawingObjects/src/SwarmViewerBase.meta	Tue Nov 06 04:15:09 2007 +0000
+++ b/DrawingObjects/src/SwarmViewerBase.meta	Thu Nov 22 01:08:41 2007 +0000
@@ -128,6 +128,7 @@
 		<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="Essential">False</param>
 		<param name="Name">MaskVariable</param>
 		<param name="Type">String</param>
 		<param name="Default">""</param>
diff -r 6a8564968fcd -r 95a89a4ff012 ModelComponents/window.xml
--- a/ModelComponents/window.xml	Tue Nov 06 04:15:09 2007 +0000
+++ b/ModelComponents/window.xml	Thu Nov 22 01:08:41 2007 +0000
@@ -22,6 +22,7 @@
 			<param name="height">400</param>
 			<param name="width">800</param>
 			<param name="backgroundColour">white</param>
+			<param name="interactive"> False </param>
 			<param name="xFontName">-adobe-helvetica-bold-r-normal--14-140-75-75-p-82-iso8859-1</param>
 		</struct>
 		<!-- If you want to add the movie functionality please add