Viewport Plugin
The ViewportPlugin provides a structured approach to organizing camera management logic into states and transitions between them.
At any given time, the viewport is either:
idle (not updating the camera)
in a state (camera is being managed by a ViewportState)
transitioning (camera is being managed by a ViewportTransition)
Functions
addStatusObserver
Link copied to clipboard
abstract fun addStatusObserver(viewportStatusObserver: ViewportStatusObserver)
Content copied to clipboard
initialize
Link copied to clipboard
makeDefaultViewportTransition
Link copied to clipboard
abstract fun makeDefaultViewportTransition(options: DefaultViewportTransitionOptions = DefaultViewportTransitionOptions.Builder().build()): DefaultViewportTransition
Content copied to clipboard
makeFollowPuckViewportState
Link copied to clipboard
abstract fun makeFollowPuckViewportState(options: FollowPuckViewportStateOptions = FollowPuckViewportStateOptions.Builder().build()): FollowPuckViewportState
Content copied to clipboard
makeImmediateViewportTransition
Link copied to clipboard
makeOverviewViewportState
Link copied to clipboard
abstract fun makeOverviewViewportState(options: OverviewViewportStateOptions): OverviewViewportState
Content copied to clipboard
onDelegateProvider
Link copied to clipboard
removeStatusObserver
Link copied to clipboard
abstract fun removeStatusObserver(viewportStatusObserver: ViewportStatusObserver)
Content copied to clipboard
transitionTo
Link copied to clipboard
abstract fun transitionTo(targetState: ViewportState, transition: ViewportTransition? = null, completionListener: CompletionListener? = null)
Content copied to clipboard
Properties
defaultTransition
Link copied to clipboard
ViewportPlugin.transitionTo uses this transition unless some non-null value is passed to its transition argument.
options
Link copied to clipboard
Configuration options that impact the ViewportPlugin.
status
Link copied to clipboard
Returns current ViewportStatus.
Inheritors
ViewportPluginImpl
Link copied to clipboard