Sceneform SDK for Android was open sourced and archived ( github.com/google-ar/sceneform-android-sdk ) with version 1.16.0.
This site ( developers.google.com/sceneform ) serves as the documentation archive for the previous version, Sceneform SDK for Android 1.15.0.
Do not use version 1.17.0 of the Sceneform Maven artifacts .
The 1.17.1 Maven artifacts can be used. Other than the version, however, the 1.17.1 artifacts are identical to the 1.15.0 artifacts.

BaseArFragment

public abstract class BaseArFragment

Known Direct Subclasses

ArFragment

Implements AR Required ArFragment.

The AR fragment brings in the required view layout and controllers for common AR features.

Nested Classes

interface

BaseArFragment.OnSessionInitializationListener

Invoked when the ARCore Session is initialized.

interface

BaseArFragment.OnTapArPlaneListener

Invoked when an ARCore plane is tapped.

Public Constructors

BaseArFragment ()

Public Methods

abstract String[]	getAdditionalPermissions () Returns an array of dangerous permissions that are required by the app in addition to Manifest.permission.CAMERA, which is needed by ARCore.
ArSceneView	getArSceneView () Gets the ArSceneView for this fragment.
PlaneDiscoveryController	getPlaneDiscoveryController () Gets the plane discovery controller, which displays instructions for how to scan for planes.
TransformationSystem	getTransformationSystem () Gets the transformation system, which is used by `TransformableNode` for detecting gestures and coordinating which node is selected.
abstract boolean	isArRequired () Returns true if this application is AR Required, false if AR Optional.
View	onCreateView ( LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
void	onDestroy ()
void	onDestroyView ()
void	onPause ()
void	onPeekTouch ( HitTestResult hitTestResult, MotionEvent motionEvent) Called when a touch event is dispatched to a scene.
void	onRequestPermissionsResult (int requestCode, String[] permissions, int[] results) Receives the results for permission requests.
void	onResume ()
void	onUpdate ( FrameTime frameTime) Called once per frame right before the Scene is updated.
void	setOnSessionInitializationListener ( BaseArFragment.OnSessionInitializationListener onSessionInitializationListener) Registers a callback to be invoked when the ARCore Session is initialized.
void	setOnTapArPlaneListener ( BaseArFragment.OnTapArPlaneListener onTapArPlaneListener) Registers a callback to be invoked when an ARCore Plane is tapped.

Protected Methods

Boolean	getCanRequestDangerousPermissions () If true, `requestDangerousPermissions()` returns without doing anything, if false permissions will be requested
abstract Config	getSessionConfiguration ( Session session)
abstract Set < Session.Feature >	getSessionFeatures () Specifies additional features for creating an ARCore `Session` .
abstract void	handleSessionException ( UnavailableException sessionException)
final void	initializeSession () Initializes the ARCore session.
TransformationSystem	makeTransformationSystem () Creates the transformation system used by this fragment.
void	onWindowFocusChanged (boolean hasFocus)
void	requestDangerousPermissions () Starts the process of requesting dangerous permissions.
final boolean	requestInstall ()
void	setCanRequestDangerousPermissions ( Boolean canRequestDangerousPermissions) If true, `requestDangerousPermissions()` returns without doing anything, if false permissions will be requested
void	setupSelectionRenderable ( FootprintSelectionVisualizer selectionVisualizer)

Inherited Methods

From class android.support.v4.app.Fragment

void	dump ( String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3)
final boolean	equals ( Object arg0)
final FragmentActivity	getActivity ()
boolean	getAllowEnterTransitionOverlap ()
boolean	getAllowReturnTransitionOverlap ()
final Bundle	getArguments ()
final FragmentManager	getChildFragmentManager ()
Context	getContext ()
ViewModelProvider.Factory	getDefaultViewModelProviderFactory ()
Object	getEnterTransition ()
Object	getExitTransition ()
final FragmentManager	getFragmentManager ()
final Object	getHost ()
final int	getId ()
LayoutInflater	getLayoutInflater ( Bundle arg0)
final LayoutInflater	getLayoutInflater ()
Lifecycle	getLifecycle ()
LoaderManager	getLoaderManager ()
final Fragment	getParentFragment ()
final FragmentManager	getParentFragmentManager ()
Object	getReenterTransition ()
final Resources	getResources ()
final boolean	getRetainInstance ()
Object	getReturnTransition ()
final SavedStateRegistry	getSavedStateRegistry ()
Object	getSharedElementEnterTransition ()
Object	getSharedElementReturnTransition ()
final String	getString (int arg0, Object... arg1)
final String	getString (int arg0)
final String	getTag ()
final Fragment	getTargetFragment ()
final int	getTargetRequestCode ()
final CharSequence	getText (int arg0)
boolean	getUserVisibleHint ()
View	getView ()
LifecycleOwner	getViewLifecycleOwner ()
LiveData<LifecycleOwner>	getViewLifecycleOwnerLiveData ()
ViewModelStore	getViewModelStore ()
final boolean	hasOptionsMenu ()
final int	hashCode ()
static Fragment	instantiate ( Context arg0, String arg1)
static Fragment	instantiate ( Context arg0, String arg1, Bundle arg2)
final boolean	isAdded ()
final boolean	isDetached ()
final boolean	isHidden ()
final boolean	isInLayout ()
final boolean	isMenuVisible ()
final boolean	isRemoving ()
final boolean	isResumed ()
final boolean	isStateSaved ()
final boolean	isVisible ()
void	onActivityCreated ( Bundle arg0)
void	onActivityResult (int arg0, int arg1, Intent arg2)
void	onAttach ( Activity arg0)
void	onAttach ( Context arg0)
void	onAttachFragment (Fragment arg0)
void	onConfigurationChanged ( Configuration arg0)
boolean	onContextItemSelected ( MenuItem arg0)
void	onCreate ( Bundle arg0)
Animation	onCreateAnimation (int arg0, boolean arg1, int arg2)
Animator	onCreateAnimator (int arg0, boolean arg1, int arg2)
void	onCreateContextMenu ( ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)
void	onCreateOptionsMenu ( Menu arg0, MenuInflater arg1)
View	onCreateView ( LayoutInflater arg0, ViewGroup arg1, Bundle arg2)
void	onDestroy ()
void	onDestroyOptionsMenu ()
void	onDestroyView ()
void	onDetach ()
LayoutInflater	onGetLayoutInflater ( Bundle arg0)
void	onHiddenChanged (boolean arg0)
void	onInflate ( Activity arg0, AttributeSet arg1, Bundle arg2)
void	onInflate ( Context arg0, AttributeSet arg1, Bundle arg2)
void	onLowMemory ()
void	onMultiWindowModeChanged (boolean arg0)
boolean	onOptionsItemSelected ( MenuItem arg0)
void	onOptionsMenuClosed ( Menu arg0)
void	onPause ()
void	onPictureInPictureModeChanged (boolean arg0)
void	onPrepareOptionsMenu ( Menu arg0)
void	onPrimaryNavigationFragmentChanged (boolean arg0)
void	onRequestPermissionsResult (int arg0, String[] arg1, int[] arg2)
void	onResume ()
void	onSaveInstanceState ( Bundle arg0)
void	onStart ()
void	onStop ()
void	onViewCreated ( View arg0, Bundle arg1)
void	onViewStateRestored ( Bundle arg0)
void	postponeEnterTransition ()
final void	postponeEnterTransition (long arg0, TimeUnit arg1)
void	registerForContextMenu ( View arg0)
final void	requestPermissions ( String[] arg0, int arg1)
final FragmentActivity	requireActivity ()
final Bundle	requireArguments ()
final Context	requireContext ()
final FragmentManager	requireFragmentManager ()
final Object	requireHost ()
final Fragment	requireParentFragment ()
final View	requireView ()
void	setAllowEnterTransitionOverlap (boolean arg0)
void	setAllowReturnTransitionOverlap (boolean arg0)
void	setArguments ( Bundle arg0)
void	setEnterSharedElementCallback (SharedElementCallback arg0)
void	setEnterTransition ( Object arg0)
void	setExitSharedElementCallback (SharedElementCallback arg0)
void	setExitTransition ( Object arg0)
void	setHasOptionsMenu (boolean arg0)
void	setInitialSavedState (Fragment.SavedState arg0)
void	setMenuVisibility (boolean arg0)
void	setReenterTransition ( Object arg0)
void	setRetainInstance (boolean arg0)
void	setReturnTransition ( Object arg0)
void	setSharedElementEnterTransition ( Object arg0)
void	setSharedElementReturnTransition ( Object arg0)
void	setTargetFragment (Fragment arg0, int arg1)
void	setUserVisibleHint (boolean arg0)
boolean	shouldShowRequestPermissionRationale ( String arg0)
void	startActivity ( Intent arg0)
void	startActivity ( Intent arg0, Bundle arg1)
void	startActivityForResult ( Intent arg0, int arg1)
void	startActivityForResult ( Intent arg0, int arg1, Bundle arg2)
void	startIntentSenderForResult ( IntentSender arg0, int arg1, Intent arg2, int arg3, int arg4, int arg5, Bundle arg6)
void	startPostponedEnterTransition ()
String	toString ()
void	unregisterForContextMenu ( View arg0)

From class java.lang.Object

Object	clone ()
boolean	equals ( Object arg0)
void	finalize ()
final Class <?>	getClass ()
int	hashCode ()
final void	notify ()
final void	notifyAll ()
String	toString ()
final void	wait (long arg0, int arg1)
final void	wait (long arg0)
final void	wait ()

From interface android.content.ComponentCallbacks

abstract void	onConfigurationChanged ( Configuration arg0)
abstract void	onLowMemory ()

From interface android.view.View.OnCreateContextMenuListener

abstract void

onCreateContextMenu ( ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)

From interface android.arch.lifecycle.LifecycleOwner

abstract Lifecycle

getLifecycle ()

From interface android.arch.lifecycle.ViewModelStoreOwner

abstract ViewModelStore

getViewModelStore ()

From interface android.arch.lifecycle.HasDefaultViewModelProviderFactory

abstract ViewModelProvider.Factory

getDefaultViewModelProviderFactory ()

From interface androidx.savedstate.SavedStateRegistryOwner

abstract SavedStateRegistry

getSavedStateRegistry ()

From interface com.google.ar.sceneform.Scene.OnPeekTouchListener

abstract void

onPeekTouch ( HitTestResult hitTestResult, MotionEvent motionEvent)

Called when a touch event is dispatched to a scene.

From interface com.google.ar.sceneform.Scene.OnUpdateListener

abstract void

onUpdate ( FrameTime frameTime)

Called once per frame right before the Scene is updated.

Public Constructors

public BaseArFragment ()

Public Methods

public abstract String[] getAdditionalPermissions ()

Returns an array of dangerous permissions that are required by the app in addition to Manifest.permission.CAMERA, which is needed by ARCore. If no additional permissions are needed, an empty array should be returned.

public ArSceneView getArSceneView ()

Gets the ArSceneView for this fragment.

public PlaneDiscoveryController getPlaneDiscoveryController ()

Gets the plane discovery controller, which displays instructions for how to scan for planes.

public TransformationSystem getTransformationSystem ()

Gets the transformation system, which is used by TransformableNode for detecting gestures and coordinating which node is selected.

public abstract boolean isArRequired ()

Returns true if this application is AR Required, false if AR Optional. This is called when initializing the application and the session.

public View onCreateView ( LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

Parameters

inflater
container
savedInstanceState

public void onDestroy ()

public void onDestroyView ()

public void onPause ()

public void onPeekTouch ( HitTestResult hitTestResult, MotionEvent motionEvent)

Called when a touch event is dispatched to a scene. The callback will be invoked before the Scene.OnTouchListener is invoked. This is invoked even if the gesture was consumed, making it possible to observe all motion events dispatched to the scene. This is called even if the touch is not over a node, in which case getNode() will be null.

Parameters

hitTestResult	represents the node that was touched
motionEvent	the motion event

public void onRequestPermissionsResult (int requestCode, String[] permissions, int[] results)

Receives the results for permission requests.

Brings up a dialog to request permissions. The dialog can send the user to the Settings app, or finish the activity.

Parameters

requestCode
permissions
results

public void onResume ()

public void onUpdate ( FrameTime frameTime)

Called once per frame right before the Scene is updated.

Parameters

frameTime

provides time information for the current frame

public void setOnSessionInitializationListener ( BaseArFragment.OnSessionInitializationListener onSessionInitializationListener)

Registers a callback to be invoked when the ARCore Session is initialized. The callback will only be invoked once after the Session is initialized and before it is resumed.

Parameters

onSessionInitializationListener

the

 BaseArFragment.OnSessionInitializationListener

to attach.

public void setOnTapArPlaneListener ( BaseArFragment.OnTapArPlaneListener onTapArPlaneListener)

Registers a callback to be invoked when an ARCore Plane is tapped. The callback will only be invoked if no Node was tapped.

Parameters

onTapArPlaneListener

the

 BaseArFragment.OnTapArPlaneListener

to attach

Protected Methods

protected Boolean getCanRequestDangerousPermissions ()

If true, requestDangerousPermissions() returns without doing anything, if false permissions will be requested

protected abstract Config getSessionConfiguration ( Session session)

Parameters

session

protected abstract Set < Session.Feature > getSessionFeatures ()

Specifies additional features for creating an ARCore Session . See Session.Feature .

protected abstract void handleSessionException ( UnavailableException sessionException)

Parameters

sessionException

protected final void initializeSession ()

Initializes the ARCore session. The CAMERA permission is checked before checking the installation state of ARCore. Once the permissions and installation are OK, the method #getSessionConfiguration(Session session) is called to get the session configuration to use. Sceneform requires that the ARCore session be updated using LATEST_CAMERA_IMAGE to avoid blocking while drawing. This mode is set on the configuration object returned from the subclass.

protected TransformationSystem makeTransformationSystem ()

Creates the transformation system used by this fragment. Can be overridden to create a custom transformation system.

protected void onWindowFocusChanged (boolean hasFocus)

Parameters

hasFocus

protected void requestDangerousPermissions ()

Starts the process of requesting dangerous permissions. This combines the CAMERA permission required of ARCore and any permissions returned from getAdditionalPermissions(). There is no specific processing on the result of the request, subclasses can override onRequestPermissionsResult() if additional processing is needed.

setCanRequestDangerousPermissions(Boolean) can stop this function from doing anything.

protected final boolean requestInstall ()

Throws

UnavailableException

protected void setCanRequestDangerousPermissions ( Boolean canRequestDangerousPermissions)

If true, requestDangerousPermissions() returns without doing anything, if false permissions will be requested

Parameters

canRequestDangerousPermissions

protected void setupSelectionRenderable ( FootprintSelectionVisualizer selectionVisualizer)

Parameters

selectionVisualizer

BaseArFragment Stay organized with collections Save and categorize content based on your preferences.

Nested Classes

Public Constructors

Public Methods

Protected Methods

Inherited Methods

Public Constructors

public BaseArFragment ()

Public Methods

public abstract String[] getAdditionalPermissions ()

public ArSceneView getArSceneView ()

public PlaneDiscoveryController getPlaneDiscoveryController ()

public TransformationSystem getTransformationSystem ()

public abstract boolean isArRequired ()

public View onCreateView ( LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)

Parameters

public void onDestroy ()

public void onDestroyView ()

public void onPause ()

public void onPeekTouch ( HitTestResult hitTestResult, MotionEvent motionEvent)

Parameters

public void onRequestPermissionsResult (int requestCode, String[] permissions, int[] results)

Parameters

public void onResume ()

public void onUpdate ( FrameTime frameTime)

Parameters

public void setOnSessionInitializationListener ( BaseArFragment.OnSessionInitializationListener onSessionInitializationListener)

Parameters

public void setOnTapArPlaneListener ( BaseArFragment.OnTapArPlaneListener onTapArPlaneListener)

Parameters

Protected Methods

protected Boolean getCanRequestDangerousPermissions ()

protected abstract Config getSessionConfiguration ( Session session)

Parameters

protected abstract Set < Session.Feature > getSessionFeatures ()

protected abstract void handleSessionException ( UnavailableException sessionException)

Parameters

protected final void initializeSession ()

protected TransformationSystem makeTransformationSystem ()

protected void onWindowFocusChanged (boolean hasFocus)

Parameters

protected void requestDangerousPermissions ()

protected final boolean requestInstall ()

Throws

protected void setCanRequestDangerousPermissions ( Boolean canRequestDangerousPermissions)

Parameters

protected void setupSelectionRenderable ( FootprintSelectionVisualizer selectionVisualizer)

Parameters

BaseArFragment