com.esri.arcgis.animation
Class AGGroupAnimationOptions

java.lang.Object
  com.esri.arcgis.animation.AGGroupAnimationOptions

All Implemented Interfaces:

IAGGroupAnimationOptions, java.io.Serializable

public class AGGroupAnimationOptions

extends java.lang.Object

implements 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(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
IAGAnimationEnvironment	getAnimationEnvironment() The animation environment.
IAGAnimationTracks	getAnimationTracks() The animation track container.
IAGGroupAnimationOptions	getAsIAGGroupAnimationOptions() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
static java.lang.String	getClsid()
int	getFadingPercentage() The percentage (0-100) of transparency fading time.
IArray	getLayerSet() The layers to animate.
java.lang.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() The option to blend layers during animation.
boolean	isCycleAnimation() The option to cycle the group animation.
boolean	isOverwriteExisting() The overwriting 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) The option to blend layers during animation.
void	setCycleAnimation(boolean pbIsCycle) The option 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) The overwriting option.
void	setTrackBaseName(java.lang.String pTrackName) The base name for the tracks.

Methods inherited from class java.lang.Object

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

Constructor Detail

AGGroupAnimationOptions

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

Constructs a AGGroupAnimationOptions using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AGGroupAnimationOptions

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

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

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.
AGGroupAnimationOptions theAGGroupAnimationOptions = (AGGroupAnimationOptions) 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()

getAsIAGGroupAnimationOptions

public IAGGroupAnimationOptions getAsIAGGroupAnimationOptions()

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

getAnimationTracks

public IAGAnimationTracks getAnimationTracks()
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IAGGroupAnimationOptions

The animation track container.

Specified by:

getAnimationTracks in interface IAGGroupAnimationOptions

Returns:

A reference to a com.esri.arcgis.animation.IAGAnimationTracks

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAnimationTracksByRef

public void setAnimationTracksByRef(IAGAnimationTracks ppTracks)
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IAGGroupAnimationOptions

The animation track container.

Specified by:

setAnimationTracksByRef in interface IAGGroupAnimationOptions

Parameters:

ppTracks - A reference to a com.esri.arcgis.animation.IAGAnimationTracks (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getAnimationEnvironment

public IAGAnimationEnvironment getAnimationEnvironment()
                                                throws java.io.IOException,
                                                       AutomationException

Description copied from interface: IAGGroupAnimationOptions

The animation environment.

Specified by:

getAnimationEnvironment in interface IAGGroupAnimationOptions

Returns:

A reference to a com.esri.arcgis.animation.IAGAnimationEnvironment

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setAnimationEnvironmentByRef

public void setAnimationEnvironmentByRef(IAGAnimationEnvironment ppEnvironment)
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IAGGroupAnimationOptions

The animation environment.

Specified by:

setAnimationEnvironmentByRef in interface IAGGroupAnimationOptions

Parameters:

ppEnvironment - A reference to a com.esri.arcgis.animation.IAGAnimationEnvironment (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getLayerSet

public IArray getLayerSet()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IAGGroupAnimationOptions

The layers to animate.

Specified by:

getLayerSet in interface IAGGroupAnimationOptions

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.

setLayerSetByRef

public void setLayerSetByRef(IArray ppLayerSet)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IAGGroupAnimationOptions

The layers to animate.

Specified by:

setLayerSetByRef in interface IAGGroupAnimationOptions

Parameters:

ppLayerSet - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getTrackBaseName

public java.lang.String getTrackBaseName()
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IAGGroupAnimationOptions

The base name for the tracks.

Specified by:

getTrackBaseName in interface IAGGroupAnimationOptions

Returns:

The pTrackName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTrackBaseName

public void setTrackBaseName(java.lang.String pTrackName)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IAGGroupAnimationOptions

The base name for the tracks.

Specified by:

setTrackBaseName in interface IAGGroupAnimationOptions

Parameters:

pTrackName - The pTrackName (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getVisibilitySettings

public void getVisibilitySettings(boolean[] pbOneLayer,
                                  boolean[] pbAppear,
                                  boolean[] pbReverse)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IAGGroupAnimationOptions

Get the visibility settings.

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:

AutomationException - If the ArcObject component throws an exception.

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

putVisibilitySettings

public void putVisibilitySettings(boolean bOneLayer,
                                  boolean bAppear,
                                  boolean bReverse)
                           throws java.io.IOException,
                                  AutomationException

Description copied from interface: IAGGroupAnimationOptions

Put the visibility settings.

Specified by:

putVisibilitySettings in interface IAGGroupAnimationOptions

Parameters:

bOneLayer - The bOneLayer (in)

bAppear - The bAppear (in)

bReverse - The bReverse (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFadingPercentage

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

Description copied from interface: IAGGroupAnimationOptions

The percentage (0-100) of transparency fading time.

Specified by:

getFadingPercentage in interface IAGGroupAnimationOptions

Returns:

The pFadePercent

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setFadingPercentage

public void setFadingPercentage(int pFadePercent)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IAGGroupAnimationOptions

The percentage (0-100) of transparency fading time.

Specified by:

setFadingPercentage in interface IAGGroupAnimationOptions

Parameters:

pFadePercent - The pFadePercent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBlending

public boolean isBlending()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IAGGroupAnimationOptions

The option to blend layers during animation.

Specified by:

isBlending in interface IAGGroupAnimationOptions

Returns:

The pbBlend

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setBlending

public void setBlending(boolean pbBlend)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IAGGroupAnimationOptions

The option to blend layers during animation.

Specified by:

setBlending in interface IAGGroupAnimationOptions

Parameters:

pbBlend - The pbBlend (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isCycleAnimation

public boolean isCycleAnimation()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IAGGroupAnimationOptions

The option to cycle the group animation.

Specified by:

isCycleAnimation in interface IAGGroupAnimationOptions

Returns:

The pbIsCycle

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCycleAnimation

public void setCycleAnimation(boolean pbIsCycle)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IAGGroupAnimationOptions

The option to cycle the group animation.

Specified by:

setCycleAnimation in interface IAGGroupAnimationOptions

Parameters:

pbIsCycle - The pbIsCycle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackInterval

public void getTrackInterval(double[] pBeginTime,
                             double[] pEndTime)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IAGGroupAnimationOptions

Gets the begin and end times for the group animation.

Specified by:

getTrackInterval in interface IAGGroupAnimationOptions

Parameters:

pBeginTime - The pBeginTime (out: use single element array)

pEndTime - The pEndTime (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putTrackInterval

public void putTrackInterval(double beginTime,
                             double endTime)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IAGGroupAnimationOptions

Sets the begin and end times for the group animation.

Specified by:

putTrackInterval in interface IAGGroupAnimationOptions

Parameters:

beginTime - The beginTime (in)

endTime - The endTime (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isOverwriteExisting

public boolean isOverwriteExisting()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IAGGroupAnimationOptions

The overwriting option.

Specified by:

isOverwriteExisting in interface IAGGroupAnimationOptions

Returns:

The pbOverwrite

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOverwriteExisting

public void setOverwriteExisting(boolean pbOverwrite)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IAGGroupAnimationOptions

The overwriting option.

Specified by:

setOverwriteExisting in interface IAGGroupAnimationOptions

Parameters:

pbOverwrite - The pbOverwrite (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.