public class ViewOptions extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
ViewOptions.RasterInterpolationMethod |
static class |
ViewOptions.SampleThinning
An enumeration definitng states for Wireframe sample thinning
|
| 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
|
| 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.
|
public ViewOptions(ViewOptions v)
v - a valid instancepublic ViewOptions()
public int getForegroundBackgroundOption()
public void setForegroundBackgroundOption(int foregroundBackgroundOption)
foregroundBackgroundOption - the foregroundBackgroundOption to setpublic Color getForeground()
public void setForeground(Color foreground)
foreground - a valid color instancepublic Color getBackground()
public void setBackground(Color background)
background - a valid color instancepublic String getPaletteName()
public void setPaletteName(String paletteName)
paletteName - a valid string from the static list of palette namespublic boolean useRangeOfValuesForPalette()
public void setUseRangeOfValuesForPalette(boolean useRangeOfValuesForPalette)
useRangeOfValuesForPalette - true if a fixed range should be used;
false if the minimum and maximum values from the model should be usedpublic double[] getRangeForPalette()
public void setRangeForPalette(double[] rangeForPalette)
rangeForPalette - a valid, two-dimensional array giving the minimum
and maximum values for the color-assignment range.public boolean isWireframeSelected()
public void setWireframeSelected(boolean isWireframeSelected)
isWireframeSelected - the isWireframeSelected to setpublic boolean isEdgeRenderingSelected()
public void setEdgeRenderingSelected(boolean isEdgeRenderingSelected)
isEdgeRenderingSelected - the isEdgeRenderingSelected to setpublic boolean isVertexRenderingSelected()
public void setVertexRenderingSelected(boolean isVertexRenderingSelected)
isVertexRenderingSelected - the isVertexRenderingSelected to setpublic boolean isLabelRenderingSelected()
public void setLabelRenderingSelected(boolean isLabelRenderingSelected)
isLabelRenderingSelected - the isLabelRenderingSelected to setpublic String getFieldForLabel()
public void setFieldForLabel(String fieldForLabel)
fieldForLabel - the fieldForLabel to setpublic boolean usePaletteForWireframe()
public void setUsePaletteForWireframe(boolean usePaletteForWireframe)
usePaletteForWireframe - the usePaletteForWireframe to setpublic boolean isRasterSelected()
public void setRasterSelected(boolean isRasterSelected)
isRasterSelected - the isRasterSelected to setpublic boolean isHillshadeSelected()
public void setHillshadeSelected(boolean isHillshadeSelected)
isHillshadeSelected - the isHillshadeSelected to setpublic double getHillshadeAzimuth()
public void setHillshadeAzimuth(double hillshadeAzimuth)
hillshadeAzimuth - the hillshadeAzimuth to setpublic double getHillshadeElevation()
public void setHillshadeElevation(double hillshadeElevation)
hillshadeElevation - the hillshadeElevation to setpublic double getHillshadeAmbient()
public void setHillshadeAmbient(double hillshadeAmbient)
hillshadeAmbient - the hillshadeAmbient to setpublic boolean isFullResolutionGridSelected()
public void setFullResolutionGridSelected(boolean status)
public boolean isClipOnConstraintsSelected()
public void setClipOnConstraintsSelected(boolean status)
public LidarPointSelection getLidarPointSelection()
public void setLidarPointSelection(LidarPointSelection selection)
public boolean isGridBasedRenderingSelected()
public int getPadding()
public void setWireframeSampleThinning(ViewOptions.SampleThinning sampleThinning)
sampleThinning - a valid enumeration statepublic ViewOptions.SampleThinning getWireframeSampleThinning()
public int getWireframeSampleSpacing()
public ViewOptions.RasterInterpolationMethod getRasterInterpolationMethod()
public void setRasterInterpolationMethod(ViewOptions.RasterInterpolationMethod method)
method - a valid instance.public boolean isConstraintRenderingSelected()
public void setConstraintRenderingSelected(boolean isConstraintRenderingSelected)
isConstraintRenderingSelected - the isConstraintRenderingSelected to
setpublic Color getConstraintColor()
public void setConstraintColor(Color constraintColor)
constraintColor - a valid color instanceCopyright © 2019. All rights reserved.