com.esri.arcgis.display
Class AlgorithmicColorRamp

java.lang.Object
  extended by com.esri.arcgis.display.AlgorithmicColorRamp
All Implemented Interfaces:
IAlgorithmicColorRamp, IColorRamp, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class AlgorithmicColorRamp
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAlgorithmicColorRamp, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable

Defines an algorithmic color ramp, where ramp is defined by two colors and the algorithm used to traverse the intervening color space between them.

Description

Determines the colors that occur between a FromColor and a ToColor. These colors can be used when assigning symbology to a ClassBreaksRenderer, RasterClassifyColorRampRenderer, or to an object that supports ITinColorRampRenderer.

Remarks

There are several methods to ramp colors. The current method is accessible via IAlgorithmicColorRamp::Algorithm.

The default method for this object is an HSV (Hue, Saturation, Value) algorithm, where the values of H, S, and V are all interpolated. The second available method is CieLab's algorithm which creates the intervening colors by intelligently blending the From and To colors. A third method is the LabLCh method, which is a modified version of CieLab's method and can create better results in some cases. In general the HSV produces brighter results, especially when the From and To colors are not of similar hues. However, the CieLab's and LCH methods may produce more intuitive results. This is because most casual map readers have more difficulty associating progression through a series of hues versus a smooth blend of colors.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
AlgorithmicColorRamp()
          Constructs a AlgorithmicColorRamp using ArcGIS Engine.
AlgorithmicColorRamp(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AlgorithmicColorRamp theAlgorithmicColorRamp = (AlgorithmicColorRamp) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void createRamp(boolean[] ok)
          Generates a color ramp with length determined by Size value.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 int getAlgorithm()
          The algorithm used to ramp between the first and last colors.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 IColor getColor(int index)
          The color at the given index position.
 IEnumColors getColors()
          The list of colors.
 IColor getFromColor()
          The first color in the color ramp.
 String getName()
          The name of the color ramp.
 int getSize()
          The number of colors that will be generated by the CreateRamp method.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 IColor getToColor()
          The last color in the color ramp.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setAlgorithm(int algorithm)
          The algorithm used to ramp between the first and last colors.
 void setFromColor(IColor color)
          The first color in the color ramp.
 void setName(String pName)
          The name of the color ramp.
 void setSize(int count)
          The number of colors that will be generated by the CreateRamp method.
 void setToColor(IColor color)
          The last color in the color ramp.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

AlgorithmicColorRamp

public AlgorithmicColorRamp()
                     throws IOException,
                            UnknownHostException
Constructs a AlgorithmicColorRamp using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

AlgorithmicColorRamp

public AlgorithmicColorRamp(Object obj)
                     throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AlgorithmicColorRamp theAlgorithmicColorRamp = (AlgorithmicColorRamp) obj;

Construct a AlgorithmicColorRamp using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AlgorithmicColorRamp.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getFromColor

public IColor getFromColor()
                    throws IOException,
                           AutomationException
The first color in the color ramp.

Description

FromColor is the first color in a IAlgorithmicColorRamp.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFromColor in interface IAlgorithmicColorRamp
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IHsvColor, IHlsColor

setFromColor

public void setFromColor(IColor color)
                  throws IOException,
                         AutomationException
The first color in the color ramp.

Description

FromColor is the first color in a IAlgorithmicColorRamp.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFromColor in interface IAlgorithmicColorRamp
Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IHsvColor, IHlsColor

getToColor

public IColor getToColor()
                  throws IOException,
                         AutomationException
The last color in the color ramp.

Description

ToColor is the second color in a IAlgorithmicColorRamp.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getToColor in interface IAlgorithmicColorRamp
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IHsvColor, IHlsColor

setToColor

public void setToColor(IColor color)
                throws IOException,
                       AutomationException
The last color in the color ramp.

Description

ToColor is the second color in a IAlgorithmicColorRamp.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setToColor in interface IAlgorithmicColorRamp
Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IHsvColor, IHlsColor

setAlgorithm

public void setAlgorithm(int algorithm)
                  throws IOException,
                         AutomationException
The algorithm used to ramp between the first and last colors.

Description

Algorithm is the ramping algorithm used to create intermediate colors between the FromColor and the ToColor .

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAlgorithm in interface IAlgorithmicColorRamp
Parameters:
algorithm - A com.esri.arcgis.display.esriColorRampAlgorithm constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAlgorithm

public int getAlgorithm()
                 throws IOException,
                        AutomationException
The algorithm used to ramp between the first and last colors.

Description

Algorithm is the ramping algorithm used to create intermediate colors between the FromColor and the ToColor .

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAlgorithm in interface IAlgorithmicColorRamp
Returns:
A com.esri.arcgis.display.esriColorRampAlgorithm constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String pName)
             throws IOException,
                    AutomationException
The name of the color ramp.

Description

Name is the name of an instance of a color ramp.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setName in interface IColorRamp
Parameters:
pName - The pName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the color ramp.

Description

Name is the name of an instance of a color ramp.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IColorRamp
Returns:
The pName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(int count)
             throws IOException,
                    AutomationException
The number of colors that will be generated by the CreateRamp method.

Description

Size is the number of colors that will be generated when the CreateRamp method is used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSize in interface IColorRamp
Parameters:
count - The count (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSize

public int getSize()
            throws IOException,
                   AutomationException
The number of colors that will be generated by the CreateRamp method.

Description

Size is the number of colors that will be generated when the CreateRamp method is used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSize in interface IColorRamp
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColors

public IEnumColors getColors()
                      throws IOException,
                             AutomationException
The list of colors. Call CreateRamp before calling this method.

Description

Colors is how you can populate an IEnumColors object in order to easily retrieve the colors in a color ramp.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getColors in interface IColorRamp
Returns:
A reference to a com.esri.arcgis.display.IEnumColors
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColor

public IColor getColor(int index)
                throws IOException,
                       AutomationException
The color at the given index position. Call CreateRamp before calling this method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getColor in interface IColorRamp
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRamp

public void createRamp(boolean[] ok)
                throws IOException,
                       AutomationException
Generates a color ramp with length determined by Size value.

Description

CreateRamp generates the number of colors in a color ramp as specified in the Size property. The boolean pOK is a mask, i.e., you supply the boolean object and the method will set its value. Generally speaking pOK will only return false if a property is missing.

Remarks

Use the CreateRamp after you have set the other properties like Size and the colors specific paramters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
createRamp in interface IColorRamp
Parameters:
ok - The ok (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IPresetColorRamp, IMultiPartColorRamp, IAlgorithmicColorRamp, IColorRamp.getColor(int), IRandomColorRamp, IColorRamp.createRamp(boolean[]), IColorRamp

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException