Description | Example | Return message | Group

VO VolumetricGfx

Define the 3d graphics properties of a volumetric object.

Syntax

VO <VolumetricPath> VolumetricGfx {{GfxOptions} | {Legend Options}}

Related commands

Description

Set the 3d graphics properties of a volumetric object, to refine how the volumetric appears in the 3D Graphics display.

Either {GfxOptions} or {Legend Options} can be set on each command. The description of {Legend Options} can be found below after the {GfxOptions}.

Attribute Options

Set options to enhance the 3D graphics properties.

{GfxOptions}Description
ShowAll {On | Off}Show or hide all 3D Graphics, including Grid, Volume, and Cross Sections.
Smoothing {On | Off}Set On to smooth out the volume and surface boundaries using interpolation between grid points.
Shading {On | Off}Set On to add shading to the boundary surface. Shading slows down animation but generates helpful lighting effects based on surfaces.
Quality {Low | Medium | High | VeryHigh}Set the quality of the graphics display. Higher quality slows down the animation but reduces the fuzziness of boundaries and increases the density of filled colors.

Grid Options

Set options to set the volumetric grid display.

{GfxOptions}Description
ShowGrid {On | Off}Show or hide the grid.
ShowGridPoints {On | Off}Show or hide the grid points.
PointSize <Size>Set the grid point size. Valid value is between 1 and 20.
PointColor {Color}Set the color of the grid points.
ShowGridLines {On | Off}Show or hide the grid lines.
LineColor {Color}Set the color of the grid line.

For valid {Color} options see Common Options.

CrossSection Options

Set options to define planar cross-sections through the volumetric grid.

{GfxOptions}Description
ShowCrossSection {On | Off}Show or hide the cross sections.
Opacity <value>This option sets the opacity multiplier which is used to incrementally increase the opacity of the cross-sections.

Valid value is greater or equal to 1.

AddPlane "<Plane>"Add a plane to be used as a cross section.

Only one AddPlane option can appear on a command.

RemovePlane {All | "<Plane>"}If All is entered then remove all planes, otherwise remove the specified plane.

Only one AddPlane option can appear on a command.

For details on the format of "<Plane>" see Component Specification.

Volume Options

Set options to define planar cross-sections through the volumetric grid.

{GfxOptions}Description
SelectVolume {ActiveGridPoints | SpatialCalcLevels}Enter ActiveGridPoints to include them when evaluating volumetric data.

Enter SpatialCalcLevels to represent straight line distances from the parent object at the center of the grid.

The SpatialCalcLevels option is only valid if a Spatial Calculation has been defined for the Volumetric. See Volumetric SpatialCalculation option.

If ActiveGridPoints are selected then the following options are available:

{GfxOptions}Description
ShowActiveGridPointsBoundary {On | Off}Turn on or off display of the volume satisfaction boundary.
ActiveGridPointsBoundary {Color} <Translucency>Set the the color and translucency for the active grid points boundary.
ShowActiveGridPointsFill {On | Off}Turn on or off display of the active grid points fill.
ActiveGridPointsFill {Active | Inactive} {Off | On {Color} <Translucency>}Show or hide the active or inactive grid points. If On is selected then the color and translucency must be entered.

If SpatialCalcLevels are selected then the following options are available:

{GfxOptions}Description
ShowBoundaryLevels {On | Off}Turn on or off display of the volume boundary levels.
BoundaryLevel <Level> {Color} <Translucency>Insert or modify a boundary level.
BoundaryRemove {All | <Level>} Remove all or the specified boundary level.
BoundaryValueRamp <Start> <Stop> <Step> [Translucency <value>]Replaces current boundary levels with levels as specified by the ramp values. The colors for the levels will be randomly assigned. Use the FillColorRamp option to assign a color ramp to the levels.

Optionally, a translucency value can be entered that will be applied to all levels. Default translucency value is 30.

Up to 100 levels can be added.

BoundaryColorRamp {StartColor} {EndColor} [Translucency <value>]Sets colors for current boundary levels, using a ramp between the start and end colors.

Optionally, a translucency value can be entered that will be applied to all levels. Default translucency value is 30.

ShowFillLevels {On | Off}Turn on or off display of the volume fill levels.
FillLevel <Level> {Color} <Translucency>Insert or modify a fill level.
ColorsOutsideMinMax {On | Off}Enter Off to constrain fill level display to inside the
FillRemove {All | <Level>} Remove all or the specified fill level.
FillValueRamp <Start> <Stop> <Step> [Translucency <value>]Replaces current fill levels with levels as specified by the ramp values. The colors for the levels will be randomly assigned. Use the FillColorRamp option to assign a color ramp to the levels.

Optionally, a translucency value can be entered that will be applied to all levels. Default translucency value is 30.

Up to 100 levels can be added.

FillColorRamp {StartColor} {EndColor} [Translucency <value>]Sets colors for current fill levels, using a ramp between the start and end colors.

Optionally, a translucency value can be entered that will be applied to all levels. Default translucency value is 30.

Valid <Level> values depend on the Volumetric object definition. Angles, latitude and longitude values should be entered in degrees. Distance and time values are entered in Connect units. All other dimensions are entered in Scenario units.

<Translucency> can be 1 to 100 (1 = opaque)

For valid {Color} options see Common Options.

Legend Options

The following shows the syntax of the command to set Legend options:

VO <VolumetricPath> VolumetricGfx Legend {Fill | Boundary} {Options}

First specify which Legend to modify, either Fill or Boundary. Then include at least one option from the table below.

{LegendOptions}Description
Show {On | Off}Show or hide the specified legend in the 3D Graphics window.
PositionX <XValue>Enter the pixel location for the upper left corner of the legend in the <XValue> and <YValue>, which can be entered separately. (0,0 is the upper left corner of the Map)
PositionY <YValue>
BackGroundColor {Color}Specify the color for the legend background. For valid {Color} options see Common Options.
Translucency <Value>Specify the percent of translucency. <Value> ranges from 0 (opaque) to 100 (completely transparent).
TextColor {Color}Specify the color for the legend text. For valid {Color} options see Common Options.
Title "<Title>"The text you wish to appear at the top of the legend.
DecimalDigits <Value>The precision, or number of digits that should display to the right of the decimal point, with which real numbers should display.
Notation {F | f | E | e}Select the legend numeric notation. Enter F or f for floating point notation. Enter E for scientific notation with an upper case E. Enter e for scientific notation with a lower case E.

Notation values are case-sensitive.

LevelOrder {HorizMinToMax | HorizMaxToMin | VertMinToMax | VertMaxToMin}Specify how the levels will display, either horizontally or vertically, and in ascending or descending order.
LevelMax <MaxValue> If LevelOrder is HorizMinToMax or HorizMaxToMin, enter a number between 1 and 1000 representing the number of colors per row. If LevelOrder is VertMinToMax or VertMaxToMin, enter a number between 1 and 1000 representing the number of colors per column.
ColorSqWidth <WidthValue>Pixel value between 1 and 100 representing the width of individual color bands.
ColorSqHeight <HeightValue>Pixel value between 1 and 100 representing the height of individual color bands.

Examples

To set volumetric 3d graphics attributes:

VO */Volumetric/Volumetric1 VolumetricGfx Quality High Shading On Smoothing Off

To set volumetric grid display properties:

VO */Volumetric/Volumetric1 VolumetricGfx ShowGrid On
VO */Volumetric/Volumetric1 VolumetricGfx ShowGridPoints On PointColor #000ff0 Pointsize 8

To define planar cross-section:

VO */Volumetric/Volumetric1 VolumetricGfx ShowCrossSection On
VO */Volumetric/Volumetric1 VolumetricGfx AddPlane "CentralBody/Earth Equator Plane"

To set values for ActiveGridPoints - Boundary:

VO */Volumetric/Volumetric1 VolumetricGfx SelectVolume ActiveGridPoints
VO */Volumetric/Volumetric1 VolumetricGfx ShowActiveGridPointsBoundary On
VO */Volumetric/Volumetric1 VolumetricGfx ActiveGridPointsBoundary #0000ff 25

To set values for ActiveGridPoints - Fill:

VO */Volumetric/Volumetric1 VolumetricGfx SelectVolume ActiveGridPoints
VO */Volumetric/Volumetric1 VolumetricGfx ShowActiveGridPointsFill On
VO */Volumetric/Volumetric1 VolumetricGfx ActiveGridPointsFill Active On #0f8f8f 75
VO */Volumetric/Volumetric1 VolumetricGfx ActiveGridPointsFill Inactive On #9f0f8f 30

To set values for SpatialCalcLevels - Boundary:

VO */Volumetric/Volumetric1 VolumetricGfx SelectVolume SpatialCalcLevels
VO */Volumetric/Volumetric1 VolumetricGfx ShowBoundaryLevels On
VO */Volumetric/Volumetric1 VolumetricGfx BoundaryLevel 1250 green 77 BoundaryLevel 2250 #dd0077 85

To set values for SpatialCalcLevels - Fill:

VO */Volumetric/Volumetric1 VolumetricGfx SelectVolume SpatialCalcLevels ShowFillLevels On
VO */Volumetric/Volumetric1 VolumetricGfx FillValueRamp 4000 10000 1000
VO */Volumetric/Volumetric1 VolumetricGfx FillColorRamp red blue
VO */Volumetric/Volumetric1 VolumetricGfx FillRemove 6000 FillRemove 8000

Examples

To show the Fill Legend, and set it's position and background color:

VO */Volumetric/Volumetric1 VolumetricGfx Legend Fill Show On
VO */Volumetric/Volumetric1 VolumetricGfx Legend Fill PositionX 10 PositionY 20 BackgroundColor Gray

To show the Boundary Legend, and set the order and size of the level squares:

VO */Volumetric/Volumetric1 VolumetricGfx Legend Boundary Show On LevelOrder VertMaxToMin ColorSqWidth 45 ColorSqHeight 60

Group membership

This command belongs to the following group(s):

Volumetric

VO

VO Objects

Version

11