CreateVideoOnTerrain

The CreateVideoOnTerrain creates a Video On Terrain object, to play a movie draped on the terrain.

HRESULT CreateVideoOnTerrain(

[in] BSTR VideoFileName,

[in] double X,

[in] double Y,

[in] double Elevation,

[in] double Yaw,

[in, optional, defaultvalue(-80)] double Pitch,

[in, optional, defaultvalue(3)] HeightStyleCode HeightStyle,

[in, optional, defaultvalue(0)] long GroupID,

[in, optional, defaultvalue("")] BSTR Description,

[out, retval] ITerrainVideo5** pITerrainVideo5)

Parameters:

• VideoFileName – A full pathname or a URL to the video file that you would like to import to the terrain.

• X – The West-East coordinate of the center of the video projector, 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.

• Y – The North-South coordinate of the video projector represented 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.

• Elevation – The elevation of the video projector relative to the terrain.

• Yaw – The Yaw angle of the video projector. See: “Yaw, Pitch and Roll Angles”.

• Pitch – The Pitch angle of the video projector. See: “Yaw, Pitch and Roll Angles”.

• HeightStyle – An enum determining how the video projector is placed on the terrain.

The HeightStyleCode enum can use any of the following values:

• HSC_TERRAIN_RELATIVE = 0
  The height above the terrain of the video projector.

• HSC_TERRAIN_ABSOLUTE = 3
  The height relative to the terrain database vertical datum base ellipsoid of the video projector.

• GroupID – The Information Tree group in which the video on terrain is created. If it is set to zero, the object is created under the root. You can obtain the GroupID by one of the following methods:

• Create the group the IInformationTree5::CreateGroup.

• If you know the name of the group, find it using IInformationTree5::FindItem.

• Traverse the Tree using IInformationTree5 methods such as GetNextItem, until you come to the desired GroupID.

• Description – The name of the Video On Terrain object as it appears in the Information Window. If an empty string is passed into this parameter, TerraExplorer assigns it a unique name.

• pITerrainVideo5 – An interface pointer to the newly created video on terrain object. This parameter must not be Null.

Return Values:

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