com.esri.arcgis.animation
Interface ITimeLayerTrackExtension

All Superinterfaces:

Serializable

All Known Implementing Classes:

TimeLayerTrackExtension

public interface ITimeLayerTrackExtension
extends Serializable

Provides access to the properties/methods of the time layer track extension.

Remarks

The major purpose of a time layer track extension is to manage the time windows of time layers. When a new time animation track is created, a time layer track extension is created and attached to it. The time windows of the animation objects (layers) can be accessed through this interface. Also, this interface exposes the options to show track name and/or track time in the display.

Product Availability

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

Method Summary

IArray	getAttachedObjects() Provides access to the objects attached to the track.
ITimeWindow	getTimeWindow(IAGAnimationTrack pTrack, Object pObject) Provides access to the time window for the given object.
IArray	getTimeWindows() Provides access to the time windows for the objects attached to the track.
boolean	isShowTrackName() Indicates whether to show the track name.
boolean	isShowTrackTime() Indicates whether to show the track time.
void	setShowTrackName(boolean pShowTrackName) Indicates whether to show the track name.
void	setShowTrackTime(boolean pShowTrackTime) Indicates whether to show the track time.
void	updateTrackExtension(IAGAnimationTrack pTrack) Provides access to the objects attached to the track.

Method Detail

getTimeWindow

ITimeWindow getTimeWindow(IAGAnimationTrack pTrack,
                          Object pObject)
                          throws IOException,
                                 AutomationException

Provides access to the time window for the given object.

Remarks

Get the time window for a specific time animation object.

Product Availability

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

Parameters:

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

pObject - A reference to another Object (IUnknown) (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeWindows

IArray getTimeWindows()
                      throws IOException,
                             AutomationException

Provides access to the time windows for the objects attached to the track.

Remarks

This property allows you to access the time windows of all the time layers that are attached to the time track.

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.

getAttachedObjects

IArray getAttachedObjects()
                          throws IOException,
                                 AutomationException

Provides access to the objects attached to the track.

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.

updateTrackExtension

void updateTrackExtension(IAGAnimationTrack pTrack)
                          throws IOException,
                                 AutomationException

Provides access to the objects attached to the track.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowTrackName

void setShowTrackName(boolean pShowTrackName)
                      throws IOException,
                             AutomationException

Indicates whether to show the track name.

Product Availability

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

Parameters:

pShowTrackName - The pShowTrackName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowTrackName

boolean isShowTrackName()
                        throws IOException,
                               AutomationException

Indicates whether to show the track name.

Product Availability

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

Returns:

The pShowTrackName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowTrackTime

void setShowTrackTime(boolean pShowTrackTime)
                      throws IOException,
                             AutomationException

Indicates whether to show the track time.

Product Availability

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

Parameters:

pShowTrackTime - The pShowTrackTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowTrackTime

boolean isShowTrackTime()
                        throws IOException,
                               AutomationException

Indicates whether to show the track time.

Product Availability

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

Returns:

The pShowTrackTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.