CreateRouteWaypoint

You can generate a route for dynamic objects by creating a list of waypoints. Each waypoint defines the position of the camera and its speed at that waypoint. If you define a route using individual waypoints, TerraExplorer Pro generates the route by computing a line that passes through each location.

JavaScript

 

CreateRouteWaypoint(

       X,

       Y,

       Altitude,

       Speed,

       Yaw,

       Pitch,

       Roll,

       MessageID )

 

C#

 

IRouteWaypoint80 CreateRouteWaypoint(

       double X = 0,

       double Y = 0,

       double Altitude = 0,

       double Speed = 300,

       double Yaw = 0,

       double Pitch = 0,

       double Roll = 0,

       string MessageID = "")

 

C++

 

HRESULT CreateRouteWaypoint(

       double X,

       double Y,

       double Altitude,

       double Speed,

       double Yaw,

       double Pitch,

       double Roll,

       BSTR MessageID,

       IRouteWaypoint80** pVal)

Parameters

X

The West-East coordinate of the location of interest represented in coordinate system units. You can use the ITerrain80 interface to retrieve information about the coordinate system units.

Y

The North-South coordinate of the location of interest represented in coordinate system units. You can use the ITerrain80 interface to retrieve information about the coordinate system units.

Altitude

The elevation of the location of interest relative to the terrain.

Speed

The speed of the camera.

Yaw

The Yaw angle between the viewer and the point of interest. Range from 0 to 360 where 0=North, 90=East, 180=South and 270=West.

Pitch

The Pitch angle between the viewer and the point of interest. Range from -90 to +90 where 0 = Horizon, +90 = straight up and –90 = straight down.

Roll

The Roll angle between the viewer and the point of interest. Range from -90 to +90 where 0 = Horizon, +90 = Full roll right and –90 = Full roll left.

MessageID

The ID of the message object to activate when this waypoint is reached. 

Return Value

pVal 

An IRouteWaypoint80 representing the created waypoint.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.