ViewOptions (Demo 2.1 API)

java.lang.Object
- org.tinfour.demo.viewer.backplane.ViewOptions

```
public class ViewOptions
extends Object
```
Provides specifications and options for rendering a model.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ViewOptions.RasterInterpolationMethod`
`static class`	`ViewOptions.SampleThinning` An enumeration definitng states for Wireframe sample thinning

Constructor Summary

Constructors
Constructor and Description
`ViewOptions()` Create a new instance with default parameters.
`ViewOptions(ViewOptions v)` Create a new instance copying the state data from the supplied reference

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Color`	`getBackground()` Gets the background color for rendering
`Color`	`getConstraintColor()` Gets the constraint color for rendering
`String`	`getFieldForLabel()`
`Color`	`getForeground()` Gets the foreground color for rendering
`int`	`getForegroundBackgroundOption()` Indicates if the colors are set to black on white (value of zero) or white on black (value of 1)
`double`	`getHillshadeAmbient()`
`double`	`getHillshadeAzimuth()`
`double`	`getHillshadeElevation()`
`LidarPointSelection`	`getLidarPointSelection()` Gets the option for selecting lidar sample points
`int`	`getPadding()` Gets the padding for the backplane image
`String`	`getPaletteName()` Get the name of the palette to be used for rendering
`double[]`	`getRangeForPalette()` Gets the specified minimum and maximum values that should be used for assigning a color to elevations when rendering
`ViewOptions.RasterInterpolationMethod`	`getRasterInterpolationMethod()` Gets the method to be used for interpolating data when building a raster grid.
`int`	`getWireframeSampleSpacing()` Gets the pixel distance between samples for the selected thinning factor.
`ViewOptions.SampleThinning`	`getWireframeSampleThinning()` Gets the sample thinning setting for wireframe rendering
`boolean`	`isClipOnConstraintsSelected()`
`boolean`	`isConstraintRenderingSelected()`
`boolean`	`isEdgeRenderingSelected()`
`boolean`	`isFullResolutionGridSelected()`
`boolean`	`isGridBasedRenderingSelected()` A "roll up" method that detects if either raster or hillshade rendering is selected.
`boolean`	`isHillshadeSelected()`
`boolean`	`isLabelRenderingSelected()`
`boolean`	`isRasterSelected()`
`boolean`	`isVertexRenderingSelected()`
`boolean`	`isWireframeSelected()` Indicates whether wireframe rendering is enabled
`void`	`setBackground(Color background)` Set the background color for rendering
`void`	`setClipOnConstraintsSelected(boolean status)`
`void`	`setConstraintColor(Color constraintColor)` Set the constraint color for rendering
`void`	`setConstraintRenderingSelected(boolean isConstraintRenderingSelected)`
`void`	`setEdgeRenderingSelected(boolean isEdgeRenderingSelected)`
`void`	`setFieldForLabel(String fieldForLabel)`
`void`	`setForeground(Color foreground)` Set the foreground color for rendering
`void`	`setForegroundBackgroundOption(int foregroundBackgroundOption)` Set the foregroundBackgroundOption
`void`	`setFullResolutionGridSelected(boolean status)`
`void`	`setHillshadeAmbient(double hillshadeAmbient)`
`void`	`setHillshadeAzimuth(double hillshadeAzimuth)`
`void`	`setHillshadeElevation(double hillshadeElevation)`
`void`	`setHillshadeSelected(boolean isHillshadeSelected)`
`void`	`setLabelRenderingSelected(boolean isLabelRenderingSelected)`
`void`	`setLidarPointSelection(LidarPointSelection selection)`
`void`	`setPaletteName(String paletteName)` Sets the name of the palette to be used for rendering
`void`	`setRangeForPalette(double[] rangeForPalette)` Sets the specified minimum and maximum values that should be used for assigning a color to elevations when rendering
`void`	`setRasterInterpolationMethod(ViewOptions.RasterInterpolationMethod method)` Sets the method to be used for interpolating data when building a raster grid;
`void`	`setRasterSelected(boolean isRasterSelected)`
`void`	`setUsePaletteForWireframe(boolean usePaletteForWireframe)`
`void`	`setUseRangeOfValuesForPalette(boolean useRangeOfValuesForPalette)` Indicates that the color assignment should be based on a fixed range of z values rather than the minimum and maximum values available from the model.
`void`	`setVertexRenderingSelected(boolean isVertexRenderingSelected)`
`void`	`setWireframeSampleThinning(ViewOptions.SampleThinning sampleThinning)` Sets the sample thinning setting for wireframe rendering.
`void`	`setWireframeSelected(boolean isWireframeSelected)`
`boolean`	`usePaletteForWireframe()`
`boolean`	`useRangeOfValuesForPalette()` Indicates that the color assignment should be based on a fixed range of z values rather than the minimum and maximum values available from the model.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ViewOptions
```
public ViewOptions(ViewOptions v)
```
    Create a new instance copying the state data from the supplied reference
    
    Parameters:
    
    v - a valid instance
  - ViewOptions
```
public ViewOptions()
```
    Create a new instance with default parameters.
- Method Detail
  - getForegroundBackgroundOption
```
public int getForegroundBackgroundOption()
```
    Indicates if the colors are set to black on white (value of zero) or white on black (value of 1)
    
    Returns:
    
    the foregroundBackgroundOption
  - setForegroundBackgroundOption
```
public void setForegroundBackgroundOption(int foregroundBackgroundOption)
```
    Set the foregroundBackgroundOption
    
    Parameters:
    
    foregroundBackgroundOption - the foregroundBackgroundOption to set
  - getForeground
```
public Color getForeground()
```
    Gets the foreground color for rendering
    
    Returns:
    
    a valid color instance
  - setForeground
```
public void setForeground(Color foreground)
```
    Set the foreground color for rendering
    
    Parameters:
    
    foreground - a valid color instance
  - getBackground
```
public Color getBackground()
```
    Gets the background color for rendering
    
    Returns:
    
    a valid color instance
  - setBackground
```
public void setBackground(Color background)
```
    Set the background color for rendering
    
    Parameters:
    
    background - a valid color instance
  - getPaletteName
```
public String getPaletteName()
```
    Get the name of the palette to be used for rendering
    
    Returns:
    
    a valid string from the static list of palette names
  - setPaletteName
```
public void setPaletteName(String paletteName)
```
    Sets the name of the palette to be used for rendering
    
    Parameters:
    
    paletteName - a valid string from the static list of palette names
  - useRangeOfValuesForPalette
```
public boolean useRangeOfValuesForPalette()
```
    Indicates that the color assignment should be based on a fixed range of z values rather than the minimum and maximum values available from the model. See getRangeForPalette.
    
    Returns:
    
    true if a fixed range should be used; false if the minimum and maximum values from the model should be used
  - setUseRangeOfValuesForPalette
```
public void setUseRangeOfValuesForPalette(boolean useRangeOfValuesForPalette)
```
    Indicates that the color assignment should be based on a fixed range of z values rather than the minimum and maximum values available from the model.
    
    Parameters:
    
    useRangeOfValuesForPalette - true if a fixed range should be used; false if the minimum and maximum values from the model should be used
  - getRangeForPalette
```
public double[] getRangeForPalette()
```
    Gets the specified minimum and maximum values that should be used for assigning a color to elevations when rendering
    
    Returns:
    
    a valid, two-dimensional array giving the minimum and maximum values for the color-assignment range.
  - setRangeForPalette
```
public void setRangeForPalette(double[] rangeForPalette)
```
    Sets the specified minimum and maximum values that should be used for assigning a color to elevations when rendering
    
    Parameters:
    
    rangeForPalette - a valid, two-dimensional array giving the minimum and maximum values for the color-assignment range.
  - isWireframeSelected
```
public boolean isWireframeSelected()
```
    Indicates whether wireframe rendering is enabled
    
    Returns:
    
    true if rendering is enabled; otherwise, false.
  - setWireframeSelected
```
public void setWireframeSelected(boolean isWireframeSelected)
```
    Parameters:
    
    isWireframeSelected - the isWireframeSelected to set
  - isEdgeRenderingSelected
```
public boolean isEdgeRenderingSelected()
```
    Returns:
    
    the isEdgeRenderingSelected
  - setEdgeRenderingSelected
```
public void setEdgeRenderingSelected(boolean isEdgeRenderingSelected)
```
    Parameters:
    
    isEdgeRenderingSelected - the isEdgeRenderingSelected to set
  - isVertexRenderingSelected
```
public boolean isVertexRenderingSelected()
```
    Returns:
    
    the isVertexRenderingSelected
  - setVertexRenderingSelected
```
public void setVertexRenderingSelected(boolean isVertexRenderingSelected)
```
    Parameters:
    
    isVertexRenderingSelected - the isVertexRenderingSelected to set
  - isLabelRenderingSelected
```
public boolean isLabelRenderingSelected()
```
    Returns:
    
    the isLabelRenderingSelected
  - setLabelRenderingSelected
```
public void setLabelRenderingSelected(boolean isLabelRenderingSelected)
```
    Parameters:
    
    isLabelRenderingSelected - the isLabelRenderingSelected to set
  - getFieldForLabel
```
public String getFieldForLabel()
```
    Returns:
    
    the fieldForLabel
  - setFieldForLabel
```
public void setFieldForLabel(String fieldForLabel)
```
    Parameters:
    
    fieldForLabel - the fieldForLabel to set
  - usePaletteForWireframe
```
public boolean usePaletteForWireframe()
```
    Returns:
    
    the usePaletteForWireframe
  - setUsePaletteForWireframe
```
public void setUsePaletteForWireframe(boolean usePaletteForWireframe)
```
    Parameters:
    
    usePaletteForWireframe - the usePaletteForWireframe to set
  - isRasterSelected
```
public boolean isRasterSelected()
```
    Returns:
    
    the isRasterSelected
  - setRasterSelected
```
public void setRasterSelected(boolean isRasterSelected)
```
    Parameters:
    
    isRasterSelected - the isRasterSelected to set
  - isHillshadeSelected
```
public boolean isHillshadeSelected()
```
    Returns:
    
    the isHillshadeSelected
  - setHillshadeSelected
```
public void setHillshadeSelected(boolean isHillshadeSelected)
```
    Parameters:
    
    isHillshadeSelected - the isHillshadeSelected to set
  - getHillshadeAzimuth
```
public double getHillshadeAzimuth()
```
    Returns:
    
    the hillshadeAzimuth
  - setHillshadeAzimuth
```
public void setHillshadeAzimuth(double hillshadeAzimuth)
```
    Parameters:
    
    hillshadeAzimuth - the hillshadeAzimuth to set
  - getHillshadeElevation
```
public double getHillshadeElevation()
```
    Returns:
    
    the hillshadeElevation
  - setHillshadeElevation
```
public void setHillshadeElevation(double hillshadeElevation)
```
    Parameters:
    
    hillshadeElevation - the hillshadeElevation to set
  - getHillshadeAmbient
```
public double getHillshadeAmbient()
```
    Returns:
    
    the hillshadeAmbient
  - setHillshadeAmbient
```
public void setHillshadeAmbient(double hillshadeAmbient)
```
    Parameters:
    
    hillshadeAmbient - the hillshadeAmbient to set
  - isFullResolutionGridSelected
```
public boolean isFullResolutionGridSelected()
```
  - setFullResolutionGridSelected
```
public void setFullResolutionGridSelected(boolean status)
```
  - isClipOnConstraintsSelected
```
public boolean isClipOnConstraintsSelected()
```
  - setClipOnConstraintsSelected
```
public void setClipOnConstraintsSelected(boolean status)
```
  - getLidarPointSelection
```
public LidarPointSelection getLidarPointSelection()
```
    Gets the option for selecting lidar sample points
    
    Returns:
    
    the option for selecting lidar sample points
  - setLidarPointSelection
```
public void setLidarPointSelection(LidarPointSelection selection)
```
  - isGridBasedRenderingSelected
```
public boolean isGridBasedRenderingSelected()
```
    A "roll up" method that detects if either raster or hillshade rendering is selected.
    
    Returns:
    
    if either grid-based rendering is selected, true; otherwise, false.
  - getPadding
```
public int getPadding()
```
    Gets the padding for the backplane image
    
    Returns:
    
    a fixed value.
  - setWireframeSampleThinning
```
public void setWireframeSampleThinning(ViewOptions.SampleThinning sampleThinning)
```
    Sets the sample thinning setting for wireframe rendering.
    
    Parameters:
    
    sampleThinning - a valid enumeration state
  - getWireframeSampleThinning
```
public ViewOptions.SampleThinning getWireframeSampleThinning()
```
    Gets the sample thinning setting for wireframe rendering
    
    Returns:
    
    a valid enumerations state;
  - getWireframeSampleSpacing
```
public int getWireframeSampleSpacing()
```
    Gets the pixel distance between samples for the selected thinning factor.
    
    Returns:
    
    a positive number in pixels (user coordinates)
  - getRasterInterpolationMethod
```
public ViewOptions.RasterInterpolationMethod getRasterInterpolationMethod()
```
    Gets the method to be used for interpolating data when building a raster grid.
    
    Returns:
    
    a valid instance.
  - setRasterInterpolationMethod
```
public void setRasterInterpolationMethod(ViewOptions.RasterInterpolationMethod method)
```
    Sets the method to be used for interpolating data when building a raster grid;
    
    Parameters:
    
    method - a valid instance.
  - isConstraintRenderingSelected
```
public boolean isConstraintRenderingSelected()
```
    Returns:
    
    the isConstraintRenderingSelected
  - setConstraintRenderingSelected
```
public void setConstraintRenderingSelected(boolean isConstraintRenderingSelected)
```
    Parameters:
    
    isConstraintRenderingSelected - the isConstraintRenderingSelected to set
  - getConstraintColor
```
public Color getConstraintColor()
```
    Gets the constraint color for rendering
    
    Returns:
    
    a valid color instance
  - setConstraintColor
```
public void setConstraintColor(Color constraintColor)
```
    Set the constraint color for rendering
    
    Parameters:
    
    constraintColor - a valid color instance

Class ViewOptions

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ViewOptions

ViewOptions

Method Detail

getForegroundBackgroundOption

setForegroundBackgroundOption

getForeground

setForeground

getBackground

setBackground

getPaletteName

setPaletteName

useRangeOfValuesForPalette

setUseRangeOfValuesForPalette

getRangeForPalette

setRangeForPalette

isWireframeSelected

setWireframeSelected

isEdgeRenderingSelected

setEdgeRenderingSelected

isVertexRenderingSelected

setVertexRenderingSelected

isLabelRenderingSelected

setLabelRenderingSelected

getFieldForLabel

setFieldForLabel

usePaletteForWireframe

setUsePaletteForWireframe

isRasterSelected

setRasterSelected

isHillshadeSelected

setHillshadeSelected

getHillshadeAzimuth

setHillshadeAzimuth

getHillshadeElevation

setHillshadeElevation

getHillshadeAmbient

setHillshadeAmbient

isFullResolutionGridSelected

setFullResolutionGridSelected

isClipOnConstraintsSelected

setClipOnConstraintsSelected

getLidarPointSelection

setLidarPointSelection

isGridBasedRenderingSelected

getPadding

setWireframeSampleThinning

getWireframeSampleThinning

getWireframeSampleSpacing

getRasterInterpolationMethod

setRasterInterpolationMethod

isConstraintRenderingSelected

setConstraintRenderingSelected

getConstraintColor

setConstraintColor