com.esri.arcgis.trackinganalyst
Interface ITrackRenderer

All Superinterfaces:

Serializable

All Known Implementing Classes:

CoTrackSymbologyRenderer

public interface ITrackRenderer
extends Serializable

Provides access to properties specific to temporal track rendering capabilities.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Method Summary

int	getHistory() Indicates the number of history events composing the track that will be used to represent the track line.
IUID	getPropPageTrackRenderer() Provides the Class ID of the property page associated with the track renderer.
IUID	getPropPageTracksAdvancedRenderer() Provides the Class ID of the property page associated with the advanced renderer of the tracks.
boolean	isNeedsMostCurrentEvents() Indicates whether a list of the most current events is needed so they might be rendered differently than the older events.
boolean	isSmoothTracks() Indicates if the track symbology is smooth or not.
boolean	isTrackAdvRendererEnabled() Indicates whether the tracks are rendered by the track advanced renderer.
boolean	isTrackRendererEnabled() Indicates whether the track events are rendered by the track line renderer.
void	setHistory(int pNumEvents) Indicates the number of history events composing the track that will be used to represent the track line.
void	setPropPageTrackRenderer(IUID ppiPPClassID) Provides the Class ID of the property page associated with the track renderer.
void	setPropPageTracksAdvancedRenderer(IUID ppiPPClassID) Provides the Class ID of the property page associated with the advanced renderer of the tracks.
void	setSmoothTracks(boolean pvbSmooth) Indicates if the track symbology is smooth or not.
void	setTrackAdvRendererEnabled(boolean pvbEnabled) Indicates whether the tracks are rendered by the track advanced renderer.
void	setTrackRendererEnabled(boolean pvbIsTrackEnabled) Indicates whether the track events are rendered by the track line renderer.

Method Detail

isNeedsMostCurrentEvents

boolean isNeedsMostCurrentEvents()
                                 throws IOException,
                                        AutomationException

Indicates whether a list of the most current events is needed so they might be rendered differently than the older events.

Description

Reports if Most Current Event Rendering is enabled for this renderer. Most Current Event Rendering allows the newest event to be rendered differently than the rest of the events in a tracks.

Remarks

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pvbNeedsMostCurrent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHistory

int getHistory()
               throws IOException,
                      AutomationException

Indicates the number of history events composing the track that will be used to represent the track line.

Description

The History property trims the length of the track line displayed when tracks are enabled in the renderer.

Remarks

Setting the History to zero will draw the entire track.

Setting the history for a track does not effect the rendering of its events.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pNumEvents

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHistory

void setHistory(int pNumEvents)
                throws IOException,
                       AutomationException

Indicates the number of history events composing the track that will be used to represent the track line.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pNumEvents - The pNumEvents (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSmoothTracks

boolean isSmoothTracks()
                       throws IOException,
                              AutomationException

Indicates if the track symbology is smooth or not.

Description

Applies a bezier curve to the track lines. This way track lines do not appear to make abrupt changes of direction.

Remarks

You must also enable Advanced Track Rendering for track smoothing to activate. Dynamic Display does not support smoothing of track lines.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pvbSmooth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITrackRenderer

setSmoothTracks

void setSmoothTracks(boolean pvbSmooth)
                     throws IOException,
                            AutomationException

Indicates if the track symbology is smooth or not.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pvbSmooth - The pvbSmooth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTrackRendererEnabled

boolean isTrackRendererEnabled()
                               throws IOException,
                                      AutomationException

Indicates whether the track events are rendered by the track line renderer.

Description

Returns or sets whether tracks are drawn using the track line renderer. The track line renderer connects all of the events in the feature class with the same EventID with a line according to their temporal order.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pvbIsTrackEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTrackRendererEnabled

void setTrackRendererEnabled(boolean pvbIsTrackEnabled)
                             throws IOException,
                                    AutomationException

Indicates whether the track events are rendered by the track line renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pvbIsTrackEnabled - The pvbIsTrackEnabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropPageTrackRenderer

IUID getPropPageTrackRenderer()
                              throws IOException,
                                     AutomationException

Provides the Class ID of the property page associated with the track renderer.

Description

Returns or sets the class ID for the property page to display when modifing the Track Renderer's properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropPageTrackRenderer

void setPropPageTrackRenderer(IUID ppiPPClassID)
                              throws IOException,
                                     AutomationException

Provides the Class ID of the property page associated with the track renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

ppiPPClassID - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropPageTracksAdvancedRenderer

IUID getPropPageTracksAdvancedRenderer()
                                       throws IOException,
                                              AutomationException

Provides the Class ID of the property page associated with the advanced renderer of the tracks.

Description

Returns or sets the class ID for the property page to display when modifing the Track Renderer's advanced properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropPageTracksAdvancedRenderer

void setPropPageTracksAdvancedRenderer(IUID ppiPPClassID)
                                       throws IOException,
                                              AutomationException

Provides the Class ID of the property page associated with the advanced renderer of the tracks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

ppiPPClassID - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTrackAdvRendererEnabled

boolean isTrackAdvRendererEnabled()
                                  throws IOException,
                                         AutomationException

Indicates whether the tracks are rendered by the track advanced renderer.

Description

Returns and sets whether Advanced Track Rendering options are enabled.

Remarks

Since SmoothTracks is an king Rendering option, you must enable this property before using track smoothing.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pvbEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ITrackRenderer

setTrackAdvRendererEnabled

void setTrackAdvRendererEnabled(boolean pvbEnabled)
                                throws IOException,
                                       AutomationException

Indicates whether the tracks are rendered by the track advanced renderer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pvbEnabled - The pvbEnabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.