com.esri.arcgis.carto
Class IDynamicLayerProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IDynamicLayerProxy

All Implemented Interfaces:

IDynamicLayer, java.io.Externalizable, java.io.Serializable

public class IDynamicLayerProxy
extends com.esri.arcgis.interop.Dispatch
implements IDynamicLayer, java.io.Serializable

Internal use class Proxy for COM Interface 'IDynamicLayer'. Generated 3/19/2015 1:20:54 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that work with dynamic display.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

boolean	noncastable
static java.lang.Class	targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IDynamicLayerProxy() For internal use only
	IDynamicLayerProxy(java.lang.Object obj)
protected	IDynamicLayerProxy(java.lang.Object obj, java.lang.String iid)
	IDynamicLayerProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	IDynamicLayerProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
void	drawDynamicLayer(int dynamicDrawPhase, IDisplay display, IDynamicDisplay dynamicDisplay) Draws the layer to the specified display for the given draw phase.
int	getDynamicRecompileRate() Recompile Rate is the interval in milliseconds by which the dynamic layer draw method will be called, with the compiled draw phase.
boolean	isDynamicLayerDirty(int dynamicDrawPhase) Indicates if the dynamic layer has changed since last drawn for the specified draw phase.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	setDynamicLayerDirty(int dynamicDrawPhase, boolean dirty) Indicates if the dynamic layer has changed since last drawn for the specified draw phase.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

IDynamicLayerProxy

public IDynamicLayerProxy(java.lang.String CLSID,
                          java.lang.String host,
                          com.esri.arcgis.interop.AuthInfo authInfo)
                   throws java.net.UnknownHostException,
                          java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

IDynamicLayerProxy

public IDynamicLayerProxy()

For internal use only

IDynamicLayerProxy

public IDynamicLayerProxy(java.lang.Object obj)
                   throws java.io.IOException

Throws:

java.io.IOException

IDynamicLayerProxy

protected IDynamicLayerProxy(java.lang.Object obj,
                             java.lang.String iid)
                      throws java.io.IOException

Throws:

java.io.IOException

IDynamicLayerProxy

protected IDynamicLayerProxy(java.lang.String CLSID,
                             java.lang.String iid,
                             java.lang.String host,
                             com.esri.arcgis.interop.AuthInfo authInfo)
                      throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

isDynamicLayerDirty

public boolean isDynamicLayerDirty(int dynamicDrawPhase)
                            throws java.io.IOException,
                                   AutomationException

Indicates if the dynamic layer has changed since last drawn for the specified draw phase.

Product Availability

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

Specified by:

isDynamicLayerDirty in interface IDynamicLayer

Parameters:

dynamicDrawPhase - A com.esri.arcgis.display.esriDynamicDrawPhase constant (in)

Returns:

The dirty

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDynamicLayerDirty

public void setDynamicLayerDirty(int dynamicDrawPhase,
                                 boolean dirty)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the dynamic layer has changed since last drawn for the specified draw phase.

Product Availability

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

Specified by:

setDynamicLayerDirty in interface IDynamicLayer

Parameters:

dynamicDrawPhase - A com.esri.arcgis.display.esriDynamicDrawPhase constant (in)

dirty - The dirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDynamicRecompileRate

public int getDynamicRecompileRate()
                            throws java.io.IOException,
                                   AutomationException

Recompile Rate is the interval in milliseconds by which the dynamic layer draw method will be called, with the compiled draw phase.

Description

The DynamicRecompileRate is an interval in milliseconds that is used by the Dynamic Map in order to determine whether the Dynamic Layer’s DrawDynamicLayer method needs to be called with the Compiled Phase, in order to recompile the layer’s drawing commands into the layer’s display list.

Remarks

The DynamicLayer’s DrawDynamicLayer method of the Compiled Phase will be called, when the DynamicLayerDirty of the Compiled Phase is true, and only after the DynamicRecompileRate interval had elapsed. The underlying data-structure of the layer may already been updated, however the display would reflect these changes only after the time interval set by DynamicRecompileRate has elapsed.

Using the compiled rate is very efficient for layers that manage large amount of items where every item gets updated in a relatively low rate. This way, due to the large number of items, there are constant updates streaming in, however the changes will get accumulated and will be applied to the display, according to the DynamicRecompileRate interval. That is good, performance wise, since this method minimizes CPU usage, of iterating through the layer items and generating the draw commands, and minimizes bus traffic of the drawing commands to the graphic card.

Product Availability

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

Specified by:

getDynamicRecompileRate in interface IDynamicLayer

Returns:

The dynamicRecompileRateTimeMS

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawDynamicLayer

public void drawDynamicLayer(int dynamicDrawPhase,
                             IDisplay display,
                             IDynamicDisplay dynamicDisplay)
                      throws java.io.IOException,
                             AutomationException

Draws the layer to the specified display for the given draw phase.

Remarks

Use this method to generate the Layer’s draw commands that correspond to the Dynamic Draw Phase.

Make sure to generate the draw commands at the desired Draw Phase. It is recommended for a Dynamic Layer to generate draw commands (and therefore be drawn) in one of the Dynamic Draw Phases, but not both. For example, if the layer is to be drawn only in the Immediate Phase, the method should inspect the drawing phase and only generate draw commands if enum esriDynamicDrawPhase is set to esriDDPImmediate.

Use the Dynamic Display API, and/or OpenGL API in order to generate the draw commands. In the context of the DrawDynamicLayer method, the OpenGL Rendering Context is active and is setup by the Dynamic Map.

Note: The Dynamic Display and OpenGL API's can safely be used only in the context of the IDynamicLayer.DrawDynamicLayer method and IDynamicMapEvents BeforeDynamicDraw\AfterDynamicDraw events. Any attempt to use them in any other context will result in unexpected behavior.

Product Availability

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

Specified by:

drawDynamicLayer in interface IDynamicLayer

Parameters:

dynamicDrawPhase - A com.esri.arcgis.display.esriDynamicDrawPhase constant (in)

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

dynamicDisplay - A reference to a com.esri.arcgis.display.IDynamicDisplay (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.