Service HrzProtocol.ViewerService

Defined in hrz/protocol/viewer/service.proto.

GetConfiguration(HrzProtocol.Void) -> HrzProtocol.ViewerConfiguration

Returns the settings configuration used by the engine.

ScheduleFrameCapture(HrzProtocol.Void) -> HrzProtocol.Void

Schedules a frame to be captured and returned via the message queue. Calling this multiples times before a capture is returned has the same effect as calling it once: only one message with be returned. It is necessary to let the engine run normally after a call to this method to eventually get a result.

PickScreen(HrzProtocol.PickRequest) -> HrzProtocol.PickRequestResult

Picks the scene at the given screen pixel coordinates. The origin is the top-left corner and Y goes down. The coordinates must be given in logical pixels. The picking result will be returned via the message queue. No information about imagery raster layers is returned by default. Pass imagery layer handles to include them in the process.

PickScreenArea(HrzProtocol.Bboxi) -> HrzProtocol.PickAreaRequestResult

Picks the scene inside a given rectangle on the screen. The origin is the top-left corner and Y goes down. The coordinates must be given in logical pixels. The picking result will be returned via the message queue.

FetchRasterData(HrzProtocol.RasterDataFetchRequest) -> HrzProtocol.RasterDataFetchResult

Fetches data from the tiles of the given raster layers at the highest LOD level. The data will be returned via the message queue once loaded.

GetTerrainElevation(HrzProtocol.ElevationRequest) -> HrzProtocol.ElevationRequestResult

Returns the terrain elevation at the given geographic coordinates, using data from DTM layers. This method only returns what has already been loaded in Horizon for viewing or raster data fetch proposes. It does not trigger new data download. This means that the result may be imprecise. This method relies on the tile cache to provide results. For more precise values, use FetchRasterData.

ConfigureMouseHover(HrzProtocol.MouseHoverConfiguration) -> HrzProtocol.Void

Configures continuous mouse hover information sent through the message queue, and/or mouse hover highlighting. The highlighting color is given in the highlighting section of each scene view configuration.

SelectFeatures(HrzProtocol.FeatureReferences) -> HrzProtocol.UInt64Value

Selects features in the scene. Returns the number of features now selected in the scene.

DeselectFeatures(HrzProtocol.FeatureReferences) -> HrzProtocol.UInt64Value

Deselects features from the scene. Returns the number of features now selected in the scene.

DeselectAllFeatures(HrzProtocol.Void) -> HrzProtocol.Void

Deselects everything from the scene. This action can be bound to a key. See HrzProtocol.KeyInteractionBindings.

IsWorking(HrzProtocol.Void) -> HrzProtocol.BoolValue

Gets the viewer scene working status.

SetUserInteractionsEnabled(HrzProtocol.BoolValue) -> HrzProtocol.Void

Enables or disables the capture of system events related to user interactions. Events like the resizing or closure of the window will still be handled by the engine. If the events capture has been disabled in the viewer options at initialization, this method has no effect, and user interactions are permanently disabled.

SendEvents(HrzProtocol.EventsStream) -> HrzProtocol.Void

Sends events to the viewer. It is recommended to batch those calls as much as possible.

ToggleDevUi(HrzProtocol.Void) -> HrzProtocol.BoolValue

Toggles the developement UI. Returns true if the UI is now open, false otherwise. This action can be bound to a key. See HrzProtocol.KeyInteractionBindings.

MoveDevUiToCursor(HrzProtocol.Void) -> HrzProtocol.Void

Moves the developement UI to the cursor position. This action can be bound to a key. See HrzProtocol.KeyInteractionBindings.

ClearHttpCache(HrzProtocol.Void) -> HrzProtocol.Void

(Native only) Clears the embedded HTTP cache.

SetAttributionEnabled(HrzProtocol.BoolValue) -> HrzProtocol.Void

Enables or disables periodic messages giving the list of attributions that is necessary to display to properly attribute the scene elements currently displayed.