com.esri.arcgis.animation
Class AGGroupAnimationOptions

java.lang.Object
  extended by com.esri.arcgis.animation.AGGroupAnimationOptions
All Implemented Interfaces:
IAGGroupAnimationOptions, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class AGGroupAnimationOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGGroupAnimationOptions

Options of the 'create group animation' functionality.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
AGGroupAnimationOptions()
          Constructs a AGGroupAnimationOptions using ArcGIS Engine.
AGGroupAnimationOptions(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AGGroupAnimationOptions theAGGroupAnimationOptions = (AGGroupAnimationOptions) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 IAGAnimationEnvironment getAnimationEnvironment()
          The animation environment.
 IAGAnimationTracks getAnimationTracks()
          The animation track container.
static String getClsid()
          getClsid.
 int getFadingPercentage()
          The percentage (0-100) of transparency fading time.
 IArray getLayerSet()
          The layers to animate.
 String getTrackBaseName()
          The base name for the tracks.
 void getTrackInterval(double[] pBeginTime, double[] pEndTime)
          Gets the begin and end times for the group animation.
 void getVisibilitySettings(boolean[] pbOneLayer, boolean[] pbAppear, boolean[] pbReverse)
          Get the visibility settings.
 int hashCode()
          the hashcode for this object
 boolean isBlending()
          Indicates whether to blend layers during animation.
 boolean isCycleAnimation()
          Indicates whether to cycle the group animation.
 boolean isOverwriteExisting()
          Indicates whether to overwrite option.
 void putTrackInterval(double beginTime, double endTime)
          Sets the begin and end times for the group animation.
 void putVisibilitySettings(boolean bOneLayer, boolean bAppear, boolean bReverse)
          Put the visibility settings.
 void setAnimationEnvironmentByRef(IAGAnimationEnvironment ppEnvironment)
          The animation environment.
 void setAnimationTracksByRef(IAGAnimationTracks ppTracks)
          The animation track container.
 void setBlending(boolean pbBlend)
          Indicates whether to blend layers during animation.
 void setCycleAnimation(boolean pbIsCycle)
          Indicates whether to cycle the group animation.
 void setFadingPercentage(int pFadePercent)
          The percentage (0-100) of transparency fading time.
 void setLayerSetByRef(IArray ppLayerSet)
          The layers to animate.
 void setOverwriteExisting(boolean pbOverwrite)
          Indicates whether to overwrite option.
 void setTrackBaseName(String pTrackName)
          The base name for the tracks.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

AGGroupAnimationOptions

public AGGroupAnimationOptions()
                        throws IOException,
                               UnknownHostException
Constructs a AGGroupAnimationOptions using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

AGGroupAnimationOptions

public AGGroupAnimationOptions(Object obj)
                        throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AGGroupAnimationOptions theAGGroupAnimationOptions = (AGGroupAnimationOptions) obj;

Construct a AGGroupAnimationOptions using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AGGroupAnimationOptions.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getAnimationTracks

public IAGAnimationTracks getAnimationTracks()
                                      throws IOException,
                                             AutomationException
The animation track container.

Product Availability

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

Specified by:
getAnimationTracks in interface IAGGroupAnimationOptions
Returns:
A reference to a com.esri.arcgis.animation.IAGAnimationTracks
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnimationTracksByRef

public void setAnimationTracksByRef(IAGAnimationTracks ppTracks)
                             throws IOException,
                                    AutomationException
The animation track container.

Product Availability

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

Specified by:
setAnimationTracksByRef in interface IAGGroupAnimationOptions
Parameters:
ppTracks - A reference to a com.esri.arcgis.animation.IAGAnimationTracks (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnimationEnvironment

public IAGAnimationEnvironment getAnimationEnvironment()
                                                throws IOException,
                                                       AutomationException
The animation environment.

Product Availability

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

Specified by:
getAnimationEnvironment in interface IAGGroupAnimationOptions
Returns:
A reference to a com.esri.arcgis.animation.IAGAnimationEnvironment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnimationEnvironmentByRef

public void setAnimationEnvironmentByRef(IAGAnimationEnvironment ppEnvironment)
                                  throws IOException,
                                         AutomationException
The animation environment.

Product Availability

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

Specified by:
setAnimationEnvironmentByRef in interface IAGGroupAnimationOptions
Parameters:
ppEnvironment - A reference to a com.esri.arcgis.animation.IAGAnimationEnvironment (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerSet

public IArray getLayerSet()
                   throws IOException,
                          AutomationException
The layers to animate.

Product Availability

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

Specified by:
getLayerSet in interface IAGGroupAnimationOptions
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLayerSetByRef

public void setLayerSetByRef(IArray ppLayerSet)
                      throws IOException,
                             AutomationException
The layers to animate.

Product Availability

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

Specified by:
setLayerSetByRef in interface IAGGroupAnimationOptions
Parameters:
ppLayerSet - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrackBaseName

public String getTrackBaseName()
                        throws IOException,
                               AutomationException
The base name for the tracks.

Product Availability

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

Specified by:
getTrackBaseName in interface IAGGroupAnimationOptions
Returns:
The pTrackName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrackBaseName

public void setTrackBaseName(String pTrackName)
                      throws IOException,
                             AutomationException
The base name for the tracks.

Product Availability

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

Specified by:
setTrackBaseName in interface IAGGroupAnimationOptions
Parameters:
pTrackName - The pTrackName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVisibilitySettings

public void getVisibilitySettings(boolean[] pbOneLayer,
                                  boolean[] pbAppear,
                                  boolean[] pbReverse)
                           throws IOException,
                                  AutomationException
Get the visibility settings.

Product Availability

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

Specified by:
getVisibilitySettings in interface IAGGroupAnimationOptions
Parameters:
pbOneLayer - The pbOneLayer (out: use single element array)
pbAppear - The pbAppear (out: use single element array)
pbReverse - The pbReverse (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putVisibilitySettings

public void putVisibilitySettings(boolean bOneLayer,
                                  boolean bAppear,
                                  boolean bReverse)
                           throws IOException,
                                  AutomationException
Put the visibility settings.

Product Availability

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

Specified by:
putVisibilitySettings in interface IAGGroupAnimationOptions
Parameters:
bOneLayer - The bOneLayer (in)
bAppear - The bAppear (in)
bReverse - The bReverse (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFadingPercentage

public int getFadingPercentage()
                        throws IOException,
                               AutomationException
The percentage (0-100) of transparency fading time.

Product Availability

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

Specified by:
getFadingPercentage in interface IAGGroupAnimationOptions
Returns:
The pFadePercent
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFadingPercentage

public void setFadingPercentage(int pFadePercent)
                         throws IOException,
                                AutomationException
The percentage (0-100) of transparency fading time.

Product Availability

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

Specified by:
setFadingPercentage in interface IAGGroupAnimationOptions
Parameters:
pFadePercent - The pFadePercent (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBlending

public boolean isBlending()
                   throws IOException,
                          AutomationException
Indicates whether to blend layers during animation.

Product Availability

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

Specified by:
isBlending in interface IAGGroupAnimationOptions
Returns:
The pbBlend
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBlending

public void setBlending(boolean pbBlend)
                 throws IOException,
                        AutomationException
Indicates whether to blend layers during animation.

Product Availability

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

Specified by:
setBlending in interface IAGGroupAnimationOptions
Parameters:
pbBlend - The pbBlend (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCycleAnimation

public boolean isCycleAnimation()
                         throws IOException,
                                AutomationException
Indicates whether to cycle the group animation.

Product Availability

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

Specified by:
isCycleAnimation in interface IAGGroupAnimationOptions
Returns:
The pbIsCycle
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCycleAnimation

public void setCycleAnimation(boolean pbIsCycle)
                       throws IOException,
                              AutomationException
Indicates whether to cycle the group animation.

Product Availability

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

Specified by:
setCycleAnimation in interface IAGGroupAnimationOptions
Parameters:
pbIsCycle - The pbIsCycle (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrackInterval

public void getTrackInterval(double[] pBeginTime,
                             double[] pEndTime)
                      throws IOException,
                             AutomationException
Gets the begin and end times for the group animation.

Product Availability

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

Specified by:
getTrackInterval in interface IAGGroupAnimationOptions
Parameters:
pBeginTime - The pBeginTime (out: use single element array)
pEndTime - The pEndTime (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putTrackInterval

public void putTrackInterval(double beginTime,
                             double endTime)
                      throws IOException,
                             AutomationException
Sets the begin and end times for the group animation.

Product Availability

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

Specified by:
putTrackInterval in interface IAGGroupAnimationOptions
Parameters:
beginTime - The beginTime (in)
endTime - The endTime (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOverwriteExisting

public boolean isOverwriteExisting()
                            throws IOException,
                                   AutomationException
Indicates whether to overwrite option.

Product Availability

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

Specified by:
isOverwriteExisting in interface IAGGroupAnimationOptions
Returns:
The pbOverwrite
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverwriteExisting

public void setOverwriteExisting(boolean pbOverwrite)
                          throws IOException,
                                 AutomationException
Indicates whether to overwrite option.

Product Availability

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

Specified by:
setOverwriteExisting in interface IAGGroupAnimationOptions
Parameters:
pbOverwrite - The pbOverwrite (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.