com.esri.arcgis.animation
Interface IAGGroupAnimationOptions

All Superinterfaces:

Serializable

All Known Implementing Classes:

AGGroupAnimationOptions

public interface IAGGroupAnimationOptions
extends Serializable

Provides access to options of the 'create group animation' functionality.

Remarks

An AGGroupAnimationOptions object is required when creating a group animation. The IAGGroupAnimationOptions interface provides access to the options in creating group animation.

Product Availability

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

Method Summary

IAGAnimationEnvironment	getAnimationEnvironment() The animation environment.
IAGAnimationTracks	getAnimationTracks() The animation track container.
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.
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.

Method Detail

getAnimationTracks

IAGAnimationTracks getAnimationTracks()
                                      throws IOException,
                                             AutomationException

The animation track container.

Product Availability

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

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

void setAnimationTracksByRef(IAGAnimationTracks ppTracks)
                             throws IOException,
                                    AutomationException

The animation track container.

Product Availability

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

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

IAGAnimationEnvironment getAnimationEnvironment()
                                                throws IOException,
                                                       AutomationException

The animation environment.

Product Availability

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

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

void setAnimationEnvironmentByRef(IAGAnimationEnvironment ppEnvironment)
                                  throws IOException,
                                         AutomationException

The animation environment.

Product Availability

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

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

IArray getLayerSet()
                   throws IOException,
                          AutomationException

The layers to animate.

Product Availability

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

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

void setLayerSetByRef(IArray ppLayerSet)
                      throws IOException,
                             AutomationException

The layers to animate.

Product Availability

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

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

String getTrackBaseName()
                        throws IOException,
                               AutomationException

The base name for the tracks.

Product Availability

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

Returns:

The pTrackName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTrackBaseName

void setTrackBaseName(String pTrackName)
                      throws IOException,
                             AutomationException

The base name for the tracks.

Product Availability

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

Parameters:

pTrackName - The pTrackName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVisibilitySettings

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.

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

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.

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

int getFadingPercentage()
                        throws IOException,
                               AutomationException

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

Product Availability

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

Returns:

The pFadePercent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFadingPercentage

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.

Parameters:

pFadePercent - The pFadePercent (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBlending

boolean isBlending()
                   throws IOException,
                          AutomationException

Indicates whether to blend layers during animation.

Product Availability

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

Returns:

The pbBlend

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBlending

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.

Parameters:

pbBlend - The pbBlend (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCycleAnimation

boolean isCycleAnimation()
                         throws IOException,
                                AutomationException

Indicates whether to cycle the group animation.

Product Availability

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

Returns:

The pbIsCycle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCycleAnimation

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.

Parameters:

pbIsCycle - The pbIsCycle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackInterval

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.

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

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.

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

boolean isOverwriteExisting()
                            throws IOException,
                                   AutomationException

Indicates whether to overwrite option.

Product Availability

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

Returns:

The pbOverwrite

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverwriteExisting

void setOverwriteExisting(boolean pbOverwrite)
                          throws IOException,
                                 AutomationException

Indicates whether to overwrite option.

Product Availability

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

Parameters:

pbOverwrite - The pbOverwrite (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.