com.esri.arcgis.analyst3d
Class AnimationTypeCamera

java.lang.Object
  com.esri.arcgis.analyst3d.AnimationTypeCamera

All Implemented Interfaces:

IAGAnimationType, IAGAnimationTypeUI, IAnimationType, java.io.Serializable

public class AnimationTypeCamera

extends java.lang.Object

implements IAnimationType, IAGAnimationType, IAGAnimationTypeUI

The Camera Animation Type coclass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

AnimationTypeCamera is one of the three built-in animation types (the other two are AnimationTypeLayer and AnimationTypeScene) that are associated with an animation track.

See Also:

Serialized Form

Constructor Summary

AnimationTypeCamera()
Constructs a AnimationTypeCamera using ArcGIS Engine.

AnimationTypeCamera(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
int	getAnimationClass() The class of the animation type.
java.lang.Object	getAnimationObjectByID(IAGAnimationContainer pContainer, int objectID) The animated object with the given ID.
java.lang.Object	getAnimationObjectByID(IScene pScene, int objectID) The animated object with the given ID.
int	getAnimationObjectID(IAGAnimationContainer pContainer, java.lang.Object pObject) The ID (index) of the given object among those of its animation type.
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(IAGAnimationContainer pContainer, java.lang.Object pObject) The name of the given object for animation purposes.
java.lang.String	getAnimationObjectName(IScene pScene, java.lang.Object pObject) The name of the given object for animation purposes.
IAGAnimationType	getAsIAGAnimationType() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IAGAnimationTypeUI	getAsIAGAnimationTypeUI() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IAnimationType	getAsIAnimationType() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IStringArray	getChoiceList(int propIndex, int columnIndex) The column choice list.
static java.lang.String	getClsid()
IUID	getCLSID() The class ID of the animation type.
int	getColumnCount(int propIndex) The number of columns.
java.lang.String	getColumnName(int propIndex, int columnIndex) The column name.
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(IAGAnimationContainer pContainer) The array of objects of this 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.
int	hashCode() the hashcode for this object
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	resetObject(IAGAnimationContainer pContainer, java.lang.Object pObject) Resets the state of the object, preparing it for animation.
void	resetObject(IScene pScene, java.lang.Object pObject) Resets the state of the object, preparing it for animation.
void	updateTrackExtensions(IAGAnimationTrack pTrack) Creates or modifies extensions of the given track when its type is assigned or objects are attached/detached.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnimationTypeCamera

public AnimationTypeCamera()
                    throws java.io.IOException,
                           java.net.UnknownHostException

Constructs a AnimationTypeCamera using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AnimationTypeCamera

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a AnimationTypeCamera using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AnimationTypeCamera.
AnimationTypeCamera theAnimationTypeCamera = (AnimationTypeCamera) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIAnimationType

public IAnimationType getAsIAnimationType()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAGAnimationType

public IAGAnimationType getAsIAGAnimationType()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAGAnimationTypeUI

public IAGAnimationTypeUI getAsIAGAnimationTypeUI()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

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.

getAnimationClass

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

Description copied from interface: IAGAnimationType

The class of the animation type.

Specified by:

getAnimationClass in interface IAGAnimationType

Returns:

A com.esri.arcgis.animation.esriAnimationClass constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getObjectArray

public IArray getObjectArray(IAGAnimationContainer pContainer)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IAGAnimationType

The array of objects of this type.

Specified by:

getObjectArray in interface IAGAnimationType

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getAnimationObjectID

public int getAnimationObjectID(IAGAnimationContainer pContainer,
                                java.lang.Object pObject)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IAGAnimationType

The ID (index) of the given object among those of its animation type.

Remarks

This property returns the ID or index of an animation object among those of the same animation type. For example, if the object is a time layer in ArcMap, then AnimationObjectID will return the index of the object in the ArcMap TOC.

Specified by:

getAnimationObjectID in interface IAGAnimationType

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (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(IAGAnimationContainer pContainer,
                                               int objectID)
                                        throws java.io.IOException,
                                               AutomationException

Description copied from interface: IAGAnimationType

The animated object with the given ID.

Specified by:

getAnimationObjectByID in interface IAGAnimationType

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

objectID - The objectID (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAnimationObjectName

public java.lang.String getAnimationObjectName(IAGAnimationContainer pContainer,
                                               java.lang.Object pObject)
                                        throws java.io.IOException,
                                               AutomationException

Description copied from interface: IAGAnimationType

The name of the given object for animation purposes.

Specified by:

getAnimationObjectName in interface IAGAnimationType

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (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(IAGAnimationContainer pContainer,
                        java.lang.Object pObject)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IAGAnimationType

Resets the state of the object, preparing it for animation.

Specified by:

resetObject in interface IAGAnimationType

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

pObject - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateTrackExtensions

public void updateTrackExtensions(IAGAnimationTrack pTrack)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IAGAnimationType

Creates or modifies extensions of the given track when its type is assigned or objects are attached/detached.

Specified by:

updateTrackExtensions in interface IAGAnimationType

Parameters:

pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumnCount

public int getColumnCount(int propIndex)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IAGAnimationTypeUI

The number of columns.

Specified by:

getColumnCount in interface IAGAnimationTypeUI

Parameters:

propIndex - The propIndex (in)

Returns:

The count

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getColumnName

public java.lang.String getColumnName(int propIndex,
                                      int columnIndex)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IAGAnimationTypeUI

The column name.

Specified by:

getColumnName in interface IAGAnimationTypeUI

Parameters:

propIndex - The propIndex (in)

columnIndex - The columnIndex (in)

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getChoiceList

public IStringArray getChoiceList(int propIndex,
                                  int columnIndex)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IAGAnimationTypeUI

The column choice list.

Specified by:

getChoiceList in interface IAGAnimationTypeUI

Parameters:

propIndex - The propIndex (in)

columnIndex - The columnIndex (in)

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

AutomationException - If the ArcObject component throws an exception.

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