com.here.android.mpa.ar

Class AndroidXCompositeFragment

java.lang.Object

androidx.fragment.app.Fragment

com.here.android.mpa.ar.AndroidXCompositeFragment

All Implemented Interfaces:

android.content.ComponentCallbacks, android.view.View.OnCreateContextMenuListener, androidx.lifecycle.LifecycleOwner, androidx.lifecycle.ViewModelStoreOwner, com.nokia.maps.MapUi

public class AndroidXCompositeFragment
extends androidx.fragment.app.Fragment
implements com.nokia.maps.MapUi

Composite fragment which enables usage of AR and Map functionality within the same view context. This class contains methods which are specific to Map as well as methods specific to AR. Concretely, provides the same functionality as AndroidXMapFragment in addition to AR functionality.

See Also:

AndroidXMapFragment

Nested Class Summary

Nested classes/interfaces inherited from class androidx.fragment.app.Fragment

androidx.fragment.app.Fragment.InstantiationException, androidx.fragment.app.Fragment.SavedState

Constructor Summary

Constructors

Constructor and Description
AndroidXCompositeFragment() Constructor

Method Summary

Modifier and Type	Method and Description
void	addOnMapRenderListener(OnMapRenderListener listener) Adds a OnMapRenderListener to listen for map render events.
ARController	getARController() Get ARController
ViewRect	getClipRect() Returns the ViewRect representing the clip rectangle for this AndroidXCompositeFragment.
android.graphics.Rect	getCopyrightBoundaryRect() Gets the current HERE copyright logo's boundary rectangle.
int	getCopyrightLogoHeight() Returns the height of the copyright logo.
CopyrightLogoPosition	getCopyrightLogoPosition() Returns the on-screen position of the HERE copyright logo as a CopyrightLogoPosition value.
int	getCopyrightLogoWidth() Returns the width of the copyright logo.
int	getCopyrightMargin() Returns the current margin for the HERE copyright logo, in number of pixels, as an offset from the edge of the visible map area to the edge of the logo.
int	getHeight() Gets the current height of the fragment, in pixels.
Map	getMap() Returns the instance of Map associated with this fragment
MapGesture	getMapGesture() Returns the MapGesture object representing the current gesture handler for the AndroidXCompositeFragment.
void	getScreenCapture(OnScreenCaptureListener listener) Returns the full screen bitmap for the AndroidXCompositeFragment.
int	getWidth() Gets the current width of the fragment, in pixels.
void	init(ApplicationContext context, OnEngineInitListener listener) Users of AndroidXCompositeFragment must call this function after the fragment is first attached to its activity.
void	init(OnEngineInitListener listener) Users of AndroidXCompositeFragment must call this function after the fragment is first attached to its activity.
android.view.View	onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState)
void	onDestroyView()
void	onInflate(android.content.Context context, android.util.AttributeSet attrs, android.os.Bundle savedInstanceState)
void	onPause() Called when this fragment is no longer resumed.
void	onResume() Called when this fragment is visible to the user and actively running.
void	onSaveInstanceState(android.os.Bundle outState)
void	removeOnMapRenderListener(OnMapRenderListener listener) Removes an existing OnMapRenderListener.
void	setClipRect(ViewRect rect) Sets a clipping rectangle to this AndroidXCompositeFragment.
void	setClipRect(ViewRect rect, android.graphics.PointF transformCenter) Sets a clipping rectangle to the AndroidXCompositeFragment.
void	setCopyrightBoundaryRect(android.graphics.Rect rect) Sets a rectangle, in pixels, relative to the top left corner of the AndroidXCompositeFragment 's boundary, for the placement of the HERE copyright logo.
void	setCopyrightLogoPosition(CopyrightLogoPosition position) Sets a position for the HERE copyright logo.
void	setCopyrightMargin(int margin) Sets a margin for the HERE copyright logo, in number of pixels, as an offset from the edge of the visible map area to the edge of the logo (depending on the placement).
void	setMapMarkerDragListener(MapMarker.OnDragListener listener) Sets a OnDragListener to be invoked whenever any MapMarker on a Map that is attached to this fragment is dragged.
void	setOnTouchListener(android.view.View.OnTouchListener listener) Sets an View.OnTouchListener to be invoked whenever a touch event is sent to the AndroidXCompositeFragment.

Methods inherited from class androidx.fragment.app.Fragment

dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewLifecycleOwner, getViewLifecycleOwnerLiveData, getViewModelStore, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isStateSaved, isVisible, onActivityCreated, onActivityResult, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreate, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroy, onDestroyOptionsMenu, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPictureInPictureModeChanged, onPrepareOptionsMenu, onRequestPermissionsResult, onStart, onStop, onViewCreated, onViewStateRestored, postponeEnterTransition, registerForContextMenu, requestPermissions, requireActivity, requireContext, requireFragmentManager, requireHost, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AndroidXCompositeFragment

public AndroidXCompositeFragment()

Constructor

Method Detail

init

public void init(OnEngineInitListener listener)

Users of AndroidXCompositeFragment must call this function after the fragment is first attached to its activity. This automatically initializes the MapEngine and creates an ARController for use. This method is a convenience method that can be used for fragments embedded in a layout XML. This method should not be used when programmatically creating an AndroidXCompositeFragment.

This method will initialize MapEngine with MapEngine.MapVariant.GLOBAL map variant on first SDK usage and with stored map variant on sub-sequent usages.

Parameters:

listener - A OnEngineInitListener object that will be called when AndroidXCompositeFragment and MapEngine initialization is finished. A null object can be supplied if callers do not expect any notification when initialization completes.

See Also:

OnEngineInitListener, MapEngine.init(ApplicationContext,OnEngineInitListener), AndroidXCompositeFragment.init(ApplicationContext, com.here.android.mpa.common.OnEngineInitListener)

init

public void init(ApplicationContext context,
                 OnEngineInitListener listener)

Users of AndroidXCompositeFragment must call this function after the fragment is first attached to its activity. This automatically initializes the MapEngine and creates an ARController for use. This method is a convenience method that can be used for fragments embedded in a layout XML. This method should not be used when programmatically creating an AndroidXCompositeFragment.

Parameters:

context - ApplicationContext to be used during initialization.

listener - A OnEngineInitListener object that will be called when AndroidXCompositeFragment and MapEngine initialization is finished. A null object can be supplied if callers do not expect any notification when initialization completes.

See Also:

OnEngineInitListener, MapEngine.init( com.here.android.mpa.common.ApplicationContext, com.here.android.mpa.common.OnEngineInitListener), AndroidXCompositeFragment.init(ApplicationContext, OnEngineInitListener)

onCreateView

public android.view.View onCreateView(android.view.LayoutInflater inflater,
                                      android.view.ViewGroup container,
                                      android.os.Bundle savedInstanceState)

Overrides:

onCreateView in class androidx.fragment.app.Fragment

Override:

androidx.fragment.app.Fragment.onCreateView(LayoutInflater, viewGrup, Bundle)

onInflate

public void onInflate(android.content.Context context,
                      android.util.AttributeSet attrs,
                      android.os.Bundle savedInstanceState)

Overrides:

onInflate in class androidx.fragment.app.Fragment

Override:

androidx.fragment.app.Fragment.onInflate(Context, AttributeSet, Bundle)

onResume

public void onResume()

Called when this fragment is visible to the user and actively running. All MapEngine activities will be resumed automatically.

Overrides:

onResume in class androidx.fragment.app.Fragment

See Also:

Fragment.onResume()

onPause

public void onPause()

Called when this fragment is no longer resumed. All MapEngine activities will be paused automatically.

Overrides:

onPause in class androidx.fragment.app.Fragment

See Also:

Fragment.onPause()

onDestroyView

public void onDestroyView()

Overrides:

onDestroyView in class androidx.fragment.app.Fragment

Override:

androidx.fragment.app.Fragment.onDestroyView()

setOnTouchListener

public void setOnTouchListener(android.view.View.OnTouchListener listener)

Sets an View.OnTouchListener to be invoked whenever a touch event is sent to the AndroidXCompositeFragment.

Specified by:

setOnTouchListener in interface com.nokia.maps.MapUi

Parameters:

listener - An View.OnTouchListener to set for the AndroidXCompositeFragment

See Also:

android.view.View.OnTouchListener

getARController

public ARController getARController()

Get ARController

Returns:

ARController object

getWidth

public int getWidth()

Gets the current width of the fragment, in pixels.

Returns:

The current width

getHeight

public int getHeight()

Gets the current height of the fragment, in pixels.

Returns:

The current height

onSaveInstanceState

public void onSaveInstanceState(android.os.Bundle outState)

Overrides:

onSaveInstanceState in class androidx.fragment.app.Fragment

getScreenCapture

public void getScreenCapture(OnScreenCaptureListener listener)

Returns the full screen bitmap for the AndroidXCompositeFragment. This method is asynchronous and will invoke a callback once the operation is completed through the operation is completed through the OnScreenCaptureListener the AndroidXCompositeFragment must be visible to create the screen capture. Note that the current functionality of this API is limited to getting a screen capture of the Map. Future releases maybe enhanced to support getting screen capture of the AR and Map composite.

Parameters:

listener - A OnScreenCaptureListener to listen for the callback when screen capture is complete.

getMap

public Map getMap()

Returns the instance of Map associated with this fragment

Specified by:

getMap in interface com.nokia.maps.MapUi

Returns:

The Map object currently displayed in this fragment.

getClipRect

public ViewRect getClipRect()

Returns the ViewRect representing the clip rectangle for this AndroidXCompositeFragment.

Specified by:

getClipRect in interface com.nokia.maps.MapUi

Returns:

The clip rectangle for rendering MapObjects and similar map-related screen elements. null if the view's layout process has yet to be completed. If the process is not yet complete, users can either retry later or subscribe as a OnMapRenderListener and call this method upon the callback OnMapRenderListener.onSizeChanged(int,int).

setClipRect

public void setClipRect(ViewRect rect,
                        android.graphics.PointF transformCenter)

Sets a clipping rectangle to the AndroidXCompositeFragment. Only the area specified by the ViewRect will be used for rendering, while the rest of the view will be masked in black. This rectangle will be reset to the full size of the AndroidXCompositeFragment upon screen rotation or upon recreating the screen.

Note that setting a clipping rectangle will also reset the AndroidXCompositeFragment's viewing rectangle to its full default size.

If the ViewRect is not valid, this method does nothing.

Specified by:

setClipRect in interface com.nokia.maps.MapUi

Parameters:

rect - A ViewRect for rendering MapObjects and similar map-related screen elements

transformCenter - A PointF representing the center coordinate for map transformations such as zooming and rotation

See Also:

AndroidXCompositeFragment.setClipRect(ViewRect)

setClipRect

public void setClipRect(ViewRect rect)

Sets a clipping rectangle to this AndroidXCompositeFragment. Only the area specified by the ViewRect will be used for rendering, while the rest of the view will be masked in black. This rectangle will be reset to the full size of the AndroidXCompositeFragment upon screen rotation or upon recreating the screen.

If the ViewRect is not valid, this method does nothing.

Specified by:

setClipRect in interface com.nokia.maps.MapUi

Parameters:

rect - A ViewRect for rendering MapObjects and similar map-related screen elements

See Also:

AndroidXCompositeFragment.setClipRect(ViewRect, PointF)

getCopyrightBoundaryRect

public android.graphics.Rect getCopyrightBoundaryRect()

Gets the current HERE copyright logo's boundary rectangle. Returns null if a boundary rect has not been set previously.

Specified by:

getCopyrightBoundaryRect in interface com.nokia.maps.MapUi

Returns:

The copyright logo's boundary rect. null if a boundary rect has not been set previously.

See Also:

AndroidXCompositeFragment.setCopyrightBoundaryRect(Rect)

setCopyrightBoundaryRect

public void setCopyrightBoundaryRect(android.graphics.Rect rect)

Sets a rectangle, in pixels, relative to the top left corner of the AndroidXCompositeFragment 's boundary, for the placement of the HERE copyright logo.

If the specified rectangle is not contained completely within the current visible map area, their area of intersection will be used instead of the specified rectangle's area. The copyright logo and copyright margin must fit into the rectangle, otherwise specified rectangle will be ignored.

The rectangle is reset upon screen rotation or upon screen re-creation, or it can be done by setting a null-android.graphics.Rect.

Specified by:

setCopyrightBoundaryRect in interface com.nokia.maps.MapUi

Parameters:

rect - A android.graphics.Rect representing the desired rectangular container to be used for positioning the copyright logo. Use null android.graphics.Rect to reset the boundary container.

Throws:

java.lang.IllegalArgumentException - if android.graphics.Rect supplied is invalid

getCopyrightMargin

public int getCopyrightMargin()

Returns the current margin for the HERE copyright logo, in number of pixels, as an offset from the edge of the visible map area to the edge of the logo.

This method only returns a valid value once fragment initialization has taken place.

Specified by:

getCopyrightMargin in interface com.nokia.maps.MapUi

Returns:

The current offset from the edge of the AndroidXCompositeFragment, in number of pixels

setCopyrightMargin

public void setCopyrightMargin(int margin)

Sets a margin for the HERE copyright logo, in number of pixels, as an offset from the edge of the visible map area to the edge of the logo (depending on the placement).

Specified by:

setCopyrightMargin in interface com.nokia.maps.MapUi

Parameters:

margin - Desired offset from the edge of the AndroidXCompositeFragment

getCopyrightLogoWidth

public int getCopyrightLogoWidth()

Returns the width of the copyright logo.

This method only returns a valid value once fragment initialization has completed.

Specified by:

getCopyrightLogoWidth in interface com.nokia.maps.MapUi

Returns:

The width of the copyright logo, in number of pixels

getCopyrightLogoHeight

public int getCopyrightLogoHeight()

Returns the height of the copyright logo.

This method only returns a valid value once fragment initialization has taken completed.

Specified by:

getCopyrightLogoHeight in interface com.nokia.maps.MapUi

Returns:

The height of the copyright logo, in number of pixels

getCopyrightLogoPosition

public CopyrightLogoPosition getCopyrightLogoPosition()

Returns the on-screen position of the HERE copyright logo as a CopyrightLogoPosition value.

Specified by:

getCopyrightLogoPosition in interface com.nokia.maps.MapUi

Returns:

The position of the logo.

setCopyrightLogoPosition

public void setCopyrightLogoPosition(CopyrightLogoPosition position)

Sets a position for the HERE copyright logo. The current default is to place the logo at the center-bottom of the visible map view area.

After the logo's position is set, the position stays effective even when the screen is rotated or re-created.

Specified by:

setCopyrightLogoPosition in interface com.nokia.maps.MapUi

Parameters:

position - A CopyrightLogoPosition value representing the desired placement of the HERE copyright logo with respect to the visible map view area

getMapGesture

public MapGesture getMapGesture()

Returns the MapGesture object representing the current gesture handler for the AndroidXCompositeFragment. Applications can intercept this object and override the default event behaviors.

Specified by:

getMapGesture in interface com.nokia.maps.MapUi

Returns:

The MapGesture

addOnMapRenderListener

public void addOnMapRenderListener(OnMapRenderListener listener)

Adds a OnMapRenderListener to listen for map render events.

Specified by:

addOnMapRenderListener in interface com.nokia.maps.MapUi

Parameters:

listener - A OnMapRenderListener to add to the AndroidXCompositeFragment

See Also:

AndroidXCompositeFragment.removeOnMapRenderListener(OnMapRenderListener)

removeOnMapRenderListener

public void removeOnMapRenderListener(OnMapRenderListener listener)

Removes an existing OnMapRenderListener.

Specified by:

removeOnMapRenderListener in interface com.nokia.maps.MapUi

Parameters:

listener - A OnMapRenderListener to remove from the AndroidXCompositeFragment

setMapMarkerDragListener

public void setMapMarkerDragListener(MapMarker.OnDragListener listener)

Sets a OnDragListener to be invoked whenever any MapMarker on a Map that is attached to this fragment is dragged.

Specified by:

setMapMarkerDragListener in interface com.nokia.maps.MapUi

Parameters:

listener - An MapMarker.OnDragListener to set for this AndroidXCompositeFragment