Creates a presentation step that animates progress of the system time to display the changes on the terrain during the selected timespan. The date and time that the presentation is set to affects the display of the sun, moon and the sun’s flares since they are displayed and positioned based on the time, date and time zone. The date and time also affect the display of all objects using the timespan property.
You select the start and end date and time as well as the duration of the time animation step.
|
JavaScript |
|
|
CreatePlayTimeAnimationCustomStep ( AdvancedType, WaitTime, Description, AnimationLength StartTime EndTime) |
|
|
C# |
|
|
IPresentationStep66 CreatePlayTimeAnimationCustomStep ( PresentationStepContinue AdvancedType, int WaitTime, string Description, int AnimationLength, object StartTime, object EndTime) |
|
|
C++ |
|
|
HRESULT CreatePlayTimeAnimationCustomStep ( PresentationStepContinue AdvancedType, long WaitTime, BSTR Description, long AnimationLength, VARIANT StartTime, VARIANT EndTime IPresentationStep66** Step) |
|
Parameters
AdvancedType
An enum that determines how the presentation advances to the next step. The following are its possible values:
· PSC_MOUSECLICK = 0
On mouse click.
· PSC_WAIT = 1
Automatically after the preset wait time.
WaitTime
After performing the step, the number of seconds to wait before the presentation should advance to the next step.
Description
A string describing the step that displays in the Presentation Editor. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.
AnimationLength
The length of time the animation should play.
StartTime
The start date and time for the animation.
EndTime
The end date and time for the animation.
Return Value
Step
An IPresentationStep66 representing the time animation step that was created.
Exceptions
See: HRESULT Return Values for a list of possible values returned by the HRESULT.