ModifyWaypoint

The ModifyWaypoint method allows the client to change specific waypoints.

HRESULT ModifyWaypoint(

[in] int Index,

[in] double X,

[in] double Height,

[in] double Y,

[in] double Yaw,

[in] double Pitch,

[in] double Roll,

[in] double CameraDeltaYaw,

[in] double CameraDeltaPitch,

[in] double Speed,

[in] BSTR MessageID)

Parameters:

• Index – The zero based index of the waypoint that the client wants to retrieve.

• X – The West-East coordinate of the waypoint in MPT units. You can use the ITerrain interface to retrieve information about the MPT units. If you are working in Lat-Long format, the Lat-Long values are in decimal Lat-Long.

• Height – The height of the waypoint, in meters. The way this parameter is interpreted depends on the HeightRelativeToGround property.

• Y – The North-South coordinate of the waypoint in MPT units. You can use the ITerrain interface to retrieve information about the MPT units. If you are working in Lat-Long format, the Lat-Long values are in decimal Lat-Long.

• Yaw – The yaw orientation of the plane at that waypoint. See: “Yaw, Pitch and Roll Angles”.

• Pitch – The pitch orientation of the plane at that waypoint. See: “Yaw, Pitch and Roll Angles”.

• Roll – The roll orientation of the plane at that waypoint. See: “Yaw, Pitch and Roll Angles”.

• CameraDeltaYaw – The offset between the camera yaw and the plane yaw.

• CameraDeltaPitch – The offset between the camera pitch and the plane pitch.

• Speed – The speed of the plane in meters per second at that waypoint. The plane’s speed adjusts in between waypoints to reach the speed of its next waypoint.

• MessageID – The ID of the message object that appears at the new waypoint.

Return Values:

The return value obtained from the returned HRESULT can be one of the following: