Home > All Other Interfaces > ITerrainVideo

ITerrainVideo6

Objects that implement this interface use an external video file or stream that is used to play video draped on the terrain. Some of the capabilities provided for this object manage parameters for the video projector. The projector object can get its positioning information from a telemetry file. Alternatively, you can control its position with the Position property of the ITerrainLocation6  interface. You can also perform play, stop, pause, and seek operations on the video object.

 

 

Properties

 

Action

An IAction6 representing the operation that takes place when the object is clicked in the Project Tree.

Attachment

An IAttachment6 representing the attachment behavior of the object.

CanSeek

Identifies if the video is capable of seeking a specific time in its duration.

ClientData

A text string assigned to each object global namespace. C# exposes this property as get_ClientData and set_ClientData. (Inherited from ITerraExplorerObject6)

ID

The ID of the object. (Inherited from ITerraExplorerObject6)

MaximumProjectionDistance

The distance from the camera at which the Video on Terrain disappears.

Message

An IMessageObject6 representing the message object triggered when the user double-clicks the object’s Project Tree entry.

Mute

When set to TRUE the audio playback is muted.

ObjectType

An enum that identifies the type of the object. (Inherited from ITerraExplorerObject6)

PlayStatus

The play status of the video.

PlayVideoOnStartup

Indicates whether the video starts playing when a FLY project opens.

Position

An IPosition6 representing the position and orientation of the object on the terrain.

ProjectionFieldOfView

The projector field of view, in degrees.

ProjectionLinesLength

The length of the projector rays in the 3D Window in meters.

ProjectorLength

The length of the projector rays in the 3D Window in meters.

SaveInFlyFile

A Boolean that determines whether the object is saved in the Fly file. (Inherited from ITerraExplorerObject6)

ShowProjectionLines

Indicates whether to show the projector rays in the 3D Window.

ShowProjector

Indicates whether to show the projector pyramid in the 3D Window.

TelemetryFileName

A full path name to the telemetry file that this object should use.

Terrain

An ITerrainObject6 representing terrain properties including draw order and ground object status.

TimeSpan

An ITimeSpan6 representing the timespan in which the object is visible on the terrain.

Tooltip

An ITooltip6 representing the tooltip that displays when a mouse cursor is placed over the object in the 3D Window.

TreeItem

An ITreeItem6 representing details about the representation of the object in the Project Tree.

UseTelemetry

Indicates whether the object uses the positioning information in the telemetry file assigned in the TelemetryFileName property.

VideoFileName

A full path name or a URL to the video file or stream.

VideoLength

The length, in seconds, of the video file.

VideoOpacity

Determines the opacity or transparency of the video image.

VideoPosition

The current playing time, in seconds, from the beginning of the video.

Visibility

An IVisibility6 representing the visibility of the object at different distances, as well as visibility of the object in TerraExplorer Basic Viewer.

Volume

Determines the audio volume level.

 

Methods

 

get_ClientData

This method is exposed only in C#. To use from C++ or JavaScript use the ClientData property. (Inherited from ITerraExplorerObject6)

GetParam

Reserved. Currently not used. (Inherited from ITerraExplorerObject6)

set_ClientData

This method is exposed only in C#. To use from C++ or JavaScript use the ClientData property. (Inherited from ITerraExplorerObject6)

PlayVideo

Calling this method sets the video play mode for play, stop, and pause.

SetImage

Reserved. Currently not used.

SetParam

Reserved. Currently not used. (Inherited from ITerraExplorerObject6)