com.esri.arcgis.analyst3d
Interface IAnimationTrack

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AnimationTrack, IAnimationTrackProxy

public interface IAnimationTrack
extends java.io.Serializable

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

Description: 'Provides access to animation tracks.' 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	IIDbbf1af31_a6ec_11d5_b2a0_00508bcdde28
static int	xxDummy Deprecated. Internal use only

Method Summary

void	attachObject(java.lang.Object pObject) Attach object to the track.
void	detachAllObjects() Detach all objects from the track.
void	detachObject(java.lang.Object pObject) Detach object from the track.
void	findKeyframe(java.lang.String name, IKeyframe[] ppKeyframe) Finds a keyframe by name.
ILongArray	getActiveProperties() The combination of active properties for the track.
IAnimationType	getAnimationType() The animation type.
IArray	getAttachedObjects() The objects to which the track is attached, or null.
int	getAttachedObjectsCount() The number of objects to which the track is attached.
double	getBeginTime() The initial time of the track.
double	getEndTime() The final time of the track.
IKeyframe	getKeyframe(int index) The keyframe with the given index in the track.
int	getKeyframeCount() The number of keyframes defined in the track.
java.lang.String	getName() The name of the track.
void	insertKeyframe(IKeyframe pKeyframe, int index) Inserts a new keyframe.
void	interpolateObjectProperties(IScene pScene, double time) Interpolates the state of the attached object for a time between BeginTime and Endtime.
boolean	isActiveProperty(int propIndex) Indicates if an animation property is active.
boolean	isApplyToAllViewers() Indicates whether to apply a camera track to all scene viewers.
boolean	isAttached(java.lang.Object pObject) Indicates if the given objects is attached to the track.
boolean	isCycle() Indicates if the track is repeated periodically.
boolean	isEnabled() Indicates if the track is enabled.
boolean	isEvenTimeStamps() Indicates whether to distribute time stamps evenly in the interval 0-1.
void	moveKeyframe(int originIndex, int destinationIndex) Moves the keyframe with the given index, inserting it with a different index.
void	removeAllKeyframes() Removes all the keyframes.
void	removeKeyframe(int index) Removes the keyframe with the given index.
void	resetAttachedObjects(IScene pScene) Reset the state of the attached objects to be ready for animation.
void	resetTimeStamps() Redistributes the time stamps in the interval [0,1].
void	restoreObjectProperties(IScene pScene, int index) Restores the saved properties of the attached object specified.
void	saveObjectProperties(IScene pScene, int index) Internally saves the properties of the attached object specified.
void	setActiveProperties(ILongArray ppActiveProps) The combination of active properties for the track.
void	setAnimationTypeByRef(IAnimationType ppAnimationType) The animation type.
void	setApplyToAllViewers(boolean pbApplyToAllViewers) Indicates whether to apply a camera track to all scene viewers.
void	setAttachedObjects(IArray ppObjectArray) The objects to which the track is attached, or null.
void	setBeginTime(double pBeginTime) The initial time of the track.
void	setEndTime(double pEndTime) The final time of the track.
void	setEvenTimeStamps(boolean pbEvenTimeStamps) Indicates whether to distribute time stamps evenly in the interval 0-1.
void	setIsActiveProperty(int propIndex, boolean pbIsActiveProp) Indicates if an animation property is active.
void	setIsCycle(boolean pbIsCycle) Indicates if the track is repeated periodically.
void	setIsEnabled(boolean pbIsEnabled) Indicates if the track is enabled.
void	setName(java.lang.String name) The name of the track.
void	sortKeyframes() Sorts the keyframes in ascending time order.

Field Detail

IIDbbf1af31_a6ec_11d5_b2a0_00508bcdde28

static final int IIDbbf1af31_a6ec_11d5_b2a0_00508bcdde28

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

getActiveProperties

ILongArray getActiveProperties()
                               throws java.io.IOException,
                                      AutomationException

The combination of active properties for the track.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setActiveProperties

void setActiveProperties(ILongArray ppActiveProps)
                         throws java.io.IOException,
                                AutomationException

The combination of active properties for the track.

Parameters:

ppActiveProps - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isActiveProperty

boolean isActiveProperty(int propIndex)
                         throws java.io.IOException,
                                AutomationException

Indicates if an animation property is active.

Parameters:

propIndex - The propIndex (in)

Returns:

The pbIsActiveProp

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsActiveProperty

void setIsActiveProperty(int propIndex,
                         boolean pbIsActiveProp)
                         throws java.io.IOException,
                                AutomationException

Indicates if an animation property is active.

Parameters:

propIndex - The propIndex (in)

pbIsActiveProp - The pbIsActiveProp (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The name of the track.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

The name of the track.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAnimationType

IAnimationType getAnimationType()
                                throws java.io.IOException,
                                       AutomationException

The animation type.

Returns:

A reference to a com.esri.arcgis.analyst3d.IAnimationType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAnimationTypeByRef

void setAnimationTypeByRef(IAnimationType ppAnimationType)
                           throws java.io.IOException,
                                  AutomationException

The animation type.

Parameters:

ppAnimationType - A reference to a com.esri.arcgis.analyst3d.IAnimationType (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getKeyframeCount

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

The number of keyframes defined in the track.

Returns:

The pKeyframeCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getKeyframe

IKeyframe getKeyframe(int index)
                      throws java.io.IOException,
                             AutomationException

The keyframe with the given index in the track.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.analyst3d.IKeyframe

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCycle

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

Indicates if the track is repeated periodically.

Returns:

The pbIsCycle

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsCycle

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

Indicates if the track is repeated periodically.

Parameters:

pbIsCycle - The pbIsCycle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBeginTime

double getBeginTime()
                    throws java.io.IOException,
                           AutomationException

The initial time of the track.

Returns:

The pBeginTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBeginTime

void setBeginTime(double pBeginTime)
                  throws java.io.IOException,
                         AutomationException

The initial time of the track.

Parameters:

pBeginTime - The pBeginTime (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEndTime

double getEndTime()
                  throws java.io.IOException,
                         AutomationException

The final time of the track.

Returns:

The pEndTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEndTime

void setEndTime(double pEndTime)
                throws java.io.IOException,
                       AutomationException

The final time of the track.

Parameters:

pEndTime - The pEndTime (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnabled

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

Indicates if the track is enabled.

Returns:

The pbIsEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsEnabled

void setIsEnabled(boolean pbIsEnabled)
                  throws java.io.IOException,
                         AutomationException

Indicates if the track is enabled.

Parameters:

pbIsEnabled - The pbIsEnabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEvenTimeStamps

void setEvenTimeStamps(boolean pbEvenTimeStamps)
                       throws java.io.IOException,
                              AutomationException

Indicates whether to distribute time stamps evenly in the interval 0-1.

Parameters:

pbEvenTimeStamps - The pbEvenTimeStamps (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEvenTimeStamps

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

Indicates whether to distribute time stamps evenly in the interval 0-1.

Returns:

The pbEvenTimeStamps

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setApplyToAllViewers

void setApplyToAllViewers(boolean pbApplyToAllViewers)
                          throws java.io.IOException,
                                 AutomationException

Indicates whether to apply a camera track to all scene viewers.

Parameters:

pbApplyToAllViewers - The pbApplyToAllViewers (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isApplyToAllViewers

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

Indicates whether to apply a camera track to all scene viewers.

Returns:

The pbApplyToAllViewers

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAttachedObjectsCount

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

The number of objects to which the track is attached.

Returns:

The pObjectCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAttachedObjects

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

The objects to which the track is attached, or null.

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.

isAttached

boolean isAttached(java.lang.Object pObject)
                   throws java.io.IOException,
                          AutomationException

Indicates if the given objects is attached to the track.

Parameters:

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

Returns:

The pbIsAttached

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAttachedObjects

void setAttachedObjects(IArray ppObjectArray)
                        throws java.io.IOException,
                               AutomationException

The objects to which the track is attached, or null.

Parameters:

ppObjectArray - 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.

attachObject

void attachObject(java.lang.Object pObject)
                  throws java.io.IOException,
                         AutomationException

Attach object to the track.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

detachObject

void detachObject(java.lang.Object pObject)
                  throws java.io.IOException,
                         AutomationException

Detach object from the track.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

detachAllObjects

void detachAllObjects()
                      throws java.io.IOException,
                             AutomationException

Detach all objects from the track.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resetAttachedObjects

void resetAttachedObjects(IScene pScene)
                          throws java.io.IOException,
                                 AutomationException

Reset the state of the attached objects to be ready for animation.

Parameters:

pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

insertKeyframe

void insertKeyframe(IKeyframe pKeyframe,
                    int index)
                    throws java.io.IOException,
                           AutomationException

Inserts a new keyframe. If the index is -1, it is added last.

Parameters:

pKeyframe - A reference to a com.esri.arcgis.analyst3d.IKeyframe (in)

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeKeyframe

void removeKeyframe(int index)
                    throws java.io.IOException,
                           AutomationException

Removes the keyframe with the given index.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAllKeyframes

void removeAllKeyframes()
                        throws java.io.IOException,
                               AutomationException

Removes all the keyframes.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findKeyframe

void findKeyframe(java.lang.String name,
                  IKeyframe[] ppKeyframe)
                  throws java.io.IOException,
                         AutomationException

Finds a keyframe by name.

Parameters:

name - The name (in)

ppKeyframe - A reference to a com.esri.arcgis.analyst3d.IKeyframe (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

moveKeyframe

void moveKeyframe(int originIndex,
                  int destinationIndex)
                  throws java.io.IOException,
                         AutomationException

Moves the keyframe with the given index, inserting it with a different index.

Parameters:

originIndex - The originIndex (in)

destinationIndex - The destinationIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

sortKeyframes

void sortKeyframes()
                   throws java.io.IOException,
                          AutomationException

Sorts the keyframes in ascending time order.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resetTimeStamps

void resetTimeStamps()
                     throws java.io.IOException,
                            AutomationException

Redistributes the time stamps in the interval [0,1].

Throws:

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

AutomationException - If the ArcObject component throws an exception.

saveObjectProperties

void saveObjectProperties(IScene pScene,
                          int index)
                          throws java.io.IOException,
                                 AutomationException

Internally saves the properties of the attached object specified.

Parameters:

pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

restoreObjectProperties

void restoreObjectProperties(IScene pScene,
                             int index)
                             throws java.io.IOException,
                                    AutomationException

Restores the saved properties of the attached object specified.

Parameters:

pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interpolateObjectProperties

void interpolateObjectProperties(IScene pScene,
                                 double time)
                                 throws java.io.IOException,
                                        AutomationException

Interpolates the state of the attached object for a time between BeginTime and Endtime.

Parameters:

pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)

time - The time (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.