com.esri.arcgis.cartox.cim

Class CIMGeometricEffectWave

java.lang.Object

com.esri.arcgis.cartox.cim.CIMObject

com.esri.arcgis.cartox.cim.CIMGeometricEffect

com.esri.arcgis.cartox.cim.CIMGeometricEffectWave

public class CIMGeometricEffectWave
extends CIMGeometricEffect

Represents the wave geometric effect which creates a dynamic line or polygon along a feature with a repeating wave pattern.

Constructor Summary

Constructors

Constructor and Description
CIMGeometricEffectWave()

Method Summary

Modifier and Type	Method and Description
void	deserialize(JSONObject jsonObject) Deserializes this object from its JSON representation.
static CIMGeometricEffectWave	fromJSON(java.lang.String json) Creates the object with a specified state from a JSON encoding.
double	getAmplitude() Gets the distance perpendicular to a feature to display the curves for the symbol.
double	getPeriod() Gets the distance along the line or polygon to display the curves for the symbol.
int	getSeed() Gets the staring value for generating a random number.
GeometricEffectWaveform	getWaveform() Gets the shape of the curves to be displayed along the symbol.
void	serialize(JSONObject jsonObject) Serializes this object to its JSON representation.
void	setAmplitude(double amplitude) Sets the distance perpendicular to a feature to display the curves for the symbol.
void	setPeriod(double period) Sets the distance along the line or polygon to display the curves for the symbol.
void	setSeed(int seed) Sets the staring value for generating a random number.
void	setWaveform(GeometricEffectWaveform waveform) Sets the shape of the curves to be displayed along the symbol.
java.lang.String	toJSON() Creates a JSON encoding of the object and its current state.

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

getPrimitiveName, setPrimitiveName

Methods inherited from class java.lang.Object

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

Constructor Detail

CIMGeometricEffectWave

public CIMGeometricEffectWave()

Method Detail

getAmplitude

public double getAmplitude()

Gets the distance perpendicular to a feature to display the curves for the symbol.

setAmplitude

public void setAmplitude(double amplitude)

Sets the distance perpendicular to a feature to display the curves for the symbol.

getPeriod

public double getPeriod()

Gets the distance along the line or polygon to display the curves for the symbol.

setPeriod

public void setPeriod(double period)

Sets the distance along the line or polygon to display the curves for the symbol.

getSeed

public int getSeed()

Gets the staring value for generating a random number. This is only used when the Waveform is set to Random.

setSeed

public void setSeed(int seed)

Sets the staring value for generating a random number. This is only used when the Waveform is set to Random.

getWaveform

public GeometricEffectWaveform getWaveform()

Gets the shape of the curves to be displayed along the symbol.

setWaveform

public void setWaveform(GeometricEffectWaveform waveform)

Sets the shape of the curves to be displayed along the symbol.

fromJSON

public static CIMGeometricEffectWave 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 CIMGeometricEffect

Throws:

CIMJSONException

serialize

public void serialize(JSONObject jsonObject)

Serializes this object to its JSON representation.

Overrides:

serialize in class CIMGeometricEffect