gLucifer Component Codex
This is a list of components available in gLucifer.
lucAxis
Organisation:
MCC
Project:
gLucifer
Location:
./
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Draws a set of X,Y,Z axis
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| colourX | String | "Red" | Sets the colour for the X axis |
| colourY | String | "Green" | Sets the colour for the Y axis |
| colourZ | String | "Blue" | Sets the colour for the Z axis |
| originX | Double | -0.5 | Sets the X origin of the axis set |
| originY | Double | 0.0 | Sets the Y origin of the axis set |
| originZ | Double | 0.0 | Sets the Z origin of the axis set |
| scale | Double | 1.0 | Scales the length of the x,y,z axis |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucCamera
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/Base/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Stg_Component
Children:
Description:
Contols how the user views the visualisation scene in a lucViewport.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| focalPointX | Double | 0.0 | The X component of the coordinate of the point that the camera is centred on. |
| focalPointY | Double | 0.0 | The Y component of the coordinate of the point that the camera is centred on. |
| focalPointZ | Double | 0.0 | The Z component of the coordinate of the point that the camera is centred on. |
| upDirectionX | Double | 0.0 | The X component of the vector which describes which direction is up for the camera. |
| upDirectionY | Double | 1.0 | The Y component of the vector which describes which direction is up for the camera. |
| upDirectionZ | Double | 0.0 | The Z component of the vector which describes which direction is up for the camera. |
| focalLength | Double | 0.0 | Parameter only used for stereo cameras. |
| coordX | Double | 0.0 | The X component of the coordinate of where the camera initially is in space. |
| coordY | Double | 0.0 | The Y component of the coordinate of where the camera initially is in space. |
| coordZ | Double | 1.0 | The Z component of the coordinate of where the camera initially is in space. |
| aperture | Double | 45.0 | The field-of-view angle, in degrees. |
| stereoType | String | "lucMono" | There are three options for how the camera behaves in stereo: lucMono (No stereo behaviour), lucStereoToeIn (simplified stereo behaviour), lucStereoAsymmetric (true stereo behaviour). |
| eyeSeparation | Double | 0.2 | If your camera is working in stereo, then this is distance between the "left eye" and the "right eye", otherwise this parameter is not used. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FieldVariable | No | If a CentreFieldVariable is specified, then it overrides the values given by the focalPoint[X,Y,Z] parameters and just sets the focal point to be the middle of the field given by this FieldVariable. | CentreFieldVariable |
lucCarbonWindow
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/Windowing/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
An implementation of the lucWindow class which works using the Macintosh Carbon API.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| offsetX | UnsignedInt | 50 | The horizontal distance from the top left corner of the screen to the window. |
| offsetY | UnsignedInt | 50 | The vertical distance from the top left corner of the screen to the window. |
| maxIdleTime | Double | 600.0 | The maximum time that the window can be open without user input. This is so that the user is warned when running the program with interactive turned on but without being aware. This feature isn't yet implemented properly for lucCarbonWindow. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucColourBar
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Draws a colour bar at the bottom of a viewport so that you can have a calibration scale of a particular lucColourMap.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| lengthFactor | Double | 0.8 | The proportion of the width of the viewport that you want the colour bar to fill. |
| height | UnsignedInt | 10 | The height of the colour bar in pixels |
| margin | UnsignedInt | 16 | The number of pixels between the bar and the colour bar. |
| borderWidth | Double | 1 | The thickness of the border around the colour bar. |
| precision | UnsignedInt | 2 | The decimal precision |
| scientific | Bool | False | If set to True, the annotation will be in scitnfic mode. |
| ticks | UnsignedInt | 0 | Number of ticks to be displayed on the colourbar. If the colourbar is divided in ten segments, it means 9 ticks. |
| printTickValue | Bool | False | If set to True, display the tick values. |
| scaleValue | float | 1.0 | Scale the displayed value by multiplying by the scaleValue number. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| lucColourMap | True | The lucColourMap that you want to have a calibration scale for | ColourMap |
lucColourBarInteraction
Organisation:
MCC
Project:
gLucifer
Location:
./
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucColourMap
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/Base/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Stg_Component
Children:
Description:
Provides a way for lucDrawingObjects to map between scalar values and colours.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| colours | String | "Blue;White;Red" | Creates a list of colours to be used to draw objects. The first colour mentioned corresponds to the minimum value being plotting and the last colour corresponds to the maximum value being plotting. The other colours are distributed evenly between these values. The Colour Map smoothly interpolates these colours together. These colour names must correspond to the X11 Colour map names (see http://en.wikipedia.org/wiki/X11_Color_Names) or be a hex colour triplet with a '#' at the start (see http://en.wikipedia.org/wiki/Hex_triplet). |
| minimum | Double | 0.0 | Sets the value for the colour at the first colour in the colour map to correspond to. |
| maximum | Double | 1.0 | Sets the value for the colour at the last colour in the colour map to correspond to. |
| logScale | Bool | False | If True, then the variation in colour happens to a logarithmic scale rather than a linear scale. |
| dynamicRange | Bool | False | If True, then this colour map can reset the minimum and maximum values to be appropriate to the FieldVariable or SwarmVariable that is is being used to draw, if False, then the original minimum and maximum values are used and never changed. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucContour
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Visualises a scalar field by the use of contour lines at specific intervals. It gets the value of the field on a grid and uses a 2D form of the Marching Cubes algorithm to draw the contours.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| resolution | UnsignedInt | 8 | The default value for the resolutionX, resolutionY and resolutionZ. If these values aren't set the sampling grid will be uniform with this number of verticies in each direction. |
| resolutionX | UnsignedInt | defaultResolution | The number of grid points in the X direction. |
| resolutionY | UnsignedInt | defaultResolution | The number of grid points in the Y direction. |
| resolutionZ | UnsignedInt | defaultResolution | The number of grid points in the Z direction. |
| colour | String | "black" | The colour of the contour lines. (If a lucColourMap is given - then this colour will not be used) |
| lineWidth | Double | 1.0 | The width of each contour line. |
| interval | Double | -1.0 | If this number if positive, contours will be drawn from the minimum value of the field to the maximum value of the field at this interval. If this number is negative, this feature will not be used. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FieldVariable | True | The field that you want to visualise with contour lines. | FieldVariable | |
| lucColourMap | No | You may colour each of the contour lines with a colour map if you specify it here. This will override the 'colour' given as a parameter. | ColourMap |
lucDrawingObject
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/Base/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Stg_Component
Description:
An abstract class which sets up an interface for objects to be drawn inside viewports
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucEigenvectors
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucEigenvectorsCrossSection
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| resolution | UnsignedInt | 8 | ... |
| resolutionX | UnsignedInt | defaultResolution | ... |
| resolutionY | UnsignedInt | defaultResolution | ... |
| resolutionZ | UnsignedInt | defaultResolution | ... |
| crossSection | String | "" | ... |
| dim | UnsignedInt | 2 | ... |
| leastColour | String | "black" | ... |
| middleColour | String | "black" | ... |
| greatestColour | String | "black" | ... |
| arrowHeadSize | Double | 0.3 | The size of the head of the arrow compared with the arrow length. Must be between [0, 1] |
| lengthScale | Double | 0.3 | ... |
| lineWidth | Double | 1.0 | ... |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FieldVariable | True | ... | TensorField |
lucEncoderLibavcodec
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/OutputFormats/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Encodes the output of a lucRenderingEngine into an MPEG movie.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| codec | String | mpeg1video | The encoding codec to use. For a full list see: http://www.mplayerhq.hu/DOCS/HTML/en/menc-feat-enc-libavcodec.html |
| frameRate | UnsignedInt | 25 | How many frames in the movie for second. |
| bitRate | UnsignedInt | 400000 | The quality of the encoded movie. |
| includeFrame0 | Bool | False | Whether or not to include the initial frame at timestep 0. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| lucWindow | True | The window to encode into a movie. | Window |
lucEncoderLibfame
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/OutputFormats/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Encodes the output of a lucRenderingEngine into an MPEG movie.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| keyframe | UnsignedInt | 4 | How often there is an intra-coded (JPEG-like) Key Frame compared to the general motion compressed frames. The smaller the number, the more frequent the Key Frames. |
| quality | UnsignedInt | 93 | A percentage which controls compression verses quality. |
| framesPerSecond | UnsignedInt | 30 | How many frames in the movie for second. |
| profile | String | "profile/mpeg1" | Encoding profile. Options are "profile/mpeg1" and "profile/mpeg4". |
| includeFrame0 | Bool | False | Whether or not to include the initial frame at timestep 0. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| lucWindow | True | The window to encode into a movie. | Window |
lucFeVariableSurface
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| colour | String | "black" | ... |
| wireframe | Bool | False | ... |
| lineWidth | Double | 1.0 | ... |
| scaleHeight | Double | 0.0 ) | ... |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FieldVariable | True | ... | FeVariable | |
| lucColourMap | No | ... | ColourMap |
lucFieldValueInteraction
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/InputFormats/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucFieldVariableBorder
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Draws a border around a FieldVariable so that it stands out against the background. - Currently this will only work for fields with a cartesian geometry.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| colour | String | "Black" | The colour of the border. |
| lineWidth | Double | 1.0 | The width of each line making up the border. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FieldVariable | True | The field variable used to get the size of the box of the model. | FieldVariable |
lucHistoricalSwarmTrajectory
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| colour | String | "black" | ... |
| lineWidth | Double | 1.0 ) | ... |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| Swarm | True | ... | Swarm | |
| lucColourMap | No | ... | ColourMap |
lucInputFormat
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/Base/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Stg_Component
Description:
An abstract class to setup an interface to read in images to be used in lucDrawingObjects. Each concrete Input Format class should be added to the lucInputFormat_Register which works out which lucInputFormat to use when opening an image through its extension. e.g. Image.ppm will be opened by the lucInputPPM class.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucInputPPM
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/InputFormats/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
This reads PPM files, ready to be used by another component. This component is placed on the lucInputFormat_Register so that any files with a .ppm extension will use this component to open.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucInputTIFF
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/InputFormats/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
This reads TIFF files, ready to be used by another component. This component is placed on the lucInputFormat_Register so that any files with a .ppm extension will use this component to open. This component is only compiled if you have libtiff installed.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucIsosurface
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Visualises a scalar field in 3D by the use of a surface over which all the values of the field are constant (an isosurface). It gets the value of the field on a 3D grid and uses the Marching Cubes algorithm to construct the surface. This algorithm is described in Lorensen, William and Harvey E. Cline. Marching Cubes: A High Resolution 3D Surface Construction Algorithm. Computer Graphics (SIGGRAPH 87 Proceedings) 21(4) July 1987, p. 163-170)
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| resolution | UnsignedInt | 64 | The default value for the resolutionX, resolutionY and resolutionZ. If these values aren't set the sampling grid will be uniform with this number of verticies in each direction. |
| resolutionX | UnsignedInt | defaultResolution | The number of grid points in the X direction. |
| resolutionY | UnsignedInt | defaultResolution | The number of grid points in the Y direction. |
| resolutionZ | UnsignedInt | defaultResolution | The number of grid points in the Z direction. |
| isovalue | Double | 0.0 | The value of the scalar field on the surface. |
| drawWalls | Bool | False | This will create an closed surface by drawing shapes along the side walls of the box. |
| wireframe | Bool | False | This draws only the triangle edges of the surface and not as solid shapes. |
| cullFrontFace | Bool | False | This tells OpenGL to not draw the front face of each triangle. |
| cullBackFace | Bool | False | This tells OpenGL to not draw the back face of each triangle. |
| colour | String | "White" | The colour of the isosurface. (If a lucColourMap is given - then this colour will not be used) |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FieldVariable | True | The field that you want to visualise with an isosurface. | IsosurfaceField | |
| lucColourMap | No | You may colour each of the verticies of the isosurface with a colour map if you specify it here. This will override the 'colour' given as a parameter. | ColourMap | |
| FieldVariable | No | This is the field used to colour the isosurface if a lucColourMap is specified. If This is not given, the IsosurfaceField will be used instead. | ColourField | |
| FieldVariable | No | ... | MaskField |
lucLight
Organisation:
MCC
Project:
gLucifer
Location:
./
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Stg_Component
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| ambX | Double | 0.2 | ... |
| ambY | Double | 0.2 | ... |
| ambZ | Double | 0.2 | ... |
| ambW | Double | 1.0 | ... |
| model | String | "TwoSide" | There are 3 options: 'Ambient', 'Local', 'TwoSide' |
| posX | Double | 0.0 | The X position of the light. |
| posY | Double | 0.0 | The Y position of the light. |
| posZ | Double | 1.0 | The Z position of the light. |
| posW | Double | 0.0 | ... |
| material | String | "lucMono" | ... |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucLightInteraction
Organisation:
MCC
Project:
gLucifer
Location:
./
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucLight_Register
Organisation:
MCC
Project:
gLucifer
Location:
./
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucMeshViewer
Organisation:
MCC
Project:
gLucifer
Location:
./
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Allows to diaply a mesh, using different coloutr for the different node categories (local, shadow..)
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| localColour | String | "Black" | Colour used to draw the local nodes |
| shadowColour | String | "Blue" | Colour used to draw the Shadow nodes |
| vacantColour | String | "Grey" | Colour used to draw the vacant nodes |
| nodeNumbers | Bool | False | If true, all the nodes numbers will be drawn |
| elementNumbers | Bool | False | if True, all the element numbers will be drawn |
| displayNodes | Bool | False | If true, the nodes will appear as small squares |
| colour | String | "black" | general colour used if the other ones are not set |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| Mesh | True | Mesh to draw | Mesh |
lucMeshViewerInteraction
Organisation:
MCC
Project:
gLucifer
Location:
./
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Allows to print out node or element number by positioning the mouse on the desired spot and pressing 'n' for the node number, 'e' for the element number
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucOSMesaWindow
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/Windowing/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
An offscreen implementation of lucWindow which only needs OSMesa installed and nothing else needs to be running. OSMesa is avaiable on Mac, linux and windows.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucOpenGLDrawingObject
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
-
lucAxis
-
lucContour
-
lucEigenvectorsCrossSection
-
lucFeVariableSurface
-
lucFieldVariableBorder
-
lucHistoricalSwarmTrajectory
-
lucIsosurface
-
lucMeshViewer
-
lucScalarFieldCrossSection
-
lucScalarFieldOnMeshCrossSection
-
lucSwarmRGBColourViewer
-
lucSwarmViewerBase
-
lucTextureMap
-
lucTimeStep
-
lucTitle
-
lucVectorArrowCrossSection
Description:
An abstract class to setup specific things to do with an OpenGL Drawing Object
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucOutputFormat
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/Base/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Stg_Component
Children:
Description:
An abstract class to setup an interface to output lucWindows in different formats.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucOutputJPEG
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/OutputFormats/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Outputs an image rendered in a lucRenderingEngine as a JPEG. Only is compiled if libjpeg is installed.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| quality | Int | 93 | The quality setting of the encoder. A percentage. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucOutputPNG
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/OutputFormats/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Outputs an image rendered in a lucRenderingEngine as a compressed PNG. Only is compiled if libpng is installed.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucOutputPPM
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/OutputFormats/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Outputs an image rendered in a lucRenderingEngine as a PPM. PPM is a very basic image format without any compression.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucOutputTIFF
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/OutputFormats/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Outputs an image rendered in a lucRenderingEngine as a TIFF. This component is only compiled if you have libtiff installed.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucOutputVECTOR
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/OutputFormats/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
output format which utilises GL2PS library to capture the openGL feedback buffer, and convert to a vector image of you specification.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| Format | String | ps | Format for output file. Currently supported formats are svg, ps, eps, pdf. |
| Buffersize | UnsignedInt | 16777216 | Buffersize for openGL feedback buffer. Current set at rather arbitrary value, that should be sufficient. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucRenderingEngine
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/Base/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Stg_Component
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.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucRenderingEngineGL
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/RenderingEngines/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
An implementation of the lucRenderingEngine Class that uses OpenGL
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucRenderingEngineTest
Organisation:
MCC
Project:
gLucifer
Location:
./
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
An implementation of the lucRenderingEngine class which outputs a consistent colour pattern designed to test Output Format implementations.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucSDLWindow
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/Windowing/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
An implementation of the lucWindow class which works using the SDL library, which is avaiable for linux, mac and windows.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucScalarField
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Tiles the side walls of the model with colours derived from the value of a scalar field at the vertex of each tile.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| cullFace | Bool | True | If this is False, all walls of the box will be drawn and you will not be able to see insdie the box. If this is true, only the far walls of the box will be drawn, allowing other things in the box to be visualised. In 2D this feature is ignored. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucScalarFieldCrossSection
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Description:
Tiles a plane with colours derived from the value of a scalar field at the vertex of each tile.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| resolution | UnsignedInt | 128 | The default value for the resolutionX, resolutionY and resolutionZ. If these values aren't set the sampling grid will be uniform with this number of verticies in each direction. |
| resolutionX | UnsignedInt | defaultResolution | The number of sample points in the X direction. |
| resolutionY | UnsignedInt | defaultResolution | The number of sample points in the Y direction. |
| resolutionZ | UnsignedInt | defaultResolution | The number of sample points in the Z direction. |
| crossSection | String | "" | The description of the plane in the format: "axis=value". e.g. x=1.5 will descrive a Y-Z plane where the X coordinate is 1.5. The axis is case insensitive. |
| minCropX | Double | -infinity | The minimum x value that it'll plot for this cross-secion. |
| minCropY | Double | -infinity | The minimum y value that it'll plot for this cross-secion. |
| minCropZ | Double | -infinity | The minimum z value that it'll plot for this cross-secion. |
| maxCropX | Double | +infinity | The maximum x value that it'll plot for this cross-secion. |
| maxCropY | Double | +infinity | The maximum y value that it'll plot for this cross-secion. |
| maxCropZ | Double | +infinity | The maximum z value that it'll plot for this cross-secion. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FieldVariable | True | The scalar field that you wish visualise with these tiles. | FieldVariable | |
| lucColourMap | True | The colour map to find calculate what colour to use for the scalar value of the field for each sample point. | ColourMap |
lucScalarFieldOnMesh
Organisation:
MCC
Project:
gLucifer
Location:
./
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| cullFace | Bool | True ) | ... |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucScalarFieldOnMeshCrossSection
Organisation:
MCC
Project:
gLucifer
Location:
./
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| FieldVariable | String | "defaultName" | ... |
| resolution | UnsignedInt | 128 | ... |
| resolutionX | UnsignedInt | defaultResolution | ... |
| resolutionY | UnsignedInt | defaultResolution | ... |
| resolutionZ | UnsignedInt | defaultResolution | ... |
| crossSection | String | "" | ... |
| minCropX | Double | -HUGE_VAL | ... |
| minCropY | Double | -HUGE_VAL | ... |
| minCropZ | Double | -HUGE_VAL | ... |
| maxCropX | Double | +HUGE_VAL | ... |
| maxCropY | Double | +HUGE_VAL | ... |
| maxCropZ | Double | +HUGE_VAL | ... |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FieldVariable | True | ... | FieldVariable | |
| lucColourMap | True | ... | ColourMap | |
| FieldVariable | True | ... | self->fieldVariableName |
lucSwarmRGBColourViewer
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
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 ?
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| ColourRedVariable | String | "" | ... |
| ColourGreenVariable | String | "" | ... |
| ColourBlueVariable | String | "" | ... |
| OpacityVariable | String | "" | ... |
| MaskVariable | String | "" | ... |
| colour | String | "black" | ... |
| pointSize | Double | 1.0 | ... |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| Swarm | True | ... | Swarm | |
| lucColourMap | No | ... | ColourMap | |
| Material | No | ... | Material |
lucSwarmSquares
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Plots a square on each of the particles in a swarm.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| length | Double | 0.2 | This is a factor to scale the size of the squares by. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| SwarmViewer | True | This is the vector quantity to define the normal for the square drawn on each particle. | NormalVariable | |
| SwarmViewer | True | This is a scalar quantity used to scale the length of the squares. This overrides the value of the 'length' parameter. | LengthVariable |
lucSwarmVectors
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Plots a vector quantity on particles in a swarm as arrows.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| arrowHeadSize | Double | 0.3 | The size of the head of the arrow compared with the arrow length. Must be between [0, 1] |
| thickness | Double | 1.0 | The default thickness of the arrows. This can be overridden by the ThicknessVariable |
| length | Double | 0.2 | This is a factor to scale the size of the arrows by. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| SwarmViewer | True | This is the vector quantity represented as arrows. | DirectionVariable | |
| SwarmViewer | False | This is a scalar quantity used to get the thickness of the vectors. This overrides the value of the 'thickness' parameter. | ThicknessVariable | |
| SwarmViewer | False | This is a scalar quantity used to scale the length of the vectors. This overrides the value of the 'length' parameter. | LengthVariable |
lucSwarmViewer
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Description:
Plots particles in a particular swarm as individual dots.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| pointSize | Double | 1.0 | The size of the points to be plotted. |
| pointSmoothing | Bool | 0 | 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 |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucSwarmViewerBase
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Description:
SwarmViewerBase is an abstract class. It provides the main functionaily for a variable on a Swarm to be viewed as output.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| MaskType | String | GreaterThan | The type of mask that will be used. Options are: GreaterThan, LesserThen, EqualTo |
| MaskValue | double | 0.0 | Value of the MaskType |
| MaskTolerance | double | 0.001 | Tolerance of the masking condition in the case it's a floating point operation. |
| drawParticleNumber | Bool | False | Draw the particle IDs next each particle |
| sameParticleColour | Bool | False | If set to True and drawParticleNumber is True as well, then display the partivcle number in ths same colour than the particle itself |
| subSetEvery | Int | 1 | Display one particle every "subSetVery" |
| positionRange | Bool | False | Set to true if you wish to set a position range, see below |
| minPositionX | Double | -100000.0 | Depened on positionRange and sets the volume this swarm viewer operates in |
| minPositionY | Double | -100000.0 | Depened on positionRange and sets the volume this swarm viewer operates in |
| minPositionZ | Double | -100000.0 | Depened on positionRange and sets the volume this swarm viewer operates in |
| maxPositionX | Double | 100000.0 | Depened on positionRange and sets the volume this swarm viewer operates in |
| maxPositionY | Double | 100000.0 | Depened on positionRange and sets the volume this swarm viewer operates in |
| maxPositionZ | Double | 100000.0 | Depened on positionRange and sets the volume this swarm viewer operates in |
| pointSize | Double | 1.0 | Size of particle dots |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| Swarm | True | The swarm containing the particles to be plotted. | Swarm | |
| SwarmVariable | False | 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. | ColourVariable | |
| SwarmVariable | False | Optional. This is the name of the swarm variable which will set the opacity of each particle | OpacityVariable | |
| String | False | 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 | MaskVariable | |
| lucColourMap | No | 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. | ColourMap |
lucSwarmViewerInteraction
Organisation:
MCC
Project:
gLucifer
Location:
./
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
...
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucTextureMap
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Draws an image in your rendered scene.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| image | String | "" | The path to the image that you wish to draw. |
| bottomLeftX | Double | 0.0 | The X value of the scene coordinate of the bottom left corner of the image. |
| bottomLeftY | Double | 0.0 | The Y value of the scene coordinate of the bottom left corner of the image. |
| bottomLeftZ | Double | 0.0 | The Z value of the scene coordinate of the bottom left corner of the image. |
| bottomRightX | Double | 0.0 | The X value of the scene coordinate of the bottom right corner of the image. |
| bottomRightY | Double | 0.0 | The Y value of the scene coordinate of the bottom right corner of the image. |
| bottomRightZ | Double | 0.0 | The Z value of the scene coordinate of the bottom right corner of the image. |
| topRightX | Double | 0.0 | The X value of the scene coordinate of the top right corner of the image. |
| topRightY | Double | 0.0 | The Y value of the scene coordinate of the top right corner of the image. |
| topRightZ | Double | 0.0 | The Z value of the scene coordinate of the top right corner of the image. |
| topLeftX | Double | 0.0 | The X value of the scene coordinate of the top left corner of the image. |
| topLeftY | Double | 0.0 | The Y value of the scene coordinate of the top left corner of the image. |
| topLeftZ | Double | 0.0 | The Z value of the scene coordinate of the top left corner of the image. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucTimeStep
Organisation:
MCC
Project:
gLucifer
Location:
./
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Allows to display the accumulated time and the frame number
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| colour | String | "Black" | Colour used to draw the time and frame number |
| frame | Bool | True | If True, draws the frame number |
| time | Bool | False | If True, draws the accumuleted time |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucTitle
Organisation:
MCC
Project:
gLucifer
Location:
./
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Allows to diaply a title
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| colour | String | "Black" | Colour used to draw the title |
| string | String | "NULL" | String that will constitute the title. If this string is NULL, then the striong used by default is the viewport's name |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucVectorArrowCrossSection
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Description:
Samples the values of a vector field in a plane and draws arrows to represent the direction and scaled to represent the magnitude.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| resolution | UnsignedInt | 8 | The default value for the resolutionX, resolutionY and resolutionZ. If these values aren't set the sampling grid will be uniform with this number of verticies in each direction. |
| resolutionX | UnsignedInt | defaultResolution | The number of sample points in the X direction. |
| resolutionY | UnsignedInt | defaultResolution | The number of sample points in the Y direction. |
| resolutionZ | UnsignedInt | defaultResolution | The number of sample points in the Z direction. |
| crossSection | String | "" | The description of the plane in the format: "axis=value". e.g. x=1.5 will descrive a Y-Z plane where the X coordinate is 1.5. The axis is case insensitive. |
| colour | String | "black" | The colour of each arrow. |
| arrowHeadSize | Double | 0.3 | The size of the head of the arrow compared with the arrow length. Must be between [0, 1] |
| maximum | Double | 1.0 | This sets the value of the fieldVariable magnitude that is used as the maximum for vector arrow length scaling purposes, if dynamicRange=False. Eg a maximum of 2.0 means that field vectors of length 2 would result in the maximum length arrows. |
| dynamicRange | Bool | True | If false, this says to use the user-provided "maximum" parameter as the maximum for scaling purposes. If true, the maximum arrow length scale will by dynamically calculated from the maximum of the field being visualised, each timestep. |
| lengthScale | Double | 0.3 | This is a factor to scale the size of the arrows by. |
| lineWidth | Double | 1.0 | The width of the lines for each arrow. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| FieldVariable | True | The vector field that you wish to represent with arrows. | VectorVariable |
lucVectorArrows
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/DrawingObjects/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
Samples the values of a vector field in a grid and draws arrows to represent the direction and scaled to represent the magnitude.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucViewport
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/Base/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Stg_Component
Children:
Description:
Describes a scene of several lucDrawingObjects which is drawn in a subset of a lucWindow
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| drawTitle | Bool | True | If True, then the textual name of this viewport will be drawn at the top of the viewport. |
| compositeEachObject | Bool | False | If True, then when this viewport will be compositied between each object being drawn. This means the rendering will be slower but the order of the drawing of the objects will be conserved. If False, then the compositing will happen after all the objects have been drawn. |
| nearClipPlane | Double | 0.1 | Specifies the distance from the camera to the near clipping plane, in front of which nothing will be drawn. |
| farClipPlane | Double | 40.0 | Specifies the distance from the camera to the far clipping plane, behind which nothing will be drawn. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| lucCamera | True | The camera from which every drawing object in the viewport will be viewed from. | Camera | |
| lucDrawingObject | True | A list of drawing objects that will be drawn in this viewport. | DrawingObject |
lucWindow
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/Base/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Stg_Component
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.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| width | UnsignedInt | 400 | The horizontal length of the window. |
| height | UnsignedInt | 400 | The vertical length of the window. |
| backgroundColour | String | "white" | The colour that will fill the window before the viewports are drawn. |
| interactive | Bool | False | If True, then the window will pop up and the user can interact with it before the image is saved and the calculation continues. If False, then the window will render, the image will save and the calculation will continue without hesitation. Some implementations of lucWindow may pop up a window even for non-interactive windows and others may not have an interactive mode at all. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|---|---|---|---|
| lucViewport | True | A list of viewports to be drawn in this window. These must be given in order of them laid out in the window. For each line entered in the list, each viewport mentioned in that line will be laid out in a horizontal row (See wiki page for example). | Viewport | |
| AbstractContext | True | The window needs information about the context so that it can attach itself onto the AbstractContext_EP_DumpClass entry point. | context | |
| lucRenderingEngine | True | The rendering engine that you want to render the viewports in this window. | RenderingEngine | |
| lucOutputFormat | True | A list of formats that you want the final images to be saved in. For each output format registered on a window, an image will be created with the name ./OUTPUT_PATH/WINDOW_NAME.TIMESTEP.EXTENSION (e.g. ./output/window.00050.png). | OutputFormat | |
| lucWindowInteraction | True | A list of window interaction objects that you want to use with this window. The default lucWindowInteraction will be created with each lucWindow and registered automatically. | WindowInteraction |
lucWindowInteraction
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/Base/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Stg_Component
Children:
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.
Example:
Params
| Name | Type | Default | Description |
|---|
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|
lucX11Window
Organisation:
MCC
Project:
gLucifer
Location:
./gLucifer/Windowing/src/
Project Web:
http://mcc.monash.edu.au/gLucifer
Copyright:
Copyright (c) 2005, Monash Cluster Computing
License:
http://www.opensource.org/licenses/bsd-license.php
Parent:
Children:
Description:
An implementation of the lucWindow class which works using the X11 windowing system.
Example:
Params
| Name | Type | Default | Description |
|---|---|---|---|
| xFontName | String | "-adobe-courier-bold-r-normal--14-140-75-75-m-90-iso8859-1" | The name of the font to be used for writing text. |
| host | String | "localhost" | The name of the machine that you want the window displayed on. |
| displayNumber | UnsignedInt | 0 | The number of which display you want the window on. |
| displayScreen | UnsignedInt | 0 | The number of which screen you want the window on. |
| maxIdleTime | Double | 600.0 | The maximum time that the window can be open without user input. This is so that the user is warned when running the program with interactive turned on but without being aware. |
Dependencies
| Type | Essential | Description | Name | FallbackKey |
|---|