com.supermap.realspace
Class Route
- java.lang.Object
-
- com.supermap.data.InternalHandle
-
- com.supermap.data.InternalHandleDisposable
-
- com.supermap.realspace.Route
-
public class Route extends InternalHandleDisposable
Route object class.This class is used to set the flight path.
-
-
Constructor Summary
Constructors Constructor and Description Route()
Construct a new Route objectRoute(Route route)
Constructs a new object identical to the given Route object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description void
dispose()
Release the resources occupied by the object.boolean
fromGeoLine3D(GeoLine3D value)
Whether the flight path is initialized by the line object.boolean
fromXML(java.lang.String value)
Import objects from an XML string.GeoStyle3D
getDefaultStyle()
Get the style of the route object.java.lang.String
getName()
Returns the name of the flight route.double
getSpeed()
Returns the speed of the flight route in meters per second.boolean
isAltitudeFixed()
Returns whether the route object locks the elevation.boolean
isFlyAlongTheRoute()
Returns whether the route object is flying along the line.boolean
isFlyingLoop()
Returns whether the route object is flying in a loop.boolean
isHeadingFixed()
Returns whether the route object locks the azimuth.boolean
isLinesVisible()
Returns whether the route object is visible.boolean
isStopsVisible()
Returns whether the route site is visible.boolean
isTiltFixed()
Returns whether the route object locks the pitch angle.void
setAltitudeFixed(boolean value)
Sets whether the route object locks the elevation.void
setDefaultStyle(GeoStyle3D value)
Set the style of the route object.void
setFlyAlongTheRoute(boolean value)
Set whether the route object is flying along the line.void
setFlyingLoop(boolean value)
Set whether the route object is flying in a loop.void
setHeadingFixed(boolean value)
Sets whether the route object locks the azimuth.void
setLinesVisible(boolean value)
Set whether the route object is visible.void
setName(java.lang.String value)
Set the name of the flight route.void
setSpeed(double value)
Set the speed of the flight route in meters per second.void
setStops(RouteStops value)
Set the site collection for this route object.void
setStopsVisible(boolean value)
Set whether the route site is visible.void
setTiltFixed(boolean value)
Sets whether the route object locks the pitch angle.GeoLine3D
toGeoLine3D()
Output the route as a line object.java.lang.String
toXML()
Returns an XML description that represents the route object.
-
-
-
Constructor Detail
-
Route
public Route()
Construct a new Route object
-
Route
public Route(Route route)
Constructs a new object identical to the given Route object.- Parameters:
route
- The given Route object.
-
-
Method Detail
-
toXML
public java.lang.String toXML()
Returns an XML description that represents the route object.- Returns:
- The XML description of the route object.
-
fromXML
public boolean fromXML(java.lang.String value)
Import objects from an XML string.- Parameters:
value
- The specified XML string.- Returns:
- A Boolean value indicating whether the imported object was successful. Returns true if the import succeeds, otherwise returns false.
-
toGeoLine3D
public GeoLine3D toGeoLine3D()
Output the route as a line object.- Returns:
- Line object.
-
setStops
public void setStops(RouteStops value)
Set the site collection for this route object.- Parameters:
value
- The specified site collection object.
-
getDefaultStyle
public GeoStyle3D getDefaultStyle()
Get the style of the route object.- Returns:
- The style of the flight route.
-
setDefaultStyle
public void setDefaultStyle(GeoStyle3D value)
Set the style of the route object.- Parameters:
value
- The specified flight route style.
-
isAltitudeFixed
public boolean isAltitudeFixed()
Returns whether the route object locks the elevation.- Returns:
- A Boolean value indicating whether the elevation is locked. True means lock, false means not lock.
- Default:
- The default value is true, which means that the elevation is locked.
-
setAltitudeFixed
public void setAltitudeFixed(boolean value)
Sets whether the route object locks the elevation.- Parameters:
value
- A Boolean value that specifies whether to lock the elevation.
-
isHeadingFixed
public boolean isHeadingFixed()
Returns whether the route object locks the azimuth.- Returns:
- A Boolean value indicating whether the azimuth is locked. True means lock, false means not lock. * @default The default value is true, which locks the azimuth.
-
setHeadingFixed
public void setHeadingFixed(boolean value)
Sets whether the route object locks the azimuth.- Parameters:
value
- A Boolean value that specifies whether to lock the azimuth.
-
isLinesVisible
public boolean isLinesVisible()
Returns whether the route object is visible.- Returns:
- A Boolean value indicating whether the route is visible. True means visible, false means invisible.
-
setLinesVisible
public void setLinesVisible(boolean value)
Set whether the route object is visible.- Parameters:
value
- A Boolean value that specifies whether the route is visible.
-
isStopsVisible
public boolean isStopsVisible()
Returns whether the route site is visible.- Returns:
- A Boolean value indicating whether the route site is visible. True means visible, false means invisible.
-
setStopsVisible
public void setStopsVisible(boolean value)
Set whether the route site is visible.- Parameters:
value
- A Boolean value that specifies whether the route site is visible.
-
isTiltFixed
public boolean isTiltFixed()
Returns whether the route object locks the pitch angle.- Returns:
- A Boolean value indicating whether the pitch angle is locked. True means lock, false means not lock.
-
setTiltFixed
public void setTiltFixed(boolean value)
Sets whether the route object locks the pitch angle.- Parameters:
value
- A Boolean value that specifies whether the route site locks the pitch angle.
-
isFlyingLoop
public boolean isFlyingLoop()
Returns whether the route object is flying in a loop.- Returns:
- A Boolean value indicating whether to loop. True means loop flight, false means no loop flight.
-
setFlyingLoop
public void setFlyingLoop(boolean value)
Set whether the route object is flying in a loop.- Parameters:
value
- A Boolean value that specifies whether the route site is flying in a loop.
-
isFlyAlongTheRoute
public boolean isFlyAlongTheRoute()
Returns whether the route object is flying along the line.- Returns:
- A Boolean value indicating whether to fly along the line. True means flying along the line, false means not flying along the line.
-
setFlyAlongTheRoute
public void setFlyAlongTheRoute(boolean value)
Set whether the route object is flying along the line.- Parameters:
value
- A Boolean value that specifies whether the route site is flying along the line.
-
getSpeed
public double getSpeed()
Returns the speed of the flight route in meters per second. If the user does not set the flight speed for a site, the flight speed of the site is the flight speed of the route.- Returns:
- The speed of the flight route.
- Default:
- The default value is 50.0 in meters/second.
-
setSpeed
public void setSpeed(double value)
Set the speed of the flight route in meters per second.- Parameters:
value
- specifies the flight path speed.
-
getName
public java.lang.String getName()
Returns the name of the flight route.- Returns:
- Flight route name.
-
setName
public void setName(java.lang.String value)
Set the name of the flight route.- Parameters:
value
- Specifies the flight path name.
-
dispose
public void dispose()
Release the resources occupied by the object.
-
fromGeoLine3D
public boolean fromGeoLine3D(GeoLine3D value)
Whether the flight path is initialized by the line object.- Parameters:
value
- Specifies the line object that initializes the flight path.- Returns:
- A Boolean value indicating whether the flight path is initialized by the line object.
-
-