com.supermap.realspace
类 Routes

java.lang.Object
  继承者 com.supermap.realspace.Routes

public class Routes
extends java.lang.Object

路线集合类。该类提供了对路线对象的添加、移除、导入、导出等管理功能。 路线集合包含了零个或多个路线对象。


方法摘要
 int add(Route route)
          向路线集合中添加一个指定的路线对象。
 void clear()
          清除路线集合中所有路线。
 boolean contains(java.lang.String name)
          返回飞行管理器中是否包含指定名称的路线。
 boolean fromFile(java.lang.String filePath)
          从指定的文件中导入路线集合对象。
 boolean fromXML(java.lang.String xml)
          从 XML 字符串中导入路线集合对象。
 Route get(int index)
          返回路线集合指定索引处的项。
 Route get(java.lang.String name)
          返回路线集合中与传入名称相同的项。
 double getCameraDistanceX()
          返回飞行时相机与模型的 X 轴方向的距离,单位为米。
 double getCameraDistanceY()
          返回飞行时相机与模型的 Y 轴方向的距离,单位为米。
 double getCameraDistanceZ()
          返回飞行时相机与模型的 Z 轴方向的距离,单位为米。
 int getCount()
          返回路线集合中路线的个数。
 Route getCurrentRoute()
          返回当前的飞行路线,没有飞行路线返回 NULL。
 int getCurrentRouteIndex()
          返回当前选中的路线,默认没有 Route 时为-1,添加 Route 后则不再是非法值。
 int indexOf(java.lang.String name)
          返回指定名称的路线的序号。
 boolean remove(int index)
          从飞行管理中移除给定索引值处的路线对象。
 boolean remove(java.lang.String name)
          从飞行管理中移除给定名称的路线对象。
 void set(int index, Route route)
          设置路线集合指定索引处的项。
 void set(java.lang.String name, Route route)
          使用指定的路线替换路线集合中与传入名称相同的项。
 void setCameraDistanceX(double value)
          设置飞行时相机与模型的 X 轴方向的距离,单位为米。
 void setCameraDistanceY(double value)
          设置飞行时相机与模型的 Y 轴方向的距离,单位为米。
 void setCameraDistanceZ(double value)
          设置飞行时相机与模型的 Z 轴方向的距离,单位为米。
 void setCurrentRouteIndex(int value)
          设置当前选中的路线,默认没有 Route 时为-1,添加 Route 后则不再是非法值。
 void toFile(java.lang.String filePath)
          将路线集合对象输出成文件。
 java.lang.String toXML()
          返回表示路线集合的 XML 描述信息。
 
从类 java.lang.Object 继承的方法
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

方法详细信息

get

public Route get(int index)
返回路线集合指定索引处的项。

参数:
index - 指定的索引。
返回:
路线集合指定索引处的项。

set

public void set(int index,
                Route route)
设置路线集合指定索引处的项。

参数:
index - 指定的索引。
route - 路线集合指定索引处的项。

getCount

public int getCount()
返回路线集合中路线的个数。

返回:
路线集合中路线的个数。

getCurrentRouteIndex

public int getCurrentRouteIndex()
返回当前选中的路线,默认没有 Route 时为-1,添加 Route 后则不再是非法值。

返回:
当前选中的路线

setCurrentRouteIndex

public void setCurrentRouteIndex(int value)
设置当前选中的路线,默认没有 Route 时为-1,添加 Route 后则不再是非法值。

参数:
value - 当前选中的路线

getCameraDistanceX

public double getCameraDistanceX()
返回飞行时相机与模型的 X 轴方向的距离,单位为米。

返回:
飞行时相机与模型的 X 轴方向的距离,单位为米。
默认值:
默认值为0,单位为米。

setCameraDistanceX

public void setCameraDistanceX(double value)
设置飞行时相机与模型的 X 轴方向的距离,单位为米。

参数:
value - 飞行时相机与模型的 X 轴方向的距离,单位为米 。

getCameraDistanceY

public double getCameraDistanceY()
返回飞行时相机与模型的 Y 轴方向的距离,单位为米。

返回:
飞行时相机与模型的 Y 轴方向的距离,单位为米。
默认值:
默认值为0,单位为米。

setCameraDistanceY

public void setCameraDistanceY(double value)
设置飞行时相机与模型的 Y 轴方向的距离,单位为米。

参数:
value - 飞行时相机与模型的 Y 轴方向的距离,单位为米0。

getCameraDistanceZ

public double getCameraDistanceZ()
返回飞行时相机与模型的 Z 轴方向的距离,单位为米。

返回:
飞行时相机与模型的 Z 轴方向的距离,单位为米。
默认值:
默认值为0,单位为米。

setCameraDistanceZ

public void setCameraDistanceZ(double value)
设置飞行时相机与模型的 Z 轴方向的距离,单位为米。

参数:
value - 飞行时相机与模型的 Z 轴方向的距离,单位为米0。

add

public int add(Route route)
向路线集合中添加一个指定的路线对象。

参数:
route - 指定的路线对象。
返回:
新添加路线对象在路线集合中所处的索引值。

remove

public boolean remove(int index)
从飞行管理中移除给定索引值处的路线对象。

参数:
index - 指定的将被移除路线对象的索引值。
返回:
一个布尔值,表示是否移除成功。true 表示移除成功,false 表示失败。

remove

public boolean remove(java.lang.String name)
从飞行管理中移除给定名称的路线对象。

参数:
name - 指定的将被移除路线对象的名称。
返回:
一个布尔值,表示是否移除成功。true 表示移除成功,false 表示失败。

clear

public void clear()
清除路线集合中所有路线。


indexOf

public int indexOf(java.lang.String name)
返回指定名称的路线的序号。

参数:
name - 指定的路线的名称。
返回:
指定名称的路线的序号,如果没有找到则返回-1。

contains

public boolean contains(java.lang.String name)
返回飞行管理器中是否包含指定名称的路线。

参数:
name - 指定的路线名称。
返回:
一个布尔值,表示是否包含指定名称的路线。true 表示包含,false 表示不包含。

toXML

public java.lang.String toXML()
返回表示路线集合的 XML 描述信息。

返回:
XML 字符串,表示该路线集合对象。

fromXML

public boolean fromXML(java.lang.String xml)
从 XML 字符串中导入路线集合对象。

参数:
xml - 表示路线集合对象的 XML 字符串。
返回:
导入成功返回 true,否则返回 false。

toFile

public void toFile(java.lang.String filePath)
将路线集合对象输出成文件。

参数:
filePath - 指定的输出文件的全路径。

fromFile

public boolean fromFile(java.lang.String filePath)
从指定的文件中导入路线集合对象。

参数:
filePath - 指定的文件全路径。
返回:
导入成功返回 true,否则返回 false。

getCurrentRoute

public Route getCurrentRoute()
返回当前的飞行路线,没有飞行路线返回 NULL。

返回:
当前的飞行路线,没有飞行路线返回 NULL。

get

public Route get(java.lang.String name)
返回路线集合中与传入名称相同的项。

参数:
name - 路线名称。
返回:
路线集合中与传入名称相同的项。

set

public void set(java.lang.String name,
                Route route)
使用指定的路线替换路线集合中与传入名称相同的项。

参数:
name - 路线名称。
route - 指定的路线。