com.esri.arcgis.carto
Interface IRasterRenderer

All Superinterfaces:

Serializable

All Known Implementing Classes:

RasterClassifyColorRampRenderer, RasterColormapRenderer, RasterDiscreteColorRenderer, RasterRGBRenderer, RasterStretchColorRampRenderer, RasterUniqueValueRenderer

public interface IRasterRenderer
extends Serializable

Provides access to methods that define a generic raster renderer.

Remarks

The IRasterRenderer interface is used to set a customized renderer to any raster layer.

Product Availability

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

Method Summary

boolean	canRender(IRaster raster) Indicates if the raster can be rendered.
void	copy(IRasterRenderer pSource) Selects a raster as the current copy object.
void	draw(IRaster raster, int drawPhase, IDisplay pDisplay, ITrackCancel pTrackCancel) Draws the raster on the display.
int	getDisplayResolutionFactor() Display resolution factor.
IRaster	getRaster() Raster to be rendered.
int	getResamplingType() Resampling method for displaying a raster.
boolean	isUpdated() Indicates whether the renderer requires updating.
void	setDisplayResolutionFactor(int pnFactor) Display resolution factor.
void	setRasterByRef(IRaster raster) Raster to be rendered.
void	setResamplingType(int pResamplingType) Resampling method for displaying a raster.
void	update() Updates the renderer for any changes that have been made.

Method Detail

canRender

boolean canRender(IRaster raster)
                  throws IOException,
                         AutomationException

Indicates if the raster can be rendered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Returns:

The pCanRender

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

void setRasterByRef(IRaster raster)
                    throws IOException,
                           AutomationException

Raster to be rendered.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRaster

IRaster getRaster()
                  throws IOException,
                         AutomationException

Raster to be rendered.

Description

The Raster property controls the raster being displayed by the renderer. Because the renderers depend on dataset statistics, after changing the raster to be displayed, the update method must be called before performing using the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

void draw(IRaster raster,
          int drawPhase,
          IDisplay pDisplay,
          ITrackCancel pTrackCancel)
          throws IOException,
                 AutomationException

Draws the raster on the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUpdated

boolean isUpdated()
                  throws IOException,
                         AutomationException

Indicates whether the renderer requires updating.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pUpdated

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

void update()
            throws IOException,
                   AutomationException

Updates the renderer for any changes that have been made.

Remarks

The Update method should also be called after making changes to the renderer but before assigning the renderer to a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

void copy(IRasterRenderer pSource)
          throws IOException,
                 AutomationException

Selects a raster as the current copy object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pSource - A reference to a com.esri.arcgis.carto.IRasterRenderer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResamplingType

int getResamplingType()
                      throws IOException,
                             AutomationException

Resampling method for displaying a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResamplingType

void setResamplingType(int pResamplingType)
                       throws IOException,
                              AutomationException

Resampling method for displaying a raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pResamplingType - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayResolutionFactor

void setDisplayResolutionFactor(int pnFactor)
                                throws IOException,
                                       AutomationException

Display resolution factor. Factor value is expressed as a percentage between 0 and 100.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pnFactor - The pnFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayResolutionFactor

int getDisplayResolutionFactor()
                               throws IOException,
                                      AutomationException

Display resolution factor. Factor value is expressed as a percentage between 0 and 100.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pnFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.