com.esri.arcgis.carto
Interface IRasterRGBRenderer

All Superinterfaces:

Serializable

All Known Subinterfaces:

IRasterRGBRenderer2

All Known Implementing Classes:

RasterRGBRenderer

public interface IRasterRGBRenderer
extends Serializable

Provides access to members which control the raster Red/Green/Blue renderer.

Superseded By

IRasterRGBRenderer2

Remarks

The RedBandIndex, BlueBandIndex, and GreenBandIndex properties of this interface control which band is displayed in each display channel.

The the band index is zero based, with a value of zero representing band one, a value of one representing band two, and so on. Each channel can be set to display or not display using the UseRedBand,UseGreenBand, and UseBlueBand properties.

To check or set the band indices for all three bands with one call, use the QueryBandIndices or SetBandIndices functions.

When To Use

IRasterRGBRenderer is used to display multiband images. It draws three bands of a raster dataset, one to each of the red, green, and blue channels of the display.

Product Availability

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

Method Summary

int	getBlueBandIndex() Band to be represented in blue.
int	getGreenBandIndex() Band to be represented in green.
int	getRedBandIndex() Band to be represented in red.
boolean	isUseBlueBand() Indicates if the blue band is used.
boolean	isUseGreenBand() Indicates if the green band is used.
boolean	isUseRedBand() Indicates if the red band is used.
void	queryBandIndices(int[] redIndex, int[] greenIndex, int[] blueIndex) Band numbers for red, green, and blue bands.
void	setBandIndices(int redIndex, int greenIndex, int blueIndex) Band numbers for red, green, and blue bands.
void	setBlueBandIndex(int blueIndex) Band to be represented in blue.
void	setGreenBandIndex(int greenIndex) Band to be represented in green.
void	setRedBandIndex(int redIndex) Band to be represented in red.
void	setUseBlueBand(boolean bBand) Indicates if the blue band is used.
void	setUseGreenBand(boolean bBand) Indicates if the green band is used.
void	setUseRedBand(boolean bBand) Indicates if the red band is used.

Method Detail

setBandIndices

void setBandIndices(int redIndex,
                    int greenIndex,
                    int blueIndex)
                    throws IOException,
                           AutomationException

Band numbers for red, green, and blue bands.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

redIndex - The redIndex (in)

greenIndex - The greenIndex (in)

blueIndex - The blueIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryBandIndices

void queryBandIndices(int[] redIndex,
                      int[] greenIndex,
                      int[] blueIndex)
                      throws IOException,
                             AutomationException

Band numbers for red, green, and blue bands.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

redIndex - The redIndex (out: use single element array)

greenIndex - The greenIndex (out: use single element array)

blueIndex - The blueIndex (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRedBandIndex

int getRedBandIndex()
                    throws IOException,
                           AutomationException

Band to be represented in red.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The redIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRedBandIndex

void setRedBandIndex(int redIndex)
                     throws IOException,
                            AutomationException

Band to be represented in red.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

redIndex - The redIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGreenBandIndex

int getGreenBandIndex()
                      throws IOException,
                             AutomationException

Band to be represented in green.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The greenIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGreenBandIndex

void setGreenBandIndex(int greenIndex)
                       throws IOException,
                              AutomationException

Band to be represented in green.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

greenIndex - The greenIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBlueBandIndex

int getBlueBandIndex()
                     throws IOException,
                            AutomationException

Band to be represented in blue.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The blueIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBlueBandIndex

void setBlueBandIndex(int blueIndex)
                      throws IOException,
                             AutomationException

Band to be represented in blue.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

blueIndex - The blueIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseRedBand

boolean isUseRedBand()
                     throws IOException,
                            AutomationException

Indicates if the red band is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The bBand

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseRedBand

void setUseRedBand(boolean bBand)
                   throws IOException,
                          AutomationException

Indicates if the red band is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

bBand - The bBand (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseGreenBand

boolean isUseGreenBand()
                       throws IOException,
                              AutomationException

Indicates if the green band is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The bBand

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseGreenBand

void setUseGreenBand(boolean bBand)
                     throws IOException,
                            AutomationException

Indicates if the green band is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

bBand - The bBand (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseBlueBand

boolean isUseBlueBand()
                      throws IOException,
                             AutomationException

Indicates if the blue band is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The bBand

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseBlueBand

void setUseBlueBand(boolean bBand)
                    throws IOException,
                           AutomationException

Indicates if the blue band is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

bBand - The bBand (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.