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.

SkeletonNode

AI-generated Key Takeaways

SkeletonNode provides mappings between a skinned ModelRenderable's bones and a set of Nodes, enabling animation and manipulation.
During animation playback, attached Node transforms are set to bone poses in onUpdate(FrameTime), allowing for real-time skeletal animation.
Manipulating attached Nodes will also transform corresponding bones, facilitating interactive control of the skeletal structure.
Calling setRenderable(Renderable) on a SkeletonNode updates attached Node transforms to match the new ModelRenderable's bone poses without altering the existing mappings.
Nodes attached to non-existent bone names or with isActive() set to false will not be transformed and won't affect bone transformations.

public class SkeletonNode

A Node that provides mappings between the bones of a skinned ModelRenderable and a set of Nodes.

When an animation is playing, the transform of the attached Nodes will be set during onUpdate(FrameTime).

Manipulating attached Nodes will also transform corresponding bones. Child bones will not automatically be transformed. To change the transformations of child bones, the child bones will need to be attached to child nodes. If an animation is playing, the node and bone will be set to the animation state each frame during onUpdate(FrameTime). However, attached Nodes can be manipulated after onUpdate(FrameTime) each frame to manipulate bones while an animation is playing.

When the attached Node's isActive() is false, they are not transformed and don't transform bones.

The attached Nodes are also not transformed if they are bound to a boneName that doesn't match any bones in the ModelRenderable.

Calling setRenderable(Renderable) will not change the Node mappings. The attached Nodes' transforms will immediately be set to the pose of matching bones in the new ModelRenderable.

Public Constructors

SkeletonNode()

Public Methods

Node	getBoneAttachment(String boneName) Returns the `Node` attached to the specified bone.
void	onUpdate(FrameTime frameTime) Handles when this node is updated.
void	setBoneAttachment(String boneName, Node node) Attaches a `Node` to the specified boneName.
void	setRenderable(Renderable renderable) Sets the `Renderable` to display for this node.

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

Public Methods

public Node getBoneAttachment (String boneName)

Returns the Node attached to the specified bone. If there is no Node attached to this bone, returns null.

Parameters

boneName

public void onUpdate (FrameTime frameTime)

Handles when this node is updated. A node is updated before rendering each frame. This is only called when the node is active.

Override to perform any updates that need to occur each frame.

Parameters

frameTime	provides time information for the current frame

public void setBoneAttachment (String boneName, Node node)

Attaches a Node to the specified boneName. This will immediately set the transform of the Node to the pose of the bone named boneName in getRenderable() if it exists.

If the Node is null, then any previously attached Node will be detached. Only one Node may be attached to a boneName at a time.

Parameters

boneName
node

public void setRenderable (Renderable renderable)

Sets the Renderable to display for this node. If setCollisionShape(CollisionShape) is not set, then getCollisionShape() is used to detect collisions for this Node.

Parameters

renderable	Usually a 3D model. If null, this node's current renderable will be removed.

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

AI-generated Key Takeaways

Public Constructors

Public Methods

Inherited Methods

Public Constructors

public SkeletonNode ()

Public Methods

public Node getBoneAttachment (String boneName)

Parameters

public void onUpdate (FrameTime frameTime)

Parameters

public void setBoneAttachment (String boneName, Node node)

Parameters

public void setRenderable (Renderable renderable)

Parameters

SkeletonNode