skyline_API详细使用说明手册.doc

1TerraExplorer API 简介TerraExplorer API 提供了一套强大的接口用来集成 TerraExplorer、 TerraExplorer Pro 和用户自定义应用。它提供了一些访问外部信息扩展的方 法，比如：访问数据库或基础地理空间数据。所有这些以 COM 协议为基础的 API 接口都可以通过脚本语言操作（例如 Javascript），也可以通过非脚本语言来控 制操作（例如：C+、VB、delphi 或者.net）。TerraExplorer 也提供了一套 ActiveX 控件，可将 3D 窗口、信息树和导航图 以控件对象的方式嵌入到用户自定义的可视化界面中，其中，Runtime 模块使得 用户自定义的应用程序更易分发。1.1 ITerraExplorer5描述用户接口的相关细节，例如当前用户使用的软件版本信息、单位参数（长 度单位、速度单位等）、工程文件加载和保存等。ITerraExplorer属性：Type, FlyName, DisplayErrorMessages方法：Load,SetCPUSavingMode,GetUserUnits, GetTEVersion, LoadEx, Save, SaveAs, SetParam, GetParam（1）Load 方法：HRESULT Load(in BSTR URL) 其中 URL 是 fly 或 mpt 文件的 完整路径。C# ：（第一次举例是完整代码，主要部分为粗体部分，以后的例子只写主要部分，下面接口例子的其他代码与此例类似,其中加载保存路径读者可以自行设定）using System;using System.Windows.Forms; using TerraExplorerX; namespace Load_Testpublic partial class Form1 : Formprivate TerraExplorerClass objTerraExplorer;public Form1()InitializeComponent();private void Loadbutton_Click(object sender, EventArgs e)objTerraExplorer = new TerraExplorerClass();objTerraExplorer.Load(E:Skyline Pro Interface 数 据 数 据Default.fly);VBscript:（其中黑体部分是主要部分）LoadSub Load()set ITerraExplorer5=TE.interface(ITerraExplorer5) ITerraExplorer5.load E:Skyline Pro Interface数据数据Default.flyend Sub（2）Save 方法 ：只能保存 fly 工程,mpt 工程不能保存C#：objTerraExplorer = new TerraExplorerClass();objTerraExplorer.Save();VBScript ：Sub Save()Set ITerraExplorer=TE.interface(ITerraExplorer5) ITerraExplorer.SaveEnd Sub（3）Save As 方法：HRESULTSaveAs(in BSTR FileName)工程另存为C#：objTerraExplorer = new TerraExplorerClass(); objTerraExplorer.SaveAs(E:Skyline Pro Interface数据数据Default88.fly ); VBScript ：Sub SaveAs()Set ITerraExplorer=TE.interface(ITerraExplorer5)ITerraExplorer.SaveAsE:Skyline Pro Interface数据数据Default88.fly End Sub1.2 IPlane5控制飞机和摄像机的操作，对于对象的飞行方式、观看视角、视野高度进行 控制，可按照需求控制摄像机的方向、倾角产生复杂的运动，例如飞机起飞模拟。IPlane5属性：Speed, FieldOfView方法：FlyTo, SetPosition, MovePosition, GetPosition, FlyToObject, SetSpeed, GetSpeed, Zoom, GetPositionEx（1）FlyTo 方法：飞行到指定的位置in double X, 水平方向坐标 in double Z,垂直方向坐标 in double Height,高度in double Distance, 飞行到后视点离位置的距离in double Yaw,方位角in double Pitch,视角上下倾斜角度in BSTR Pattern视角飞行到固定位置的模式C#：private TerraExplorerClass objTerraExplorer; IPlane5 objIPlane5=objTerraExplorer as IPlane5 ; objIPlane5.FlyTo(100.71729, 36.761361,40000, 100, 0, 0, FlyToTerrain);VBScript ：Sub FlyTo()Set IPlane5=TE.Interface(IPlane5)IPlane5.FlyTo 108,39,2000,50,0,0,FlyToLocation End Sub（2）SetPosition 方法：设置跳转到视角的位置in double X in double Yin double Heightin double Yawin double Pitchin double Rollin double CameraDeltaYaw, in double CameraDeltaPitch, in, defaultvalue(0) long FlagsC#：IPlane5 objIPlane5 = objTerraExplorer as IPlane5;objIPlane5.SetPosition(100.71729, 36.761361, 40000,100,0, 0,0,0, 1024);VBScript ：Sub SetPosition()Set IPlane5=TE.interface(IPlane5) IPlane5.SetPosition 108,39,2000,0,0,0,0,0,1End Sub（3）GetPosition 方法：out VARIANT* doubleX,输出视角所在的经度 out VARIANT* doubleY, 输出视角所在的经度 out VARIANT* doubleHeight, 输出视角所在的高度 out VARIANT* doubleYaw,视角方位角out VARIANT* doublePitch,视角上下倾斜角度out VARIANT* doubleRoll,视角左右倾斜角度out VARIANT* doubleCameraDeltaYaw, out VARIANT* doubleCameraDeltaPitchC#：objectx, y, h, yaw, pitch, roll, cdy, cdp;IPlane5 objIplane5 = objTerraExporer as IPlane5;objIplane5.GetPosition(out x,out y,out h, out yaw,out pitch,out roll,out cdy, out cdp); Xtext.Text= x.ToString ();Ytext.Text = y.ToString(); Htext.Text = h.ToString(); Yawtext.Text = yaw.ToString(); Pitchtext.Text = pitch.ToString(); Rolltext.Text = roll.ToString(); CDYtext.Text = cdy.ToString(); CDPtext.Text = cdp.ToString();VBScript ：Sub GetPosition()IPlane5.GetPosition x,y,height,yaw ,pitch,roll,camaraPicth,camaraRollXV.value=xYV.value=yHV.value=height YAWV.value=yaw PV.value=pitch RV.value=roll CPV.value=camaraPicth CRV.value=camaraRoll End Sub（4）MovePosition 方法：设置移动到视角的位置in double X, 水平方向坐标 in double Y,垂直方向坐标 in double Height,高度in double Yaw,视角方位角度in double Pitch,视角上下倾斜角度in double Roll,左右倾斜角度in double CameraDeltaYaw, in double CameraDeltaPitch, in, defaultvalue(0) long FlagsC#：IPlane5 objIPlane5 = objTerraExplorer as IPlane5;objIPlane5.MovePosition(111,39,4000,0,0,0,0,0,1024);VBScript ：Sub MovePosition()Set IPlane5=TE.Interface(IPlane5) IPlane5.MovePosition 108,39,2000,0,0,0,0,0,1End Sub（5）FlyToObject 方法：飞行到物体in BSTR ObjectID输入物体 ID in ActionCode Code飞行到模式 C#：IInformationTree5 objIInformationTree5=objTerraExplorer as IInformationTree5;int ItemID=objIInformationTree5 .FindItem(TestGroupTest Building);string objID=objIInformationTree5.GetTerraObjectID (ItemID); IPlane5 objIPlane5 = objTerraExplorer as IPlane5; objIPlane5.FlyToObject(objID,0);VBScript ：Sub FlyToObject()Set IPlane5=TE.interface(IPlane5)Set IInformationTree5 =TE.interface(IInformationTree5) ItemID = IInformationTree5.FindItem(Test Building)set Obj = IInformationTree5.GetObject(ItemID) IPlane5.FlyToObject Obj.ID,0End Sub（6）Zoom 方法：对当前进行视野缩放C#：IPlane5 objIPlane5 = objTerraExplorer as IPlane5;objIPlane5.Zoom(500,0);VBScript ：Sub Zoom()Set IPlane=TE.interface(IPlane5) IPlane.Zoom(50)End Sub1.3 IObjectManager5 接口管理三维窗口中的所有对象，使用本接口用户可添加、删除、修改三维窗口 中的所有对象，主要管理如下对象： 创建二维对象 主要处理文本、图片标签和二维几何体，可创建如下对 象：Text label：文本标签 Image label：图片标签 Polyline：折线 Polygon：面 Rectangle：矩形Regular Polygon：正多边形2D Arrow：二维箭头 Circle：圆 Ellipse：椭圆 Arc：圆弧VideoOnTerrain：在三维地形上创建视频 创建三维对象 主要处理 3D 模型和三维几何体，可创建如下对象：3D Model：添加外部三维模型Point Cloud Model：添加点云数据 Building：在 pro 中自定义创建建筑物3D Polygon：三维面 Box：长方体Cylinder：圆柱体Sphere：椭球体Cone：椎体 Pyramid ：金字塔3D Arrow：三维箭头 创建 Messages 创建对象 Message，并可与相关对象相关联 Raster Layers 创建栅格层，添加航片、卫片或高程数据 Route 创建漫游路线，可获取、修改路线点位信息 Location 创建视图，系统可直接获取视图范围，也可自定义范围3.1 CreatePolyline语法ITerrainPolyline5 CreatePolyline(object SafeArrayVertices, int LineColor, HeightStyleCodeHeightStyle, int GroupID, string Description)参数类型描述SageArrayVerticesobject一个数组节点包含三个 double 值， 这三个 double 值由 x 纬度,h 高度， y 经度。 如果这个参数是零，将创 建一个空的对象，用户可以获得对 象添加节点。LineColorint线颜色，RGB 值，最小为 255。HeightStyleHeightStyleCode一个枚举值，主要决定对象在地形 上以什么样的方式显示。GroupIDint放置对象的组编号，如果为 0 表示 对象将在根节点下产生。Descriptionstring对象在 Information 窗体中显示的 名称，如 果为空字 符串， TerraExplorer 将自动为其设置一 个唯一的名称。说明在三维窗口中创建多义线，返回 ITerrainPolyline5 对象。例子C#:private void CreatePolyline()ITerrainPolyline5 ITerrainPolyline = IOjbectManager.CreatePolyline(0, 255, HeightStyleCode.HS_ON_TERRAIN, 0, 创建线);ITerrainPolyline.AddVertex(0, 1,0, 0); ITerrainPolyline.AddVertex(40, 1, 40, 0);vbScript:3.2 Create2DPolygon参数类型描述SageArrayVerticesobject一个数组节点包含三个 double 值，这三个 double 值由 x 纬度,h 高度，y 经度。 如果这个参数是零，将创建一个空的对象，用户可以获得对象添加节点。LineColorFillOpacityint double线颜色，RGB 值，最小为 255。定义对象的透明度。0 为透明，1 为 不透明。FillColorHeightStyleintHeightStyleCode对象的填充颜色，其值为 RGB 值。一个枚举值，主要决定对象在地形 上以什么样的方式显示。GroupIDint放置对象的组编号，如果为 0 表示对象将在根节点下产生。Descriptionstring对象在 Information 窗体中显示的名称，如 果为空字 符串， TerraExplorer 将自动为其设置一说明个唯一的名称。例子C#:private void btnCreateObject_Click(object sender, EventArgs e)ITerrainPolyline = IOjbectManager.Create2DPolygon(0, 255, 0.4,65525, HeightStyleCode.HS_ON_TERRAIN, 0, 创建面); ITerrainPolyline.AddVertex(0, 1, 0, 0);ITerrainPolyline.AddVertex(10, 1, 10, 0);ITerrainPolyline.AddVertex(45, 1, 10, 0);vbScript:3.3 CreateRectangle语法参数类型描述XdoubleX 坐标ITerrainRectangle5 CreateRectangle(double X, double Y, double Elevation, double ObjectWidth, double ObjectDepth, int LineColor, double FillOpacity, int FillColor, HeightStyleCode HeightStyle, int GroupID, string Description)Y Elevation ObjectWidth LineColor FillOpacitydouble double double int doubleY 坐标 高程 矩形宽线颜色，RGB 值，最小为 255。 定义对象的透明度。0 为透明，1 为 不透明。FillColorHeightStyleintHeightStyleCode对象的填充颜色，其值为 RGB 值。一个枚举值，主要决定对象在地形上 以什么样的方式显示。GroupIDint放置对象的组编号，如果为 0 表示对象将在根节点下产生。Descriptionstring对象在 Information 窗体中显示的名称，如果为空字符串，TerraExplorer将自动为其设置一个唯一的名称。说明在三维窗口中创建矩形。 例子C#:vbScript:3.4 CreateRegularPolygon语法参数X类型double描述X 坐标Y Elevation RadiusNumOfSegments LineColor FillOpacitydouble double double intint doubleY 坐标高程 半径 边数线颜色，RGB 值，最小为 255。 定义对象的透明度。0 为透明，1 为 不透明。FillColorHeightStyleintHeightStyleCode对象的填充颜色，其值为 RGB 值。一个枚举值，主要决定对象在地形 上以什么样的方式显示。GroupIDint放置对象的组编号，如果为 0 表示对象将在根节点下产生。Descriptionstring对象在 Information 窗体中显示的ITerrainRegularPolygon5 CreateRegularPolygon(double X, double Y, double Elevation, double Radius, int NumOfSegments, int LineColor, double FillOpacity, int FillColor, HeightStyleCode HeightStyle, int GroupID, string Description)说明 在三维窗口中创建正多边形。例子C#:vbScript:名称，如果为空字符串， TerraExplorer 将自动为其设置一 个唯一的名称。3.5 CreateCircle说明 该方法能够在三维窗口中创建一个圆。 语法void CreateCircle ( in double X,in double Y,in double Elevation, in double Radius,in, defaultvalue(12) int NumOfSegments,in, defaultvalue(0x0000ff00) long LineColor, in, defaultvalue(FT_NONE) double FillOpacity, in, defaultvalue(0x00646464) long FillColor,in, defaultvalue(HSC_TERRAIN_RELATIVE) HeightStyleCode HeightStyle, in, defaultvalue(0) long GroupID,in, defaultvalue() BSTR Description,out, retval ITerrainRegularPolygon5* pITerrainRegPolygon2)参数说明X 经度坐标值。Y 纬度坐标值。Elevation 高程值。Radius 对象的半径(单位：米)。NumOfSegments 圆的分段数。LineColor 圆的弧线的颜色FillOpacity 圆内的填充色是否透明。FillColor 圆内的填充色。HeightStyle 圆在图上的放置形式。HeightStyleCode 可以选择下面的值： oHSC_TERRAIN_RELATIVE = 0 圆的每一个端点在地形图上拥有相同的高程值。 oHSC_PIVOT_RELATIVE = 1高程参 数决 定圆的 中心 点的高 程。 圆的每 个端 点分布 在与 中心点 相同 的平面 上。 oHSC_ON_TERRAIN = 2圆的端点沿地形分布。oHSC_TERRAIN_ABSOLUTE = 3高程参数决定圆的中心点的绝对高程。圆的每个端点分布在与中心点相同的平面上。GroupID 所创建的规则多边形在信息树中所在的组的 ID。如果把它设置为 0，则 图形被创建在根目录下。你可以通过下面几种方式获得 GroupID ：o直接在信息树中创建新组（方法：IInformationTree5:CreateGroup）。o如果你知道组的名称，可以在信息树中找到它 （方法：IInformationTree5:FindItem）。o通过 GetNextItem 方法，在信息树中检索，直到找到想要的 GroupID。Description 将要出现在信息树窗口中的规则多边形的名称。如果该参数被设置为 一个空的字符串，则 TerraExplorer 给它分配一个默认的名字。PITerrainRegularPolygon5 一个新建规则多边形的接口指示器。这个参数必须为 空。返回值返回值含义S_OK成功E_FAIL失败TE_E_MPTNOTLOADED使 用 此 方 法 必 须 先 在TerraExplorer 加载一个 MPT 文 件TE_E_INFOTREE_PARENTNOTGROUP在信息树中输入的组的 ID 值无效TE_E_INTERNALTerraExplorer 不能创建对象。如果想得到关于这个的更多信息请 使用 IErrorInfo 接口TE_E_NOLICENCE你没有使用这项功能的许可例子(C#)using System;using System.Collections.Generic; using System.ComponentModel; using System.Data;using System.Drawing;using System.Text;using System.Windows.Forms;using TerraExplorerX;namespace CreateCirclepublic partial class Form1 : Formprivate TerraExplorer CoClassTE; private ITerraExplorer5 ITerraExplorer; private IObjectManager5 IObjectManager;private IInformationTree5 IInformationTree;private IRender5 IRender;private IMenu IMenu;private ITerrainRegularPolygon5 ITeCircle;private bool bIsLine = false;public Form1()InitializeComponent();CoClassTE = new TerraExplorerClass(); ITerraExplorer = (ITerraExplorer5)CoClassTE; IObjectManager = (IObjectManager5)CoClassTE; IInformationTree = (IInformationTree5)CoClassTE; IRender = (IRender5)CoClassTE;IMenu = (IMenu)CoClassTE;this.CoClassTE.OnLButtonDown+=new_ITerraExplorerEvents5_OnLButtonDownEventHandler(OnLButtonDown);this.CoClassTE.OnRButtonDown+=new_ITerraExplorerEvents5_OnRButtonDownEventHandler(OnRButtonDown);private void Form1_Load(object sender, EventArgs e)IMenu.Invoke(57601);private void btnCreateCircle_Click(object sender, EventArgs e)IRender.SetMouseInputMode(MouseInputMode.MI_COM_CLIENT);bIsLine = true;private void OnLButtonDown(int Flags, int X, int Y, ref object bHandled)if (bIsLine = true)object objType = 63, WX, WH, WY, objID;IRender.ScreenToWorld(X, Y, ref objType, out WX, out WH, out WY, out objID);if (ITeCircle = null)ITeCircle=IObjectManager.CreateCircle(Convert.ToDouble(WX), Convert.ToDouble(WY), 0,30 , 10, 255, 0, 500, HeightStyleCode.HSC_TERRAIN_RELATIVE, 0, 新建的Circle);IInformationTree.EditItem(ITeCircle.InfoTreeItemID);private void OnRButtonDown(int Flags, int X, int Y, ref object bHandled)IRender.SetMouseInputMode(MouseInputMode.MI_FREE_FLIGHT);bIsLine = false;(VBScript)function CreateCircleVB(x,y)dim outX,outY,outH,ObjectIDIRender.ScreenToWorld x,y,63,outX,outH,outY,ObjectIDSet ICircle = IObjectManager.CreateCircle(outX,outY,50,100,12,16744555,1,16744555,0,0,创建圆 )end function3.6 Create3DPolygon说明 该方法能在三维窗口中创建一个三维的多边形。 语法HRESULT Create3DPolygon (in, defaultvalue(0) VARIANT SafeArrayVertices, in, defaultvalue(20) double ObjectHeight,in, defaultvalue(0x0000ff00) long LineColor, in, defaultvalue(FT_NONE) double FillOpacity, in, defaultvalue(0x00646464) long FillColor,in, defaultvalue(0) HeightStyleCode HeightStyle, in, defaultvalue(0) long GroupID,in, defaultvalue() BSTR Description,out, retval ITerrain3DPolygon5* pITerrain3DPolygon5)参数说明SafeArrayVertices 是由许多个三分组组成的数组，每个三分组由三个双精度数成。 每一个三分组包括一个 X 坐标，一个高程值，一个 Y 坐标。通常这个数组决定三维多边形 底部的基础形状(TerraExplorer 将为每个基础的上面部分复制这个形状)。客户用相同的数组 设置所有的高程值。这在决定地表的三维多边形的高程值方面是很重要的。 COM 接口中表 示高程值的单位是 meters 而 X 坐标和 Y 坐标则用 MPT 单位表示。你可以使用 ITerrain 接 口来获取有关 MPT 单位的信息。如果你使用的是 Lat-Long 格式，Lat-Long 的值是十进制 的 Lat-Long。下面是一个用 VB 脚本写的例子，它返回了三个顶点，每个顶点都被设置成了 相同的高程值。Function CreateVertArray() Dim vert(9)vert(0) = -118.82295 vert(1) = 100.0 vert(2) = 34.15543vert(3) = -118.82173 vert(4) = 100.0 vert(5) = 34.15387vert(6) = -118.82284 vert(7) = 100.0 vert(8) = 34.15426CreateVertArray = vertEnd FunctionObjectHeight 三维多边形的高程值(单位：meters)。LineColor 组成三维多边形的线的颜色。颜色值指定使用 RGB 颜色。指定的颜色 值是十六进制格式的（0x00bbggrr）。最大值是 0xFF。FillOpacity 决定三维多边形是否透明，取值范围是 0 到 1 之间。FillColor 是这个三维多边形在不透明的情况下，其内部填充的颜色。颜色值指定 使用 RGB 颜色。HeightStyle 在地形图上放置三维多边形的方式。HeightStyleCode 可以使用下面的值： oHSC_TERRAIN_RELATIVE = 0 使用相对高程。oHSC_TERRAIN_ABSOLUTE = 3使用绝对高程。GroupID 在信息树中新建多边形所在组的 ID 值。如果设置为 0,则表示将在根目录 下创建新对象。返回值返回值含义S_OK成功E_FAIL失败TE_E_MPTNOTLOADED使 用 此 方 法 必 须 先 在TerraExplorer 加载一个 MPT 文 件TE_E_INFOTREE_PARENTNOTGROUP在信息树中输入的组的 ID 值无效TE_E_INTERNALTerraExplorer 不能创建对象。如果想得到关于这个的更多信息请 使用 IErrorInfo 接口TE_E_NOLICENCE你没有使用这项功能的许可例子(C#)using System;using System.Collections.Generic; using System.ComponentModel; using System.Data;using System.Drawing;using System.Text;using System.Windows.Forms;using TerraExplorerX;namespace Create3DPolygonpublic partial class Form1 : Formprivate TerraExplorer CoClassTE; private ITerraExplorer5 ITerraExplorer; private IObjectManager5 IObjectManager; private IInformationTree5 IInformationTree; private IPlane5 IPlane;private IRender5 IRender;private IMenu IMenu;private ITerrain3DPolygon5 ITe3DPoly;private bool bIsLine = false;public Form1()InitializeComponent();CoClassTE = new TerraExplorerClass(); ITerraExplorer = (ITerraExplorer5)CoClassTE; IObjectManager = (IObjectManager5)CoClassTE; IInformationTree = (IInformationTree5)CoClassTE; IPlane = (IPlane5)CoClassTE;IRender = (IRender5)CoClassTE; IMenu = (IMenu)CoClassTE; this.CoClassTE.OnLButtonDown+=new_ITerraExplorerEvents5_OnLButtonDownEventHandler(OnLButtonDown);this.CoClassTE.OnRButtonDown+=new_ITerraExplorerEvents5_OnRButtonDownEventHandler(OnRButtonDown);private void Form1_Load(object sender, EventArgs e)IMenu.Invoke(57601);private void create3DPolygon_Click(object sender, EventArgs e)IRender.SetMouseInputMode(MouseInputMode.MI_COM_CLIENT);bIsLine = true; ITe3DPoly = null;private void OnLButtonDown(int Flags, int X, int Y, ref object bHandled)if (bIsLine = true)object objType = 63, WX, WH, WY, objID;IRender.ScreenToWorld(X, Y, ref objType, out WX, out WH, out WY, out objID);if (ITe3DPoly = null)ITe3DPoly=IObjectManager.Create3DPolygon(0,100,255,0.5,5000, HeightStyleCode.HSC_TERRAIN_ABSOLUTE, 0, 新建的 3DPolygon);ITe3DPoly.AddVertex(Convert.ToDouble(WX) ,Convert.ToDouble(WH) ,Convert.ToDouble(WY) ,0);private void OnRButtonDown(int Flags, int X, int Y, ref object bHandled)IRender.SetMouseInputMode(MouseInputMode.MI_FREE_FLIGHT); bIsLine = false; IInformationTree.EditItem(ITe3DPoly.InfoTreeItemID);(VBScript)function CB(x,y)if isline=true thendim outX,outY,outH,ObjectIDIRender.ScreenToWorld x,y,63,outX,outH,outY,ObjectIDset I3DPolygon = IObjectManager.Create3DPolygon(CreateVertArray(),