com.esri.arcgis.cartox.cim

Class CIMWaterFill

java.lang.Object

com.esri.arcgis.cartox.cim.CIMObject

com.esri.arcgis.cartox.cim.CIMSymbolLayer

com.esri.arcgis.cartox.cim.CIMFill

com.esri.arcgis.cartox.cim.CIMWaterFill

public class CIMWaterFill
extends CIMFill

Represents a water fill which fills polygonal geometry with animated water.

Constructor Summary

Constructors

Constructor and Description
CIMWaterFill()

Method Summary

Modifier and Type	Method and Description
void	deserialize(JSONObject jsonObject) Deserializes this object from its JSON representation.
static CIMWaterFill	fromJSON(java.lang.String json) Creates the object with a specified state from a JSON encoding.
CIMColor	getColor() Gets the intrinsic color of the water.
WaterbodySize	getWaterbodySize() Gets the waterbody size allowing for a range of sizes from small pools to oceans.
double	getWaveDirection() Gets the azimuthal bearing for direction of the waves.
boolean	getWaveHasDirection() Gets a value indicating whether the waves are directionless (false), or if they have a dominant direction (true).
WaveStrength	getWaveStrength() Gets the strength of the waves.
void	serialize(JSONObject jsonObject) Serializes this object to its JSON representation.
void	setColor(CIMColor color) Sets the intrinsic color of the water.
void	setWaterbodySize(WaterbodySize waterbodySize) Sets the waterbody size allowing for a range of sizes from small pools to oceans.
void	setWaveDirection(double waveDirection) Sets the azimuthal bearing for direction of the waves.
void	setWaveHasDirection(boolean waveHasDirection) Sets a value indicating whether the waves are directionless (false), or if they have a dominant direction (true).
void	setWaveStrength(WaveStrength waveStrength) Sets the strength of the waves.
java.lang.String	toJSON() Creates a JSON encoding of the object and its current state.

Methods inherited from class com.esri.arcgis.cartox.cim.CIMSymbolLayer

getAnimations, getColorLocked, getEffects, getEnable, getName, getOverprint, getPrimitiveName, setAnimations, setColorLocked, setEffects, setEnable, setName, setOverprint, setPrimitiveName

Methods inherited from class java.lang.Object

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

Constructor Detail

CIMWaterFill

public CIMWaterFill()

Method Detail

getColor

public CIMColor getColor()

Gets the intrinsic color of the water.

setColor

public void setColor(CIMColor color)

Sets the intrinsic color of the water.

getWaveStrength

public WaveStrength getWaveStrength()

Gets the strength of the waves. This property along with waterbody size are the parameters which drive the wave appearance.

setWaveStrength

public void setWaveStrength(WaveStrength waveStrength)

Sets the strength of the waves. This property along with waterbody size are the parameters which drive the wave appearance.

getWaterbodySize

public WaterbodySize getWaterbodySize()

Gets the waterbody size allowing for a range of sizes from small pools to oceans. This property along with wave strength are the parameters which drive the wave appearance.

setWaterbodySize

public void setWaterbodySize(WaterbodySize waterbodySize)

Sets the waterbody size allowing for a range of sizes from small pools to oceans. This property along with wave strength are the parameters which drive the wave appearance.

getWaveHasDirection

public boolean getWaveHasDirection()

Gets a value indicating whether the waves are directionless (false), or if they have a dominant direction (true).

setWaveHasDirection

public void setWaveHasDirection(boolean waveHasDirection)

Sets a value indicating whether the waves are directionless (false), or if they have a dominant direction (true).

getWaveDirection

public double getWaveDirection()

Gets the azimuthal bearing for direction of the waves. Only has effect when WasHasDirection is true.

setWaveDirection

public void setWaveDirection(double waveDirection)

Sets the azimuthal bearing for direction of the waves. Only has effect when WasHasDirection is true.

fromJSON

public static CIMWaterFill fromJSON(java.lang.String json)
                             throws CIMJSONException

Creates the object with a specified state from a JSON encoding.

Throws:

CIMJSONException

toJSON

public java.lang.String toJSON()

Creates a JSON encoding of the object and its current state.

Specified by:

toJSON in class CIMObject

deserialize

public void deserialize(JSONObject jsonObject)
                 throws CIMJSONException

Deserializes this object from its JSON representation.

Overrides:

deserialize in class CIMFill

Throws:

CIMJSONException

serialize

public void serialize(JSONObject jsonObject)

Serializes this object to its JSON representation.

Overrides:

serialize in class CIMFill