ilog.views.maps.raster

Class IlvShadeableRasterStyle

java.lang.Object

ilog.views.maps.graphic.style.IlvMapStyle

ilog.views.maps.raster.datasource.IlvRasterStyle

ilog.views.maps.raster.IlvShadeableRasterStyle

All Implemented Interfaces:

IlvPersistentObject, IlvInheritable, StyleListener, Serializable

public class IlvShadeableRasterStyle
extends IlvRasterStyle

IlvShadeableRasterStyle represents a raster style that manages the light orientation for rasters containing altitude data.

Since:

JViews 7.5

See Also:

IlvRasterStyle, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	EAST East shading.
static int	NONE No shading
static int	NORTH North shading.
static int	NORTH_EAST North east shading.
static int	NORTH_WEST North West shading.
static String	ORIENTATION The light orientation attribute name.
static int	SOUTH South shading.
static int	SOUTH_EAST South east shading.
static int	SOUTH_WEST South west shading.
static int	WEST West shading.

Fields inherited from class ilog.views.maps.raster.datasource.IlvRasterStyle

BRIGHTNESS, COLORMODEL, CONTRAST, reader, SATURATION

Fields inherited from class ilog.views.maps.graphic.style.IlvMapStyle

ALPHA, ALWAYS_ON_TOP, ATTRIBUTE_INFO, CATEGORY, LABEL_ATTRIBUTE, LEGEND_GROUP, PARENT, THIN_CLIENT_BACKGROUND, VISIBLE_IN_3DVIEW, VISIBLE_IN_OVERVIEW, VISIBLE_IN_TREE, VISIBLE_IN_VIEW

Constructor Summary

Constructors

Constructor and Description
IlvShadeableRasterStyle() Constructs a new IlvShadeableRasterStyle instance.
IlvShadeableRasterStyle(IlvInputStream stream) Reads an IlvShadeableRasterStyle instance from an IlvInputStream.
IlvShadeableRasterStyle(IlvRasterAbstractReader reader) Constructs an IlvShadeableRasterStyle instance for the specified reader.
IlvShadeableRasterStyle(IlvShadeableRasterStyle source) The copy constructor.

Method Summary

Modifier and Type	Method and Description
IlvMapStyle	copy() Returns a copy of this IlvShadeableRasterStyle instance.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
int	getOrientation() Retrieves the ORIENTATION attribute value.
void	setOrientation(int c) Sets the ORIENTATION attribute value.
void	updateLoader(IlvRasterTileLoader loader) Updates the loader of this IlvShadeableRasterStyle instance with the orientation parameters.
void	updateReader(IlvRasterProperties props) Indicates to the color model of the properties that it needs to take shading into account.
void	write(IlvOutputStream stream) Writes this IlvShadeableRasterStyle instance to an IlvOutputStream.

Methods inherited from class ilog.views.maps.raster.datasource.IlvRasterStyle

getBrightness, getColorModel, getContrast, getSaturation, hashCode, setBrightness, setColorModel, setContrast, setSaturation, styleChanged

Methods inherited from class ilog.views.maps.graphic.style.IlvMapStyle

addAttributeListener, addChild, addStyleListener, addWeakStyleListener, getAlpha, getAttribute, getAttribute, getAttributeFilter, getAttributeInfo, getAttributeListeners, getCategory, getChildren, getDefaultValues, getGraphic, getLabelAttribute, getLegendGroup, getListeners, getParent, getStyleListeners, isAlwaysOnTop, isInherited, isThinClientBackground, isVisibleIn3DView, isVisibleInOverview, isVisibleInTree, isVisibleInView, objectEquals, removeAttributeListener, removeChild, removeStyleListener, setAlpha, setAlwaysOnTop, setAttribute, setAttributeFilter, setAttributeInfo, setCategory, setGraphic, setInherited, setLabelAttribute, setLegendGroup, setParent, setThinClientBackground, setVisibleIn3DView, setVisibleInOverview, setVisibleInTree, setVisibleInView

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static final int NONE

No shading

See Also:

Constant Field Values

SOUTH_EAST

public static final int SOUTH_EAST

South east shading.

See Also:

Constant Field Values

SOUTH

public static final int SOUTH

South shading.

See Also:

Constant Field Values

SOUTH_WEST

public static final int SOUTH_WEST

South west shading.

See Also:

Constant Field Values

EAST

public static final int EAST

East shading.

See Also:

Constant Field Values

WEST

public static final int WEST

West shading.

See Also:

Constant Field Values

NORTH_EAST

public static final int NORTH_EAST

North east shading.

See Also:

Constant Field Values

NORTH

public static final int NORTH

North shading.

See Also:

Constant Field Values

NORTH_WEST

public static final int NORTH_WEST

North West shading.

See Also:

Constant Field Values

ORIENTATION

public static final String ORIENTATION

The light orientation attribute name.

See Also:

Constant Field Values

Constructor Detail

IlvShadeableRasterStyle

public IlvShadeableRasterStyle()

Constructs a new IlvShadeableRasterStyle instance.

IlvShadeableRasterStyle

public IlvShadeableRasterStyle(IlvRasterAbstractReader reader)

Constructs an IlvShadeableRasterStyle instance for the specified reader.

Parameters:

reader - An image reader.

IlvShadeableRasterStyle

public IlvShadeableRasterStyle(IlvInputStream stream)
                        throws IlvReadFileException

Reads an IlvShadeableRasterStyle instance from an IlvInputStream.

Parameters:

stream - The stream to read from.

Throws:

IlvReadFileException - if there is a problem reading from stream.

IlvShadeableRasterStyle

public IlvShadeableRasterStyle(IlvShadeableRasterStyle source)

The copy constructor.

Parameters:

source - The source style to copy.

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes this IlvShadeableRasterStyle instance to an IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvRasterStyle

Parameters:

stream - The stream to write to.

Throws:

IOException - if there is a problem writing to stream.

See Also:

IlvMapStyle.write(ilog.views.io.IlvOutputStream)

copy

public IlvMapStyle copy()

Returns a copy of this IlvShadeableRasterStyle instance.

Overrides:

copy in class IlvRasterStyle

Returns:

A new IlvRasterStyle.

getOrientation

public int getOrientation()

Retrieves the ORIENTATION attribute value.

Returns:

An int value representing the ORIENTATION attribute value.

setOrientation

public void setOrientation(int c)

Sets the ORIENTATION attribute value.

Parameters:

c - An int value representing the ORIENTATION attribute value.

updateLoader

public void updateLoader(IlvRasterTileLoader loader)

Updates the loader of this IlvShadeableRasterStyle instance with the orientation parameters. This method is usually called by an IlvRasterIcon instance when it needs to update its image.

Parameters:

loader - The IlvRasterTileLoader to update.

updateReader

public void updateReader(IlvRasterProperties props)

Indicates to the color model of the properties that it needs to take shading into account. This is an overridden method. This method is usually called by a IlvRasterIcon object when it needs to update its image.

Overrides:

updateReader in class IlvRasterStyle

Parameters:

props - The raster properties used.

See Also:

IlvRasterStyle.updateReader(ilog.views.maps.raster.IlvRasterProperties)

equals

public boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class IlvRasterStyle

See Also:

IlvRasterStyle.equals(java.lang.Object)