com.esri.arcgis.analyst3d
Class IAnimationTypeProxy

java.lang.Object
  extended bycom.esri.arcgis.interop.Dispatch
      extended bycom.esri.arcgis.analyst3d.IAnimationTypeProxy
All Implemented Interfaces:
java.io.Externalizable, IAnimationType, java.io.Serializable

public class IAnimationTypeProxy
extends Dispatch
implements IAnimationType, java.io.Serializable

Provides access to the animation type objects.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

See Also:
Serialized Form

Field Summary
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF
 
Constructor Summary
  IAnimationTypeProxy()
          For internal use only
  IAnimationTypeProxy(java.lang.Object obj)
           
protected IAnimationTypeProxy(java.lang.Object obj, java.lang.String iid)
           
  IAnimationTypeProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
           
protected IAnimationTypeProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
          Adds a Java object to be a listener for a specific kind of event generated by the COM object.
 java.lang.Object getAnimationObjectByID(IScene pScene, int objectID)
          The animated object with the given ID.
 int getAnimationObjectID(IScene pScene, java.lang.Object pObject)
          The ID (index) of the given object among those of its animation type in the scene.
 java.lang.String getAnimationObjectName(IScene pScene, java.lang.Object pObject)
          The name of the given object for animation purposes.
 IUID getCLSID()
          The class ID of the animation type.
 int getEnumPropertyMaxValue(int index)
          The maximum value of an integer or long enumerated property.
 int getEnumPropertyMinValue(int index)
          The minimum value of an integer or long enumerated property.
 java.lang.String getEnumPropertyValueName(int index, int value)
          The name of a value in an enumerated property.
 IUID getKeyframeCLSID()
          The class ID of the associated keyframe.
 java.lang.String getName()
          The name of the animation type.
 IArray getObjectArray(IScene pScene)
          The array of objects of this type in the scene.
 int getPropertyCount()
          The number of properties that can be animated.
 java.lang.String getPropertyName(int index)
          The name of the properties that can be animated.
 int getPropertyType(int index)
          The type of the properties that can be animated.
 boolean isAppliesToObject(java.lang.Object pObject)
          Indicates if the animation type applies to a specific object.
 boolean isEnumProperty(int index)
          Indicates if an integer or long property is an enumeration.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Removes a Java object as a listener to events generated by a COM object.
 void resetObject(IScene pScene, java.lang.Object pObject)
          Resets the state of the object, preparing it for animation.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, 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
Constructor Detail

IAnimationTypeProxy

public IAnimationTypeProxy(java.lang.String CLSID,
                           java.lang.String host,
                           AuthInfo authInfo)
                    throws java.net.UnknownHostException,
                           java.io.IOException

IAnimationTypeProxy

public IAnimationTypeProxy()
For internal use only


IAnimationTypeProxy

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

IAnimationTypeProxy

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

IAnimationTypeProxy

protected IAnimationTypeProxy(java.lang.String CLSID,
                              java.lang.String iid,
                              java.lang.String host,
                              AuthInfo authInfo)
                       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
Description copied from class: Dispatch
Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:
addListener in class Dispatch
Parameters:
iidStr - the ID of the outgoing interface, implemented by the listener
theListener - the object to be informed of the events
theSource - the proxy class that represents the COM class that is the source of the events
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Description copied from class: Dispatch
Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:
removeListener in class Dispatch
Parameters:
iidStr - the ID of the outgoing interface, implemented by the listener
theListener - the object that no longer wishes to be informed of the events
Throws:
java.io.IOException

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IAnimationType
The name of the animation type.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IAnimationType
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCLSID

public IUID getCLSID()
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IAnimationType
The class ID of the animation type.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCLSID in interface IAnimationType
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKeyframeCLSID

public IUID getKeyframeCLSID()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IAnimationType
The class ID of the associated keyframe.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getKeyframeCLSID in interface IAnimationType
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAppliesToObject

public boolean isAppliesToObject(java.lang.Object pObject)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IAnimationType
Indicates if the animation type applies to a specific object.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isAppliesToObject in interface IAnimationType
Parameters:
pObject - A Variant (in)
Returns:
The pbApplies
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertyCount

public int getPropertyCount()
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IAnimationType
The number of properties that can be animated.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPropertyCount in interface IAnimationType
Returns:
The pPropCount
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getPropertyType

public int getPropertyType(int index)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IAnimationType
The type of the properties that can be animated.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPropertyType in interface IAnimationType
Parameters:
index - The index (in)
Returns:
A com.esri.arcgis.animation.esriAnimationPropertyType constant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getPropertyName

public java.lang.String getPropertyName(int index)
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IAnimationType
The name of the properties that can be animated.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPropertyName in interface IAnimationType
Parameters:
index - The index (in)
Returns:
The pPropName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEnumProperty

public boolean isEnumProperty(int index)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IAnimationType
Indicates if an integer or long property is an enumeration.

Specified by:
isEnumProperty in interface IAnimationType
Parameters:
index - The index (in)
Returns:
The pbIsEnum
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getEnumPropertyValueName

public java.lang.String getEnumPropertyValueName(int index,
                                                 int value)
                                          throws java.io.IOException,
                                                 AutomationException
Description copied from interface: IAnimationType
The name of a value in an enumerated property.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEnumPropertyValueName in interface IAnimationType
Parameters:
index - The index (in)
value - The value (in)
Returns:
The pValueName
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getEnumPropertyMinValue

public int getEnumPropertyMinValue(int index)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IAnimationType
The minimum value of an integer or long enumerated property.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEnumPropertyMinValue in interface IAnimationType
Parameters:
index - The index (in)
Returns:
The pMinValue
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getEnumPropertyMaxValue

public int getEnumPropertyMaxValue(int index)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IAnimationType
The maximum value of an integer or long enumerated property.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEnumPropertyMaxValue in interface IAnimationType
Parameters:
index - The index (in)
Returns:
The pMaxValue
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getObjectArray

public IArray getObjectArray(IScene pScene)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IAnimationType
The array of objects of this type in the scene.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getObjectArray in interface IAnimationType
Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnimationObjectID

public int getAnimationObjectID(IScene pScene,
                                java.lang.Object pObject)
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IAnimationType
The ID (index) of the given object among those of its animation type in the scene.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAnimationObjectID in interface IAnimationType
Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)
pObject - A Variant (in)
Returns:
The pObjectID
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getAnimationObjectByID

public java.lang.Object getAnimationObjectByID(IScene pScene,
                                               int objectID)
                                        throws java.io.IOException,
                                               AutomationException
Description copied from interface: IAnimationType
The animated object with the given ID.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAnimationObjectByID in interface IAnimationType
Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)
objectID - The objectID (in)
Returns:
A Variant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getAnimationObjectName

public java.lang.String getAnimationObjectName(IScene pScene,
                                               java.lang.Object pObject)
                                        throws java.io.IOException,
                                               AutomationException
Description copied from interface: IAnimationType
The name of the given object for animation purposes.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAnimationObjectName in interface IAnimationType
Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)
pObject - A Variant (in)
Returns:
The pName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetObject

public void resetObject(IScene pScene,
                        java.lang.Object pObject)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IAnimationType
Resets the state of the object, preparing it for animation.

Supported Platforms

Windows, Solaris, Linux

Specified by:
resetObject in interface IAnimationType
Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)
pObject - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.