CreatePlayTimeAnimationGroupStep

Creates a step that animates progress of the system time to display the changes on the terrain during the timespan that was set for a specific group.

 

JavaScript

 

CreatePlayTimeAnimationGroupStep(

       AdvancedType,

       WaitTime,

       Description,

       AnimationLength,

       GroupID)

 

C#

 

IPresentationStep66 CreatePlayTimeAnimationGroupStep(

       PresentationStepContinue AdvancedType,

       int WaitTime,

       string Description,

       int AnimationLength,

       string GroupID)

 

C++

 

HRESULT CreatePlayTimeAnimationGroupStep(

       PresentationStepContinue AdvancedType,

       long WaitTime,

       BSTR Description,

       long AnimationLength,

       BSTR GroupID,

       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.

GroupID

The ID of the group whose timespan determines the date and time frame of the time 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.