com.esri.arcgis.animation
Interface IAGGroupAnimationOptions

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AGGroupAnimationOptions, IAGGroupAnimationOptionsProxy

public interface IAGGroupAnimationOptions
extends java.io.Serializable

COM Interface 'IAGGroupAnimationOptions'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriAnimation.olb'

Description: 'Provides access to options of the 'create group animation' functionality.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDa09e0261_ae4f_4351_a482_72a3f805380b
static int	xxDummy Deprecated. Internal use only

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.
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.
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(java.lang.String pTrackName) The base name for the tracks.

Field Detail

IIDa09e0261_ae4f_4351_a482_72a3f805380b

static final int IIDa09e0261_ae4f_4351_a482_72a3f805380b

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getAnimationTracks

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

The animation track container.

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

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

The animation track container.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAnimationEnvironment

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

The animation environment.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAnimationEnvironmentByRef

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

The animation environment.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerSet

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

The layers to animate.

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.

setLayerSetByRef

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

The layers to animate.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackBaseName

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

The base name for the tracks.

Returns:

The pTrackName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTrackBaseName

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

The base name for the tracks.

Parameters:

pTrackName - The pTrackName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVisibilitySettings

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

Get the visibility settings.

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:

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

AutomationException - If the ArcObject component throws an exception.

putVisibilitySettings

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

Put the visibility settings.

Parameters:

bOneLayer - The bOneLayer (in)

bAppear - The bAppear (in)

bReverse - The bReverse (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFadingPercentage

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

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

Returns:

The pFadePercent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFadingPercentage

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

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

Parameters:

pFadePercent - The pFadePercent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBlending

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

Indicates whether to blend layers during animation.

Returns:

The pbBlend

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBlending

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

Indicates whether to blend layers during animation.

Parameters:

pbBlend - The pbBlend (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCycleAnimation

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

Indicates whether to cycle the group animation.

Returns:

The pbIsCycle

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCycleAnimation

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

Indicates whether to cycle the group animation.

Parameters:

pbIsCycle - The pbIsCycle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackInterval

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

Gets the begin and end times for the group animation.

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

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

Sets the begin and end times for the group animation.

Parameters:

beginTime - The beginTime (in)

endTime - The endTime (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isOverwriteExisting

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

Indicates whether to overwrite option.

Returns:

The pbOverwrite

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOverwriteExisting

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

Indicates whether to overwrite option.

Parameters:

pbOverwrite - The pbOverwrite (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.