OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
navigation.earth_camera_controller_if.EarthCameraControllerIf Class Reference

Apply camera state to one Google Earth control mechanism. More...

Inherits ABC.

Public Member Functions

str name (self)
 Return the controller's short diagnostic name.
 
bool available (self)
 Return whether this control mechanism can currently be used.
 
bool set_view (self, EarthCameraView view)
 Apply the requested view and report whether it succeeded.
 

Detailed Description

Apply camera state to one Google Earth control mechanism.

Member Function Documentation

◆ available()

bool navigation.earth_camera_controller_if.EarthCameraControllerIf.available (   self)

Return whether this control mechanism can currently be used.

Returns
True if the control mechanism is available.

◆ name()

str navigation.earth_camera_controller_if.EarthCameraControllerIf.name (   self)

Return the controller's short diagnostic name.

Returns
Short diagnostic name.

◆ set_view()

bool navigation.earth_camera_controller_if.EarthCameraControllerIf.set_view (   self,
EarthCameraView  view 
)

Apply the requested view and report whether it succeeded.

Parameters
viewDesired Earth camera state.
Returns
True if the view was applied.

The documentation for this class was generated from the following file: