TABLE OF CONTENTS

Working with Scripting API (SGAPI)

SkylineGlobe control class reference overview

SGWorld Class

SGWorld Constructor

SGWorld Methods

showPopup Method

removePopup Method

attachEvent Method

detachEvent Method

SGWorld Properties

SGWorld Events

onLoadFinished Event

onFileClosing Event

onFrame Event

onTerraExplorerMessage Event

onNodeAction Event

onFileSave Event

onRenderQualityChanged Event

onInputModeChanged Event

onLButtonDown Event

onLButtonUp Event

onMButtonDown Event

onMButtonUp Event

onRButtonDown Event

onRButtonUp Event

onMouseWheel Event

onLButtonDblClick Event

onRButtonDblClick Event

onMButtonDblClick Event

onClick Event

SGActionCode Enumeration

SGWorld.navigate

SGWorld.navigate Methods

getPosition Method

setPosition Method

flyTo Method

flyThrough Method

jumpTo Method

zoomTo Method

zoomIn Method

zoomOut Method

stop Method

SGZoomLevels Enumeration

SGWorld.creator

SGWorld.creator Methods

createGroup Method

createLayer Method

createPolyline Method

createPolygon Method

createRectangle Method

createCircle Method

createEllipse Method

createArc Method

createArrow Method

create3DArrow Method

createSphere Method

create3DPolygon Method

createBuilding Method

createBox Method

createPyramid Method

createCylinder Method

createCone Method

createModel Method

createLabel Method

createTextLabel  Method

createImageLabel Method

createLocation Method

createMessage Method

createDynamic Method

createThreatDome Method

createImageryLayer  Method

createElevationLayer Method

createVideoOnTerrain Method

SGWorld.window

SGWorld.window Methods

getRect Method

getSnapShot Method

pixelToWorld Method

pixelFromWorld  Method

getMouseInfo Method

getInputMode Method

setInputMode Method

showControls Method

getControls Method

SGWorld.root

SGWorld.lastError

SGNode Class

SGNode Methods

appendChild Method

removeChild Method

parentNode Method

hasChildNodes Method

firstChild Method

lastChild Method

nextSibling Method

childNodes Method

selectSingleNode Method

setVisibility Method

getVisibility Method

sort Method

save Method

load Method

getPosition Method

setPosition Method

setMessage Method

setAttribute Method

getAttribute Method

setData Method

getData Method

nodeType Method

nodeId Method

getName Method

setName Method

isEqual Method

SGNode Properties

innerObj Property

SGNodeType Enumeration

SGNodeList Class

SGNodeList Methods

item Method

nextNode Method

reset Method

SGNodeList Properties

length Property

SGPopup Class

SGPopup Constructor

SGPopup Properties

left Property

top Property

width Property

height Property

caption Property

src Property

timeout Property

innerHTML Property

innerText Property

allowResize Property

allowDrag Property

anchorToView Property

align Property

SGNotification Class

SGNotification Constructor

SGCoord2D Class

SGCoord2D Constructor

SGCoord2D Properties

x Property

y Property

SGCoord2D Methods

move Method

moveToward Method

lerp Method

distanceTo Method

anglesTo Method

isEqual Method

SGCoord3D Class

SGCoord3D Constructor

SGCoord3D Properties

x Property

y Property

height Property

heightType Property

SGCoord3D Methods

move Method

moveToward Method

lerp Method

distanceTo Method

anglesTo Method

aimTo Method

toAbsolute Method

toRelative Method

changeHeightType Method

isEqual Method

SGPosition Class

SGPosition Constructor

SGPosition Properties

x Property

y Property

height Property

heightType Property

yaw Property

pitch Property

roll Property

distance property

SGPosition Methods

move Method

moveToward Method

lerp Method

distanceTo Method

anglesTo Method

aimTo Method

toAbsolute Method

toRelative Method

changeHeightType Method

isEqual Method

SGColor Class

SGColor Constructor

SGColor Properties

abgrColor Property

SGColor Methods

toHTMLColor Method

toBGRColor  Method

toInnerObjColor  Method

toABGRColor Method

toRGBColor Method

toARGBColor Method

fromHTMLColor Method

fromBGRColor Method

fromABGRColor Method

fromRGBColor Method

fromARGBColor Method

getAlpha Method

setAlpha Method Method

SGColor Enumeration

SGFlyThrogh Class

SGFlyThrough Constructor

SGFlyThrough Properties

waitOnPoint Property

viewingDistance Property

viewingDirection Property

onFlyTo Property

onFinish Property

SGFlyThrough Methods

start Method

finish Method

SGFlyThrough Events

onFlyTo Event

onFinish Event

SGLabelStyle Class

SGLabelStyle Constructor

SGLabelStyle Properties

textColor Property

backgroundColor Property

lineToGround Property

lineColor Property

fontName Property

fontSize Property

bold Property

italic Property

underline Property

frameFileName Property

frameIndex Property

maxViewingHeight Property

minViewingHeight Property

textOnImage Property

multilineJustification Property

textAlignment Property

pivotAlignment Property

lockMode Property

SGWaypoint Class

SGWaypoint Constructor

SGFramework Class

SGFramework Properties

SGFramework.global

SGFramework.global Methods

registerObject Method

unregisterObject Method

getObject Method

SGFramework.favorites

SGFramework.favorites Methods

add Method

remove Method

show Method

hide Method

SGFramework.results

SGFramework.results Methods

addPage Method

removePage Method

show Method

hide Method

toggle Method

attachNode Method

setNext  Method

setPrev Method

setResult Method

SGFramework.results Properties

account Property

tools Property

working with the API

Overview

Main Interfaces

TerraExplorer Pro main Interfaces

TerraExplorer Viewer Interfaces

ActiveX Controls

How to Work with the COM Interface

Creating Client Applications

Working with Scripting languages

Working with Visual Basic

Working with C#

Working with C++

Basic Concepts

Units

Camera and Plane

Yaw, Pitch and Roll Angles

Yaw Values

Pitch Values

Roll Values

How To

Controlling the Plane and Camera

Getting the current position of the camera

Jumping to a new location

Flying to a new location

Dynamically controlling the position of the camera in each frame

Information Tree Management

Create and modify groups

Find and modify objects in a project

Object Management

Add objects to the project

Modify objects’ parameters

TerraExplorer Events

Controlling the Mouse

Terrain Information

Coordinate Systems

Client Data

Feature Layers

Navigation Map window

Add Maps to the Navigation Window

Reference a map to the terrain database

TerraExplorer CoClass

TerraExplorer CoClass Interfaces

ITerraExplorer51

Properties:

Type

FlyName

DisplayErrorMessages

ProjectParam

OptionParam

Methods:

Load

SetCPUSavingMode

GetUserUnits

LoadEx

GetTEVersion

Save

SaveAs

SetParam

GetParam

AttachEvent

DetachEvent

IPlane5

Properties:

Speed

FieldOfView

Methods:

FlyTo

SetPosition

MovePosition

GetPosition

FlyToObject

SetSpeed

GetSpeed

Zoom

GetPositionEx

IObjectManager51

Methods:

CreatePolyline

Create2DPolygon

CreateRectangle

CreateRegularPolygon

CreateCircle

Create3DPolygon

CreateBuilding

CreateBox

CreatePyramid

CreateCylinder

CreateCone

CreateEllipse

CreateArc

CreateArrow

Create3DArrow

CreateSphere

CreateModel

CreateLabel

CreateLabelEx

CreateLocation

CreateTreeHotlink

CreateRoute

CreateMessage

GetObject

CreateImageLabel

CreateImageLabelEx

CreateDynamicObject

CreateImageryLayer

CreateElevationLayer

CreateVideoOnTerrain

CreatePointCloudModel

CreateFromStream

GetFirstObjectPosition

GetNextObject

GetInfoTreeItemID

SetObjectParam

GetObjectParam

CreateTerrainModifier

CreateHoleOnTerrain

IInformationTree5

Methods:

CreateGroup

CreateLockedGroup

RenameGroup

ExpandGroup

GetItemName

DeleteItem

SetParent

GetNextItem

FindItem

GetTerraObjectID

SetGroupColor

GetGroupColor

EnableRedraw

IsGroup

SetGroupVisibility

SortGroup

SetGroupLocation

GetGroupLocation

CreateLockedGroupEx

SetActivationCode

GetActivationCode

SetClientData

GetClientData

GetObject

SetParentEx

ReloadLayer

EditItem

EditItems

LoadFlyLayer

IsGroupEx

GetGroupVisibility

SaveFlyLayer

CreateLayer

EditItemEx

EndEdit

SetClientDataEx

GetClientDataEx

GetLayer

SetVisibility

GetVisibility

GetObjectEx

LoadFlyLayerEx

LockGroup

SelectItem

IsLayer

ITerrain5

Properties:

MPTName

GroupKey

SystemKey

DatumKey

UnitKey

EPSG

Description

Opacity

Methods:

GetGroundHeight

GetGroundHeightEx

GetExtent

IContainer2

Methods:

SetURL

RemoveURL

BringToFront

SetMessageBarText

HTMLPopup

IRender5

Properties:

Quality

HudMode

Methods:

GetRenderRect

ScreenToTerrain

GetMouseInfo

SetMouseInputMode

SetMouseCursor

ScreenToWorld

WorldToScreen

SetHUDLayer

GetMouseInputMode

ISnapShot2

Properties:

SnapshotWidth

SnapshotHeight

Format

RenderQuality

Methods:

SaveRenderToFile

SetSnapShotParams

GetImage

IStartPosition

Properties:

StartX

StartZ

_ITerraExplorerEvents5

Methods:

OnLoadFinished

OnFileClosing

OnFrame

OnTerraExplorerMessage

OnObjectAction

OnFileSave

OnRenderQualityChanged

OnInputModeChanged

OnLButtonDown

OnLButtonUp

OnMButtonDown

OnMButtonUp

OnRButtonDown

OnRButtonUp

OnMouseWheel

OnInfoTreeAction

OnTerraExplorer

OnDrawHUD

OnLButtonDblClk

OnRButtonDblClk

OnMButtonDblClk

ICoordSys3

Methods:

GetTerrainCS

SetTerrainCS

SetSourceCS

ChooseCSDialog

GetCSHandle

GetCSHandleFromEPSG

ReleaseCSHandle

Reproject

GetUnitFactor

MoveCoord

MoveCoordEx

GetDistance

GetAimingAngles

ConvertToMGRS

ConvertFromMGRS

ChooseCSDialogEx

GetDistanceEx

GetAimingAnglesEx

IScriptEngine5

Methods:

Run

RegisterName

RegisterGlobalName

UnregisterName

GetGlobalName

IMenu

Methods:

Invoke

ITENavigationMap5

Properties:

BorderStyle

ShowPlane

MapCount

MapIndex

ShowMapSelector

LevelCount

LevelIndex

Methods:

LoadXml

GetXml

ShowProperties

ResetContent

CenterMap

SetTerrainTiePoint

SetMapTiePoint

CancelTiePointMode

GetXml2

GetHeightByLevel

GetLevelByHeight

_ITENavigationMapEvents5

Methods:

OnMapPosChanged

OnPopupMenu

OnCommand

OnTiePointMode

OnMapLevelChanged

IDateTime5

Properties:

TimeZoneMode

DisplaySun

DateTime

FixedLocalTime

TimeRangeStart

TimeRangeEnd

TimeZoneKey

TimeZoneDisplayName

TimeZonesXML

Methods:

SetMode

ITerraExplorerObject5 Interfaces

About ITerraExplorerObject5 Interface

ITerraExplorerObject5

ITerraExplorerObject5

Properties:

ID

ObjectType

ClientData

KeepAliveOnRelease

ClientDataEx

Methods:

SetParam

GetParam

IInfoTreeItem5

Properties:

Description

ExistInBasicTree

InfoTreeItemID

GroupName

SaveInFlyFile

ISingleMessageObject5

Properties:

MessageID

ITerrainLocation5

Properties:

Distance

ActivationCode

ActivationParam

Methods:

SetPosition

GetPosition

GetPositionEx

ITerrainObject5

Properties:

Visible

ToolTipText

MaxVisibilityDistance

MinVisibilityDistance

IsAttached

AutoDetach

GroundObject

Methods:

AttachTo

ITerrainColoredObject5

Properties:

FgColor

FgAlpha

BgColor

BgAlpha

ITerrainPrimitive5

Properties:

HeightStyle

LineStyle

TextureFileName

TextureTilingMethod

TextureScaleX

TextureScaleY

TextureRotateAngle

LineWidth

LineBackColor

LineBackAlpha

DrawOrder

ITerrainPolyline5

Properties:

NumofVertices

Vertices

Methods:

AddVertex

GetVertex

ModifyVertex

DeleteVertex

ITerrainRectangle5

Properties:

Top

Left

Right

Bottom

Width

Depth

ITerrainRegularPolygon5

Properties:

Radius

NumberofSegments

ITerrain3DPolygon5

Properties:

Height

ITerrainBuilding5

Properties:

BuildingStyle

TilingMethod

SideTexture

SideScaleX

SideScaleY

RoofTexture

RoofScaleX

RoofScaleY

RoofRotateAngle

RoofStyle

RooftopDeltaHeight

RoofFillType

SideFillType

RoofTilingMethod

SideTilingMethod

Methods:

GetSideFillType

SetSideFillType

GetSideTexture

SetSideTexture

GetSideColor

SetSideColor

GetTerrainTextureOffset

SetTerrainTextureOffset

ITerrain3DRectBase5

Properties:

Height

ITerrain3DRegBase5

Properties:

Height

ITerrainEllipse5

Properties:

Radius2

ITerrainArc5

Properties:

StartAngle

EndAngle

ITerrainArrow5

Properties:

HeadX

HeadY

TailX

TailY

Style

ITerrain3DArrow5

Properties:

Height

ITerrainSphere5

Properties:

Radius

SegmentDensity

Style

ITerrainModel5

Properties:

ModelFileName

ScaleFactor

FlipTexture

Methods:

GetModelType

ITerrainLabel5

Properties:

LineToGroundType

LineColor

LineLength

Text

FontName

FontSize

FontStyle

ImageFileName

FrameFileName

FrameIndex

ScaleFactor

LimitGrowth

MinimumViewingHeight

MinimumSize

TextOnImage

AlignTextHorizontal

AlignTextVertical

TextJustification

AlignLabelHorizontal

AlignLabelVertical

LockMode

Methods:

GetLabelStruct

ITerrainImageLabel5

Properties:

LineToGroundType

LineColor

LineLength

ImageFileName

FrameFileName

FrameIndex

ScaleFactor

LimitGrowth

MinimumViewingHeight

MinimumSize

AlignLabelHorizontal

AlignLabelVertical

LockMode

Methods:

GetLabelStruct

ITerrainRoute5

Properties:

HeightRelativeToGround

AutoRepeat

UseElevation

UseSpeed

UseCameraOffset

NumberOfWaypoints

CurrentWaypoint

Methods:

Play

Stop

Pause

AddWaypoint

GetWaypoint

ModifyWaypoint

ITerraExplorerMessage5

Properties:

Client

Text

URL

Type

BringToFront

PopupFlags

PopupCaption

PopupTimeout

PopupTopLeftX

PopupTopLeftY

PopupWidth

PopupHeight

ITerrainDynamicObject5

Properties:

MotionStyle

DynamicType

FileName

Text

FontName

FontSize

FontStyle

ScaleFactor

FlipTexture

HeightStyle

Acceleration

TurnSpeed

CircularRoute

NumberOfWaypoints

CurrentWaypoint

Methods:

AddWaypoint

GetWaypoint

ModifyWaypoint

DeleteWaypoint

RestartRoute

ITerrainRasterLayer5

Properties:

UseNull

NullValue

Methods:

SetLayerCS

ITerrainVideo5

Properties:

VideoFileName

TelemetryFileName

UseTelemetry

ProjectionFieldOfView

VideoOpacity

ShowProjectionLines

ProjectionLinesLength

ShowProjector

ProjectorLength

Volume

Mute

PlayVideoOnStartup

VideoLength

VideoPosition

CanSeek

PlayStatus

Methods:

PlayVideo

SetImage

ITerrainPointCloudModel5

Properties:

ModelFileName

ScaleFactor

FlattenBelowTerrain

HideBelowImagery

MinIntensity

MaxIntensity

PaletteOpacity

PaletteFileName

DistributionDirection

DistributionStart

DistributionEnd

PointSamplingInterval

PointScalingFactor

PointSizeLimit

ChangeSampleOnMove

DataFormat

Methods:

GetDefaultLocation

GetBoundingBox

SetAutoIntensity

GetDefaultLocationCS

ILayer5

Methods:

SetProperty

SetValue

GetValue

Load

GetGroupId

GetFeatureType

SetFeature

SetAnnotation

SetFeatureAndAnno

SetStreamStatus

GetStreamStatus

CreatePolygon

CreatePolyline

CreatePoint

SetVisibilityMinMax

DisplayAs

Refresh

ITerrainModifier5

Properties:

ElevationBehavior

Flat

Methods:

SetFeather

ITerrainHole5

working with ActiveX Controls

What is ActiveX Controls

How to Work with ActiveX controls

Adding ActiveX components

Working with Scripting languages

Working with Visual Basic environment

Working with C# environment

Working with C++ environment

What is TerraDeveloper

Creating a RunTime Pro kit

ActiveX Controls

ITE3DWindow

Properties:

TakeControlOfKeyboardAccelerators

BorderStyle

Caption

_ITE3DWindowEvents

Methods:

OnKeyboardMessage

ITEInformationWindow

Properties:

BorderStyle

ITENavigationMap5

_ITENavigationMapEvents5

COM API Example codes

Examples in C++

Adding Objects to the Project

Finding and Modifying Objects

Handling TerraExplorer Events

Examples in VBScript

Navigating in the 3D World

Finding and Modifying Objects

Handling TerraExplorer Events

Creating a Polyline Using a Safe Array of Vertices

Working with Mouse Events

Working with Coordinate Systems

Working with Client Data

Examples in JavaScript

Creating a Label Using an Object

Examples in C#

Handling TerraExplorer Events

 

Working with Scripting API (SGAPI)