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.

AnchorNode

Page Summary

AnchorNode automatically positions itself in the world based on an ARCore Anchor, disabling children when the anchor isn't tracking.
It provides methods to get/set the ARCore anchor, control smoothing of transitions, and check tracking status.
When not anchored, AnchorNode allows manipulation of its local and world position and rotation.
If an anchor is set, calls to set local/world position/rotation on the AnchorNode will be ignored.
All child nodes of an AnchorNode will be disabled if the associated anchor is not in the TRACKING state.

public class AnchorNode

Node that is automatically positioned in world space based on an ARCore Anchor.

When the Anchor isn't tracking, all children of this node are disabled.

Public Constructors

	AnchorNode() Create an AnchorNode with no anchor.
	AnchorNode(Anchor anchor) Create an AnchorNode with the specified anchor.

Public Methods

Anchor	getAnchor() Returns the ARCore anchor if it exists or null otherwise.
boolean	isSmoothed() Returns true if the transformations are interpolated or false if they are applied immediately.
boolean	isTracking() Returns true if the ARCore anchorâs tracking state is TRACKING.
void	onUpdate(FrameTime frameTime) AnchorNode overrides this to update the node's position to match the ARCore Anchor's position.
void	setAnchor(Anchor anchor) Set an ARCore anchor and force the position of this node to be updated immediately.
void	setLocalPosition(Vector3 position) Set the local-space position of this node if it is not anchored.
void	setLocalRotation(Quaternion rotation) Set the local-space rotation of this node if it is not anchored.
void	setSmoothed(boolean smoothed) Set true to smooth the transition between the nodeâs current position and the anchor position.
void	setWorldPosition(Vector3 position) Set the world-space position of this node if it is not anchored.
void	setWorldRotation(Quaternion rotation) Set the world-space rotation of this node if it is not anchored.

Inherited Methods

From class com.google.ar.sceneform.Node

void	addLifecycleListener(Node.LifecycleListener lifecycleListener) Adds a listener that will be called when node lifecycle events occur.
void	addTransformChangedListener(Node.TransformChangedListener transformChangedListener) Adds a listener that will be called when the node's transformation changes.
void	callOnHierarchy(Consumer<Node> consumer) Traverses the hierarchy and call a method on each node (including this node).
final boolean	canAddChild(Node child, StringBuilder failureReason)
Node	findInHierarchy(Predicate<Node> condition) Traverses the hierarchy to find the first node (including this node) that meets a condition.
final Vector3	getBack() Gets the world-space back vector (+z) of this node.
CollisionShape	getCollisionShape() Gets the shape to use for collisions with this node.
final Vector3	getDown() Gets the world-space down vector (-y) of this node.
final Vector3	getForward() Gets the world-space forward vector (-z) of this node.
final Vector3	getLeft() Gets the world-space left vector (-x) of this node.
Light	getLight() Gets the current light, which is mutable.
final Vector3	getLocalPosition() Gets a copy of the nodes position relative to its parent (local-space).
final Quaternion	getLocalRotation() Gets a copy of the nodes rotation relative to its parent (local-space).
final Vector3	getLocalScale() Gets a copy of the nodes scale relative to its parent (local-space).
final String	getName() Returns the name of the node.
final Node	getParent() Returns the parent of this node.
Renderable	getRenderable() Gets the renderable to display for this node.
final Vector3	getRight() Gets the world-space right vector (+x) of this node.
final Scene	getScene() Returns the scene that this node is part of, null if it isn't part of any scene.
final Vector3	getUp() Gets the world-space up vector (+y) of this node.
final Vector3	getWorldPosition() Get a copy of the nodes world-space position.
final Quaternion	getWorldRotation() Gets a copy of the nodes world-space rotation.
final Vector3	getWorldScale() Gets a copy of the nodes world-space scale.
final boolean	isActive() Returns true if the node is active.
final boolean	isDescendantOf(NodeParent ancestor) Checks whether the given node parent is an ancestor of this node recursively.
final boolean	isEnabled() Gets the enabled state of this node.
boolean	isTopLevel() Returns true if this node is top level.
final Vector3	localToWorldDirection(Vector3 direction) Converts a direction from the local-space of this node to world-space.
final Vector3	localToWorldPoint(Vector3 point) Converts a point in the local-space of this node to world-space.
void	onActivate() Handles when this node becomes active.
final void	onAddChild(Node child)
void	onDeactivate() Handles when this node becomes inactivate.
final void	onRemoveChild(Node child)
boolean	onTouchEvent(HitTestResult hitTestResult, MotionEvent motionEvent) Handles when this node is touched.
void	onTransformChange(Node originatingNode) Handles when this node's transformation is changed.
void	onUpdate(FrameTime frameTime) Handles when this node is updated.
void	removeLifecycleListener(Node.LifecycleListener lifecycleListener) Removes a listener that will be called when node lifecycle events occur.
void	removeTransformChangedListener(Node.TransformChangedListener transformChangedListener) Removes a listener that will be called when the node's transformation changes.
void	setCollisionShape(CollisionShape collisionShape) Sets the shape to used to detect collisions for this `Node`.
final void	setEnabled(boolean enabled) Sets the enabled state of this node.
void	setLight(Light light) Sets the `Light` to display.
void	setLocalPosition(Vector3 position) Sets the position of this node relative to its parent (local-space).
void	setLocalRotation(Quaternion rotation) Sets the rotation of this node relative to its parent (local-space).
void	setLocalScale(Vector3 scale) Sets the scale of this node relative to its parent (local-space).
final void	setLookDirection(Vector3 lookDirection) Sets the direction that the node is looking at in world-space.
final void	setLookDirection(Vector3 lookDirection, Vector3 upDirection) Sets the direction that the node is looking at in world-space.
final void	setName(String name) Sets the name of this node.
void	setOnTapListener(Node.OnTapListener onTapListener) Registers a callback to be invoked when this node is tapped.
void	setOnTouchListener(Node.OnTouchListener onTouchListener) Registers a callback to be invoked when a touch event is dispatched to this node.
void	setParent(NodeParent parent) Changes the parent node of this node.
void	setRenderable(Renderable renderable) Sets the `Renderable` to display for this node.
void	setWorldPosition(Vector3 position) Sets the world-space position of this node.
void	setWorldRotation(Quaternion rotation) Sets the world-space rotation of this node.
void	setWorldScale(Vector3 scale) Sets the world-space scale of this node.
String	toString()
final Vector3	worldToLocalDirection(Vector3 direction) Converts a direction from world-space to the local-space of this node.
final Vector3	worldToLocalPoint(Vector3 point) Converts a point in world-space to the local-space of this node.

From class com.google.ar.sceneform.NodeParent

final void	addChild(Node child) Adds a node as a child of this NodeParent.
void	callOnHierarchy(Consumer<Node> consumer) Traverse the hierarchy and call a method on each node.
boolean	canAddChild(Node child, StringBuilder failureReason)
Node	findByName(String name) Traverse the hierarchy to find the first node with a given name.
Node	findInHierarchy(Predicate<Node> condition) Traverse the hierarchy to find the first node that meets a condition.
final List<Node>	getChildren() Returns an immutable list of this parent's children.
void	onAddChild(Node child)
void	onRemoveChild(Node child)
final void	removeChild(Node child) Removes a node from the children of this NodeParent.

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()

Public Constructors

public AnchorNode ()

Create an AnchorNode with no anchor.

public AnchorNode (Anchor anchor)

Create an AnchorNode with the specified anchor.

Parameters

anchor	the ARCore anchor that this node will automatically position itself to.

Public Methods

public Anchor getAnchor ()

Returns the ARCore anchor if it exists or null otherwise.

public boolean isSmoothed ()

Returns true if the transformations are interpolated or false if they are applied immediately.

public boolean isTracking ()

Returns true if the ARCore anchorâs tracking state is TRACKING.

public void onUpdate (FrameTime frameTime)

AnchorNode overrides this to update the node's position to match the ARCore Anchor's position.

Parameters

frameTime	provides time information for the current frame

public void setAnchor (Anchor anchor)

Set an ARCore anchor and force the position of this node to be updated immediately.

Parameters

anchor	the ARCore anchor that this node will automatically position itself to.

public void setLocalPosition (Vector3 position)

Set the local-space position of this node if it is not anchored. If the node is anchored, this call does nothing.

Parameters

position	The position to apply.

public void setLocalRotation (Quaternion rotation)

Set the local-space rotation of this node if it is not anchored. If the node is anchored, this call does nothing.

Parameters

rotation	The rotation to apply.

public void setSmoothed (boolean smoothed)

Set true to smooth the transition between the nodeâs current position and the anchor position. Set false to apply transformations immediately. Smoothing is true by default.

Parameters

smoothed	Whether the transformations are interpolated.

public void setWorldPosition (Vector3 position)

Set the world-space position of this node if it is not anchored. If the node is anchored, this call does nothing.

Parameters

position	The position to apply.

public void setWorldRotation (Quaternion rotation)

Set the world-space rotation of this node if it is not anchored. If the node is anchored, this call does nothing.

Parameters

rotation	The rotation to apply.

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

Page Summary

Public Constructors

Public Methods

Inherited Methods

Public Constructors

public AnchorNode ()

public AnchorNode (Anchor anchor)

Parameters

Public Methods

public Anchor getAnchor ()

public boolean isSmoothed ()

public boolean isTracking ()

public void onUpdate (FrameTime frameTime)

Parameters

public void setAnchor (Anchor anchor)

Parameters

public void setLocalPosition (Vector3 position)

Parameters

public void setLocalRotation (Quaternion rotation)

Parameters

public void setSmoothed (boolean smoothed)

Parameters

public void setWorldPosition (Vector3 position)

Parameters

public void setWorldRotation (Quaternion rotation)

Parameters

AnchorNode