Table of Contents
Scripting/scripting::scalarField2D     Scripting/scripting::scalarField2D::load     Scripting/scripting::scalarField2D::configure     Scripting/scripting::scalarField2D::render

Generated from scriptingScalarField2D.tcl with ROBODoc v3.2.4 on Wed May 25 16:04:51 2005

---

Scripting/scripting::scalarField2D

NAME

 scripting::scalarField2D

PURPOSE

 Encapsulate the scripting interface for manipulating the 2D scalar
 field and display of isosurfaces and colorplane+contour plots. A
 typical usage of the interface is the following. First the scalar
 field is loaded with the "load" command. Then with the "configure"
 command the isosurface and/or contours display parameters are set.
 Finally the isosurface and/or contours are displayed using the
 "render" command. It is possible to make several snapshots of
 isosurface and/or contours by changing configuration options, this
 would look as:

 load
 configure ...
 render
 configure ..
 render
 ...

COMMANDS

 -- scripting::scalarField2D::load
 Loads the scalar field.

 -- scripting::scalarField2D::configure
 Configure the display parameters for isosurface and/or contours
 plot.

 -- scripting::scalarField2D::render
 Renders the sosurface and/or contours.
***

---

Scripting/scripting::scalarField2D::load

NAME

 scripting::scalarField2D::load

USAGE

 scripting::scalarField2D::load

PURPOSE

 This proc load the 2D scalar field.

RETURN VALUE

 Undefined.

EXAMPLE

 scripting::scalarField2D::load

---

Scripting/scripting::scalarField2D::configure

NAME

 scripting::scalarField2D::configure

USAGE

 scripting::scalarField2D::configure -option value ?-option value? ...

PURPOSE

 This proc configures the display parameters of colorplane/contours
 plot.

ARGUMENTS

 args -- various configuration "-option value" pairs (see Options).

OPTIONS

 ------------------------------------------------------------------------
   OPTION::                 ALLOWED-VALUES + Description        
 ------------------------------------------------------------------------
   -interpolation_degree    integer                            
                            degree of scalar-field interpolation

   -colorbasis              MONOCHROME|RAINBOW|RGB|GEOGRAPHIC|BLUE-WHITE-RED|BLACK-BROWN-WHITE
                            the color basis for the colorplane

   -scalefunction           LINEAR|LOG10|SQRT|3th-ROOT|EXP(x)|EXP(x^2)
                            the scalefunctions for contour/colorplane plots

   -expand2D                none|whole|specify
                            none = do not expand the contour/colorplane plots
                                   along the periodic directions
                            whole = expand the contour/colorplane plots
                                    over the whole structure along the 
                                    periodic directions
                            specify = expand the contour/colorplane plots
                                    along the periodic directions as specified
                                    by -expand2D_X, -expand2D_Y, and 
                                    -expand2D_Z factors

   -expand2D_X              positive-integer
                            expand  contour/colorplane n-times along the 1st
                            periodic dimension


   -expand2D_Y              positive-integer
                            expand  contour/colorplane n-times along the 2nd
                            periodic dimension

   -expand2D_Z              positive-integer
                            expand  contour/colorplane n-times along the 3rd
                            periodic dimension

   -colorplane              0|1
                            do not display|display the colorplane

   -isoline                 0|1
                            do not display|display the isolines
             
   -colorplane_lighting     0|1
                            0 = do not perform lighting for colorplane
                            1 = perform lighting for colorplane

   -cpl_transparency        0|1
                            0 = render colorplane as non-transparent
                            1 = render colorplane as transparent

   -cpl_thermometer         0|1
                            0 = do not make a legend (i.e. thermometer) for 
                                colorplane colors
                            1 = make a legend (i.e. thermometer) for 
                                colorplane colors

   -2Dlowvalue              real
                            minimum rendered value of colorplane/isolines

   -2Dhighvalue             real
                            maximum rendered value of colorplane/isolines
              
   -2Dnisoline              positive-integer
                            number of isoline

   -isoline_color           monocolor|{property color}
                            monocolor = all isolines have the same color
                            {property color} = isolines are colorer according
                            to color-basis

   -isoline_width           positive-integer
                            width (i.e. thickness) of isolines

   -isoline_monocolor       #rgb
                            color of the monolor-type isolines

 ------------------------------------------------------------------------

RETURN VALUE

 Undefined.
 

EXAMPLE

 scripting::scalarField2D::configure \
     -interpolation_degree 2 \
     -colorbasis           RAINBOW \
     -scalefunction        LOG10 \
     -expand2D             specify \
     -expand2D_X            1 \
     -expand2D_Y           1 \
     -expand2D_Z           1 \
     -colorplane           1 \
     -isoline              1 \
     -colorplane_lighting  0 \
     -cpl_transparency     0 \
     -cpl_thermometer      1 \
     -2Dlowvalue           +0.00001 \
     -2Dhighvalue          +0.1 \
     -2Dnisoline           5 \
     -isoline_color        monocolor \
     -isoline_width        3 \
     -isoline_monocolor    \#ffffff

---

Scripting/scripting::scalarField2D::render

NAME

 scripting::scalarField2D::render

USAGE

 scripting::scalarField2D::render

PURPOSE

 This proc displays the contours or colorplane or both (depending on
 the configuration).

RETURN VALUE

 Undefined.

EXAMPLE

 scripting::scalarField2D::render