[cig-commits] commit: adding some details to meta files in glucifer/Base

Mercurial hg at geodynamics.org
Mon Nov 24 11:29:29 PST 2008


changeset:   67:44d00344570e
user:        RobertTurnbull
date:        Fri Aug 08 03:16:23 2008 +0000
files:       Base/src/Camera.meta Base/src/ColourMap.meta Base/src/DrawingObject.meta Base/src/InputFormat.h Base/src/InputFormat.meta Base/src/Light.c Base/src/Light.h Base/src/Light.meta Base/src/OutputFormat.meta Base/src/RenderingEngine.meta Base/src/Window.meta Base/src/WindowInteraction.meta Base/tests/plugins/RenderingEngineTest.meta
description:
adding some details to meta files in glucifer/Base


diff -r 3803ac3d1d83 -r 44d00344570e Base/src/Camera.meta
--- a/Base/src/Camera.meta	Thu Aug 07 02:40:31 2008 +0000
+++ b/Base/src/Camera.meta	Fri Aug 08 03:16:23 2008 +0000
@@ -3,7 +3,7 @@
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
 <param name="Name">lucCamera</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/Base/src/</param>
@@ -11,7 +11,7 @@
 <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">Stg_Component</param>
-<param name="Reference">...</param>
+<param name="Reference">N/A</param>
 <param name="Summary">...</param>
 <param name="Description">Contols how the user views the visualisation scene in a lucViewport.</param>
 
@@ -109,6 +109,12 @@
 	</struct>
 </list>
 <!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+		<struct name="camera" mergeType="replace">
+			<param name="Type">lucCamera</param>
+			<param name="CentreFieldVariable">TemperatureField</param>
+			<param name="coordZ">1.5</param>
+		</struct>
+</param>
 
 </StGermainData>
diff -r 3803ac3d1d83 -r 44d00344570e Base/src/ColourMap.meta
--- a/Base/src/ColourMap.meta	Thu Aug 07 02:40:31 2008 +0000
+++ b/Base/src/ColourMap.meta	Fri Aug 08 03:16:23 2008 +0000
@@ -3,7 +3,7 @@
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
 <param name="Name">lucColourMap</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/Base/src/</param>
@@ -11,13 +11,11 @@
 <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">Stg_Component</param>
-<param name="Reference">...</param>
+<param name="Reference">N/A</param>
 <param name="Summary">...</param>
 <param name="Description">Provides a way for lucDrawingObjects to map between scalar values and colours.</param>
 
 <!--Now the interesting stuff-->
-
-
 <list name="Params">
 	<struct>
 		<param name="Name">colours</param>
@@ -56,6 +54,12 @@
 
 </list>
 <!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+		<struct name="temperatureColourMap">
+			<param name="Type">lucColourMap</param>
+			<param name="colours">#0B0133 White #B7210B</param>
+			<param name="dynamicRange">true</param>
+		</struct>
+</param>
 
 </StGermainData>
diff -r 3803ac3d1d83 -r 44d00344570e Base/src/DrawingObject.meta
--- a/Base/src/DrawingObject.meta	Thu Aug 07 02:40:31 2008 +0000
+++ b/Base/src/DrawingObject.meta	Fri Aug 08 03:16:23 2008 +0000
@@ -3,7 +3,7 @@
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
 <param name="Name">lucDrawingObject</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/Base/src/</param>
@@ -11,7 +11,7 @@
 <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">Stg_Component</param>
-<param name="Reference">...</param>
+<param name="Reference">N/A</param>
 <param name="Summary">...</param>
 <param name="Description">An abstract class which sets up an interface for objects to be drawn inside viewports</param>
 
@@ -25,6 +25,6 @@
 
 </list>
 <!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">N/A.</param>
 
 </StGermainData>
diff -r 3803ac3d1d83 -r 44d00344570e Base/src/InputFormat.h
--- a/Base/src/InputFormat.h	Thu Aug 07 02:40:31 2008 +0000
+++ b/Base/src/InputFormat.h	Fri Aug 08 03:16:23 2008 +0000
@@ -86,7 +86,7 @@
 	void* _lucInputFormat_Copy( void* inputFormat, void* dest, Bool deep, Name nameExt, PtrMap* ptrMap ) ;
 
 	void* _lucInputFormat_DefaultNew( Name name ) ;
-void _lucInputFormat_Construct( void* inputFormat, Stg_ComponentFactory* cf, void* data ) ;
+	void _lucInputFormat_Construct( void* inputFormat, Stg_ComponentFactory* cf, void* data ) ;
 	void _lucInputFormat_Build( void* inputFormat, void* data );
 	void _lucInputFormat_Initialise( void* inputFormat, void* data );
 	void _lucInputFormat_Execute( void* inputFormat, void* data );
diff -r 3803ac3d1d83 -r 44d00344570e Base/src/InputFormat.meta
--- a/Base/src/InputFormat.meta	Thu Aug 07 02:40:31 2008 +0000
+++ b/Base/src/InputFormat.meta	Fri Aug 08 03:16:23 2008 +0000
@@ -11,7 +11,7 @@
 <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">Stg_Component</param>
-<param name="Reference">...</param>
+<param name="Reference">N/A.</param>
 <param name="Summary">...</param>
 <param name="Description">An abstract class to setup an interface to read in images to be used in lucDrawingObjects.</param>
 
@@ -26,6 +26,6 @@
 
 </list>
 <!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">N/A.</param>
 
 </StGermainData>
diff -r 3803ac3d1d83 -r 44d00344570e Base/src/Light.c
--- a/Base/src/Light.c	Thu Aug 07 02:40:31 2008 +0000
+++ b/Base/src/Light.c	Fri Aug 08 03:16:23 2008 +0000
@@ -198,12 +198,12 @@ void* _lucLight_Copy( void* light, void*
 
 	newLight->index    = self->index;
 	newLight->model    = self->model;
-	newLight->material =  self->material;	
+	newLight->material = self->material;	
 	
 
 	/*TODO*/
        	newLight->position[0] = self->position[0];
-	newLight->position[1] =self-> position[1];
+	newLight->position[1] = self-> position[1];
 	newLight->position[2] = self->position[2];
 	newLight->position[3] = self->position[3];
 	newLight->lmodel_ambient[0] = self->lmodel_ambient[0];
@@ -307,12 +307,12 @@ void lucLight_Pickle( void* light, Strea
 	Journal_Printf( stream, "<param name=\"posX\">%.5g</param>\n", self->position[ 0 ] );
 	Journal_Printf( stream, "<param name=\"posY\">%.5g</param>\n", self->position[ 1 ] );
 	Journal_Printf( stream, "<param name=\"posZ\">%.5g</param>\n", self->position[ 2 ] );	
-	Journal_Printf( stream, "<param name=\"posZ\">%.5g</param>\n", self->position[ 3 ] );
+	Journal_Printf( stream, "<param name=\"posW\">%.5g</param>\n", self->position[ 3 ] );
 
 	Journal_Printf( stream, "<param name=\"ambX\">%.5g</param>\n", self->lmodel_ambient[ 0 ] );
 	Journal_Printf( stream, "<param name=\"ambY\">%.5g</param>\n", self->lmodel_ambient[ 1 ]  );
 	Journal_Printf( stream, "<param name=\"ambZ\">%.5g</param>\n", self->lmodel_ambient[ 2 ]  );
-	Journal_Printf( stream, "<param name=\"ambZ\">%.5g</param>\n", self->lmodel_ambient[ 3 ]  );
+	Journal_Printf( stream, "<param name=\"ambW\">%.5g</param>\n", self->lmodel_ambient[ 3 ]  );
 
 	Journal_Printf( stream, "<param name=\"model\">%s</param>\n", 
 			self->model == GL_LIGHT_MODEL_LOCAL_VIEWER ? "Local" :
diff -r 3803ac3d1d83 -r 44d00344570e Base/src/Light.h
--- a/Base/src/Light.h	Thu Aug 07 02:40:31 2008 +0000
+++ b/Base/src/Light.h	Fri Aug 08 03:16:23 2008 +0000
@@ -96,12 +96,12 @@
 	void lucLight_InitAll( 
 		void*                                              light,
 		Light_Index                                        index,
-		int                                              model,
-		int                                              material,
-		float                                            position[4],
-		float                                            lmodel_ambient[4],
-		float                                            spotCutOff,
-		float                                            spotDirection[3]
+		int                                                model,
+		int                                                material,
+		float                                              position[4],
+		float                                              lmodel_ambient[4],
+		float                                              spotCutOff,
+		float                                              spotDirection[3]
 	 );
 	
 	/** Virtual Functions */
@@ -111,15 +111,15 @@
 	#define lucLight_Copy( self ) \
 		(lucLight*) Stg_Class_Copy( self, NULL, False, NULL, NULL )
 	void* _lucLight_DefaultNew( Name name ) ;
-void _lucLight_Construct( void* light, Stg_ComponentFactory* cf, void* data ) ;
+	void _lucLight_Construct( void* light, Stg_ComponentFactory* cf, void* data ) ;
 	void _lucLight_Build( void* light, void* data );
 	void _lucLight_Initialise( void* light, void* data );
 	void _lucLight_Execute( void* light, void* data );
 	void _lucLight_Destroy( void* light, void* data );
 
 	/** Public Functions */
-void lucLight_Position( void * light, int index, float posX, float posY, float posZ, float posW);
-void lucLight_Material( int material);
+	void lucLight_Position( void * light, int index, float posX, float posY, float posZ, float posW);
+	void lucLight_Material( int material);
 
 
 
diff -r 3803ac3d1d83 -r 44d00344570e Base/src/Light.meta
--- a/Base/src/Light.meta	Thu Aug 07 02:40:31 2008 +0000
+++ b/Base/src/Light.meta	Fri Aug 08 03:16:23 2008 +0000
@@ -3,7 +3,7 @@
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
 <param name="Name">lucLight</param>
-<param name="Author">...</param>
+<param name="Author">Cecile Duboz</param>
 <param name="Organisation">MCC</param>
 <param name="Project">gLucifer</param>
 <param name="Location">./</param>
@@ -11,7 +11,7 @@
 <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">Stg_Component</param>
-<param name="Reference">...</param>
+<param name="Reference">http://opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/lightmodel.html ...</param>
 <param name="Summary">...</param>
 <param name="Description">...</param>
 
@@ -47,25 +47,25 @@
 		<param name="Name">model</param>
 		<param name="Type">String</param>
 		<param name="Default">"TwoSide"</param>
-		<param name="Description">...</param>
+		<param name="Description">There are 3 options: 'Ambient', 'Local', 'TwoSide'</param>
 	</struct>
 	<struct>
 		<param name="Name">posX</param>
 		<param name="Type">Double</param>
 		<param name="Default">0.0</param>
-		<param name="Description">...</param>
+		<param name="Description">The X position of the light.</param>
 	</struct>
 	<struct>
 		<param name="Name">posY</param>
 		<param name="Type">Double</param>
 		<param name="Default">0.0</param>
-		<param name="Description">...</param>
+		<param name="Description">The Y position of the light.</param>
 	</struct>
 	<struct>
 		<param name="Name">posZ</param>
 		<param name="Type">Double</param>
 		<param name="Default">1.0</param>
-		<param name="Description">...</param>
+		<param name="Description">The Z position of the light.</param>
 	</struct>
 	<struct>
 		<param name="Name">posW</param>
diff -r 3803ac3d1d83 -r 44d00344570e Base/src/OutputFormat.meta
--- a/Base/src/OutputFormat.meta	Thu Aug 07 02:40:31 2008 +0000
+++ b/Base/src/OutputFormat.meta	Fri Aug 08 03:16:23 2008 +0000
@@ -3,7 +3,7 @@
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
 <param name="Name">lucOutputFormat</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/Base/src/</param>
@@ -11,7 +11,7 @@
 <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">Stg_Component</param>
-<param name="Reference">...</param>
+<param name="Reference">N/A</param>
 <param name="Summary">...</param>
 <param name="Description">An abstract class to setup an interface to output lucWindows in different formats.</param>
 
@@ -26,6 +26,6 @@
 
 </list>
 <!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">N/A.</param>
 
 </StGermainData>
diff -r 3803ac3d1d83 -r 44d00344570e Base/src/RenderingEngine.meta
--- a/Base/src/RenderingEngine.meta	Thu Aug 07 02:40:31 2008 +0000
+++ b/Base/src/RenderingEngine.meta	Fri Aug 08 03:16:23 2008 +0000
@@ -3,7 +3,7 @@
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
 <param name="Name">lucRenderingEngine</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/Base/src/</param>
@@ -11,7 +11,7 @@
 <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">Stg_Component</param>
-<param name="Reference">...</param>
+<param name="Reference">N/A</param>
 <param name="Summary">...</param>
 <param name="Description">An abstract class which sets up an interface to render lucViewports in a lucWindow, get the pixel information from the lucWindow and to composite parallel versions of lucViewport.</param>
 
@@ -26,6 +26,6 @@
 
 </list>
 <!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">N/A</param>
 
 </StGermainData>
diff -r 3803ac3d1d83 -r 44d00344570e Base/src/Window.meta
--- a/Base/src/Window.meta	Thu Aug 07 02:40:31 2008 +0000
+++ b/Base/src/Window.meta	Fri Aug 08 03:16:23 2008 +0000
@@ -3,7 +3,7 @@
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
 <param name="Name">lucWindow</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/Base/src/</param>
@@ -11,9 +11,9 @@
 <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">Stg_Component</param>
-<param name="Reference">...</param>
+<param name="Reference">N/A</param>
 <param name="Summary">...</param>
-<param name="Description">A collection of viewports that will be drawn in one window and written as one image at every dump output step.</param>
+<param name="Description">An abstract which which is a collection of viewports that will be drawn in one window and written as one image at every dump output step.</param>
 
 <!--Now the interesting stuff-->
 
@@ -79,6 +79,6 @@
 	</struct>	
 </list>
 <!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">N/A</param>
 
 </StGermainData>
diff -r 3803ac3d1d83 -r 44d00344570e Base/src/WindowInteraction.meta
--- a/Base/src/WindowInteraction.meta	Thu Aug 07 02:40:31 2008 +0000
+++ b/Base/src/WindowInteraction.meta	Fri Aug 08 03:16:23 2008 +0000
@@ -3,7 +3,7 @@
 <StGermainData xmlns="http://www.vpac.org/StGermain/XML_IO_Handler/Jun2003">
 
 <param name="Name">lucWindowInteraction</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/Base/src/</param>
@@ -11,7 +11,7 @@
 <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">Stg_Component</param>
-<param name="Reference">...</param>
+<param name="Reference">N/A</param>
 <param name="Summary">...</param>
 <param name="Description">A class setting up an interface through which the user can interact with the window through mouse and keyboard input. A default implementation is given with this class.</param>
 
@@ -22,6 +22,10 @@
 <list name="Dependencies">
 </list>
 <!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+		<struct name="defaultWindowInteraction">
+			<param name="Type">lucWindowInteraction</param>
+		</struct>
+</param>
 
 </StGermainData>
diff -r 3803ac3d1d83 -r 44d00344570e Base/tests/plugins/RenderingEngineTest.meta
--- a/Base/tests/plugins/RenderingEngineTest.meta	Thu Aug 07 02:40:31 2008 +0000
+++ b/Base/tests/plugins/RenderingEngineTest.meta	Fri Aug 08 03:16:23 2008 +0000
@@ -13,7 +13,7 @@
 <param name="Parent">lucRenderingEngine</param>
 <param name="Reference">...</param>
 <param name="Summary">...</param>
-<param name="Description">...</param>
+<param name="Description">An implementation of the lucRenderingEngine class which outputs a consistent colour pattern designed to test Output Format implementations.</param>
 
 <!--Now the interesting stuff-->
 
@@ -26,5 +26,9 @@
 
 </list>
 <!-- Add an exmaple XML if possible -->
-<param name="Example">...</param>
+<param name="Example">
+		<struct name="renderingEngine">
+				<param name="Type">lucRenderingEngineTest</param>
+		</struct>
+</param>
 



More information about the CIG-COMMITS mailing list