LiveSight

AndroidXCompositeFragment

The Fragment subclass related to LiveSight functionality is AndroidXCompositeFragment. It is called "composite" because it exposes both Map and LiveSight functionality in one Android UI component, with an easy way to switch between the two; therefore, in addition to methods related to LiveSight functionality, AndroidXCompositeFragment also includes all of the methods found in AndroidXMapFragment. AndroidXCompositeFragment is useful in the situation where an application wants to include both map and LiveSight functionality.

The remainder of this section uses AndroidXCompositeFragment in code samples and discussions.

Adding and Initializing AndroidXCompositeFragment

The first step to integrate LiveSight functionality into an application is to insert a AndroidXCompositeFragment into the view layout. This is accomplished by adding com.here.android.mpa.ar.AndroidXCompositeFragment to the Android XML layout file as follows:

<!-- Example fragment. This can be integrated and annotated
like any other android Fragment or View widget -->
<fragment
  class="com.here.android.mpa.ar.AndroidXCompositeFragment"
  android:id="@+id/compositefragment"
  android:layout_width="fill_parent"
  android:layout_height="fill_parent"/>

After adding AndroidXCompositeFragment to the layout the fragment must be initialized by calling AndroidXCompositeFragment.init(OnEngineInitListener) method. During this asynchronous initialization the MapEngine is initialized to create an instance of Map that is associated with AndroidXCompositeFragment. The ARController is also be created. For more information about ARController, see Customizing LiveSight.

The following code example illustrates the basic initialization flow when an Activity is created. init(OnEngineInitListener) method uses OnEngineInitListener parameter to signal the caller when the asynchronous initialization is completed.

@Override
public void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);

  // setDiskCacheRootPath must be called before compositeFragment.init is called
  // Use path under your application folder for storing the disk cache
  com.here.android.mpa.common.MapSettings.setDiskCacheRootPath(
    getApplicationContext().getExternalFilesDir(null) + File.separator + ".here-maps");


  setContentView(R.layout.activity_main);
  // Search for the Composite Fragment
  final AndroidXCompositeFragment compositeFragment = (AndroidXCompositeFragment)
     getSupportFragmentManager().findFragmentById(R.id.compositefragment);
  // initialize the Composite Fragment and
  // retrieve the map that is associated to the fragment
  compositeFragment.init(new OnEngineInitListener() {
    @Override
    public void onEngineInitializationCompleted(
        OnEngineInitListener.Error error) {
      if (error == OnEngineInitListener.Error.NONE) {
        // now the map is ready to be used
        map = compositeFragment.getMap();
        // the arController is also ready to be used now
        arController = compositeFragment.getARController();
      } else {
        Log.e(LOG_TAG, "Cannot initialize HERE SDK, error " + error);
      }
    }
  });
}