ArcGISView

Namespace: Esri::GameEngine::View
Class: Esri/GameEngine/View/ArcGISView
Since: 1.0.0

Summary

A view for interaction with geographic content from an ArcGISMap.

Constructors

Create a new ArcGISView.

Since 1.0.0

Arguments
NameTypeConstSummary
gameEngineType
No

Specifies the client game engine type.

globeModel
No

Specifies the model used to represent a 3D globe.

Properties

PropertyTypeNullableReadonlySummary
No
No

The current ArcGISCamera.

No
Yes

Manages the registration of positions that will get elevation updates.

Yes
No

The current ArcGISMap.

Yes
Yes

The current ArcGISSpatialReference that is defined by the layers of the ArcGISMap.

No
No

The current view options for the ArcGISView.

Camera

ArcGISCamera GetCamera() const

void SetCamera(const ArcGISCamera& camera)

The current ArcGISCamera.

ElevationProvider

ArcGISElevationProvider GetElevationProvider() const

Manages the registration of positions that will get elevation updates.

Map

ArcGISMap GetMap() const

void SetMap(const ArcGISMap& map)

The current ArcGISMap.

SpatialReference

ArcGISSpatialReference GetSpatialReference() const

The current ArcGISSpatialReference that is defined by the layers of the ArcGISMap.

ViewOptions

ArcGISViewOptions GetViewOptions() const

void SetViewOptions(const ArcGISViewOptions& viewOptions)

The current view options for the ArcGISView.

Methods

SignatureReturn TypeSummary

GeographicToWorld(const ArcGISPoint&)

FVector3d

Transforms a geographic coordinate in a GCS or PCS to game engine world cartesian space. If the view has no spatial reference the returned coordinate will have NaN values.

GetViewState()

ArcGISViewState

Retrieve the view's view state.

GetViewState(const ArcGISElevationSource&)

ArcGISElevationSourceViewState

Retrieve the elevation source's view state.

GetViewState(const ArcGISLayer&)

ArcGISLayerViewState

Retrieve the layer's view state.

HandleLowMemoryWarning()

void

Handle a platform low memory event.

SetMemoryQuotas(int64, int64)

void

Sets the quotas for system and video memory that can be used by the ArcGISView.

SetViewportProperties(uint32_t, uint32_t, float, float, float)

void

Sets the viewport size and field of view. Either field of view angle can be set to 0 to indicate "unset". For example, if verticalFieldOfViewDegrees is 0.0, but horizontalFieldOfViewDegrees is greater than zero, then the viewport vertical field of view will be set to the appropriate value given the horizontal FOV and distortion factor. And vice versa.

WorldToGeographic(FVector3d)

ArcGISPoint

Transforms a world coordinate to a geographic coordinate in the spatial reference of the view. If the view has no spatial reference the returned coordinate will have NaN values.

GeographicToWorld

FVector3d GeographicToWorld(const ArcGISPoint& geographicCoordinate) const

Transforms a geographic coordinate in a GCS or PCS to game engine world cartesian space. If the view has no spatial reference the returned coordinate will have NaN values.

Since 1.0.0

Arguments
NameTypeConstSummary
geographicCoordinate
Yes

The geographic position in a GCS or PCS.

Returns FVector3d

An FVector3d.

GetViewState

ArcGISViewState GetViewState() const

Retrieve the view's view state.

Since 1.0.0

Returns ArcGISViewState

An ArcGISViewState.

GetViewState

ArcGISElevationSourceViewState GetViewState(const ArcGISElevationSource& elevation) const

Retrieve the elevation source's view state.

Since 1.0.0

Arguments
NameTypeConstSummary
elevation
Yes

An elevation object to get the view state for.

Returns ArcGISElevationSourceViewState

An ArcGISElevationSourceViewState.

GetViewState

ArcGISLayerViewState GetViewState(const ArcGISLayer& layer) const

Retrieve the layer's view state.

Since 1.0.0

Arguments
NameTypeConstSummary
layer
Yes

A layer object to get the view state for.

Returns ArcGISLayerViewState

An ArcGISLayerViewState.

HandleLowMemoryWarning

void HandleLowMemoryWarning()

Handle a platform low memory event.

Since 1.0.0

Returns void

SetMemoryQuotas

void SetMemoryQuotas(int64 systemMemory, int64 videoMemory)

Sets the quotas for system and video memory that can be used by the ArcGISView.

Since 1.0.0

Arguments
NameTypeConstSummary
systemMemory
Yes

The system memory quota in MiB.

videoMemory
Yes

The video memory quota in MiB.

Returns void

SetViewportProperties

void SetViewportProperties(uint32_t viewportWidthPixels, uint32_t viewportHeightPixels, float horizontalFieldOfViewDegrees, float verticalFieldOfViewDegrees, float verticalDistortionFactor)

Sets the viewport size and field of view. Either field of view angle can be set to 0 to indicate "unset". For example, if verticalFieldOfViewDegrees is 0.0, but horizontalFieldOfViewDegrees is greater than zero, then the viewport vertical field of view will be set to the appropriate value given the horizontal FOV and distortion factor. And vice versa.

Since 1.0.0

Arguments
NameTypeConstSummary
viewportWidthPixels
Yes

used in visible tile calculation, on the basis that DPI is 96.

viewportHeightPixels
Yes

used in visible tile calculation, on the basis that DPI is 96.

horizontalFieldOfViewDegrees
Yes

A value in degrees. The valid range is 0 to 120.

verticalFieldOfViewDegrees
Yes

A value in degrees. The valid range is 0 to 120.

verticalDistortionFactor
Yes

Determines how much the vertical field of view is distorted. A distortion factor of 1.0 is default. A distortion factor less than 1.0 will cause the visuals to be stretched taller in comparison to their width. A distortion factor greater than 1.0 will cause the visuals to be shrunk shorter in comparison to their width.

Returns void

WorldToGeographic

ArcGISPoint WorldToGeographic(FVector3d worldCoordinate) const

Transforms a world coordinate to a geographic coordinate in the spatial reference of the view. If the view has no spatial reference the returned coordinate will have NaN values.

Since 1.0.0

Arguments
NameTypeConstSummary
worldCoordinate
FVector3d
Yes

The game engine world coordinate.

Returns ArcGISPoint

An ArcGISPoint.

Events

NameTypeSummary
ElevationSourceViewStateChanged

Sets a callback to be invoked when the elevation source view state changes for the view.

LayerViewStateChanged

Sets a callback to be invoked when the layer view state changes for the view.

SpatialReferenceChanged

Sets a callback to be invoked when the View's spatial reference changes.

ViewStateChanged

Sets a callback to be invoked when the view state changes for the view.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.