com.esri.arcgis.carto
Interface IRasterRendererMaker

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterRendererMakerDefault

public interface IRasterRendererMaker
extends Serializable

Provides access to members that can determine the default display of a raster dataset.

Remarks

The IRasterRendererMaker interface controls the renderer used to display a raster upon initial display.

To create your own raster renderer maker, implement the
IRasterRendererMaker interface in an object and register this renderer maker object with the Raster Renderer Makers component category. If the priority returns a value greater than 0, this renderer will have the ability to provide a renderer before the system default. For rasters, which you wish to use the system default, return Null instead of a valid renderer. If no renderer is returned from this renderer maker, the raster will be passed to the next highest priority until a renderer is created. This allows you to specify multiple custom rendering combinations that can be used with different priority levels. The default renderer maker will create a renderer for any raster dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IRasterRenderer createDefaultRasterRenderer(IRaster pRaster)
          Returns the raster renderer which should be used for the default display of the input raster.
 int getPriority()
          Controls the order in which renderer makers are selected.
 

Method Detail

createDefaultRasterRenderer

IRasterRenderer createDefaultRasterRenderer(IRaster pRaster)
                                            throws IOException,
                                                   AutomationException
Returns the raster renderer which should be used for the default display of the input raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Returns:
A reference to a com.esri.arcgis.carto.IRasterRenderer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPriority

int getPriority()
                throws IOException,
                       AutomationException
Controls the order in which renderer makers are selected. Higher priority renderer makers are called first.

Remarks

The priority method returns the priority of this renderer maker relative to others in the system. Renderer makers are called with decreasing priority until a renderer is provided for a raster. As soon as a renderer is returned, the priority of the RasterRendererMakerDefault is 0. The CreateRasterDefaultRenderer method returns the renderer that will be used by default for the input raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.