com.esri.arcgis.carto
Interface ILayerEffects

All Superinterfaces:
Serializable
All Known Implementing Classes:
CadAnnotationLayer, CadastralFabricLayer, CadFeatureLayer, CadLayer, CoverageAnnotationLayer, DimensionLayer, FDOGraphicsLayer, FeatureLayer, FeatureLayerDrawingDescription, GdbRasterCatalogLayer, GlobeGraphicsLayer, GlobeLayer, GlobeServerLayer, GraphicsLayer3D, GroupLayer, HorizontalBarLegendItem, HorizontalLegendItem, ImageServerLayer, IMSMapLayer, KmlLayer, MapServerLayer, NestedLegendItem, NetworkLayer, RasterCatalogLayer, RasterLayer, RasterLayerDrawingDescription, TerrainLayer, TinLayer, TopologyLayer, VerticalLegendItem, WCSLayer, WMSMapLayer

public interface ILayerEffects
extends Serializable

Provides access to members that control layer effects.

Remarks

Use this interface to changes brightness, contrast, and transparency for a layer. The controls on the Effects toolbar in ArcMap utilize this interface. Not all layers support all layer effects. For example, FeatureLayer objects only support transparency, while RasterLayer objects support all effects. Before you attempt to change a layer effect, you should check to see if the layer supports the effect. Use SupportsBrightnessChange, SupportsContrastChange, and SupportsTransparency for this.

The display settings on your computer must be set to True Color for layer effects to work correctly.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 short getBrightness()
          Layer brightness in percent (-100 - 100).
 short getContrast()
          Layer contrast in percent (-100 - 100).
 short getTransparency()
          Layer transparency in percent (0-100).
 boolean isSupportsBrightnessChange()
          Indicates if the layer supports brightness changes.
 boolean isSupportsContrastChange()
          Indicates if the layer supports contrast changes.
 boolean isSupportsInteractive()
          Indicates if the layer supports interactive effects changes.
 boolean isSupportsTransparency()
          Indicates if the layer supports transparency.
 void setBrightness(short brightnessValue)
          Layer brightness in percent (-100 - 100).
 void setContrast(short contrastValue)
          Layer contrast in percent (-100 - 100).
 void setSupportsInteractive(boolean supported)
          Indicates if the layer supports interactive effects changes.
 void setTransparency(short alpha)
          Layer transparency in percent (0-100).
 

Method Detail

isSupportsTransparency

boolean isSupportsTransparency()
                               throws IOException,
                                      AutomationException
Indicates if the layer supports transparency.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isSupportsContrastChange

boolean isSupportsContrastChange()
                                 throws IOException,
                                        AutomationException
Indicates if the layer supports contrast changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isSupportsBrightnessChange

boolean isSupportsBrightnessChange()
                                   throws IOException,
                                          AutomationException
Indicates if the layer supports brightness changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setSupportsInteractive

void setSupportsInteractive(boolean supported)
                            throws IOException,
                                   AutomationException
Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
supported - The supported (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsInteractive

boolean isSupportsInteractive()
                              throws IOException,
                                     AutomationException
Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getTransparency

short getTransparency()
                      throws IOException,
                             AutomationException
Layer transparency in percent (0-100).

Remarks

When you set Transparency for a FeatureLayer, a TransparencyDisplayFilter is created and applied to the layer. You can accomplish the same effect by manually creating a new TransparencyDisplayFilter using IDisplayFilter, and then assigning it to a layer using IDisplayFilterManager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setTransparency

void setTransparency(short alpha)
                     throws IOException,
                            AutomationException
Layer transparency in percent (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
alpha - The alpha (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContrast

short getContrast()
                  throws IOException,
                         AutomationException
Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setContrast

void setContrast(short contrastValue)
                 throws IOException,
                        AutomationException
Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
contrastValue - The contrastValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBrightness

short getBrightness()
                    throws IOException,
                           AutomationException
Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setBrightness

void setBrightness(short brightnessValue)
                   throws IOException,
                          AutomationException
Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
brightnessValue - The brightnessValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.