AugmentedFaceNode

public class AugmentedFaceNode

Node used to render visual effects on a face with ARCore's AugmentedFace feature.

The visual effects can consist of up to two components: The face mesh and the face regions renderable.

The face mesh is used for visualizing 2d images mapped to the surface of someone's face. The face regions renderable is used for visualizing 3d objects (e.g. fox nose and ears) that will move with the regions of the face that are tracked by ARCore.

When creating a face regions Renderable, the regions are mapped to bones in the model. Use the provided sample .fbx file to export a face regions renderable in the correct format.

This node is positioned to match the pose from getCenterPose().

The visual effects will be disabled when the AugmentedFace isn't tracking or the AugmentedFace is set to null.

Public Constructors

	AugmentedFaceNode() Create an AugmentedFaceNode with no AugmentedFace.
	AugmentedFaceNode(AugmentedFace augmentedFace) Create an AugmentedFaceNode with the given AugmentedFace.

Public Methods

AugmentedFace	getAugmentedFace() Returns the AugmentedFace that this Node is applying visual effects to.
Material	getFaceMeshMaterialOverride() Returns the material currently overriding how the face mesh is rendered.
Texture	getFaceMeshTexture() Returns the texture rendered on the face mesh.
ModelRenderable	getFaceRegionsRenderable() Returns the Renderable that is mapped to the regions o the face.
void	onActivate() Handles when this node becomes active.
void	onUpdate(FrameTime frameTime) Handles when this node is updated.
void	setAugmentedFace(AugmentedFace face) Sets the AugmentedFace that this node is applying visual effects to.
void	setFaceMeshMaterialOverride(Material material) Sets the material used to render the face mesh.
void	setFaceMeshTexture(Texture texture) Sets the texture rendered on the face mesh.
void	setFaceRegionsRenderable(ModelRenderable renderable) Sets the Renderable that is mapped to the regions of the face.

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

Create an AugmentedFaceNode with no AugmentedFace.

public AugmentedFaceNode (AugmentedFace augmentedFace)

Create an AugmentedFaceNode with the given AugmentedFace.

Parameters

augmentedFace

Public Methods

public AugmentedFace getAugmentedFace ()

Returns the AugmentedFace that this Node is applying visual effects to.

public Material getFaceMeshMaterialOverride ()

Returns the material currently overriding how the face mesh is rendered. Defaults to null.

public Texture getFaceMeshTexture ()

Returns the texture rendered on the face mesh. Defaults to null.

Note: This is only used if the face mesh material hasn't been overridden.

public ModelRenderable getFaceRegionsRenderable ()

Returns the Renderable that is mapped to the regions o the face. It must be rigged with bones that match the face regions. Use the provided sample .fbx file to export a face regions renderable in the correct format.

public void onActivate ()

Handles when this node becomes active. A Node is active if it's enabled, part of a scene, and its parent is active.

Override to perform any setup that needs to occur when the node is activated.

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 setAugmentedFace (AugmentedFace face)

Sets the AugmentedFace that this node is applying visual effects to.

Parameters

face

public void setFaceMeshMaterialOverride (Material material)

Sets the material used to render the face mesh. The overriding material will not use getFaceMeshTexture(). Set back to null to revert to the default material.

Parameters

material

public void setFaceMeshTexture (Texture texture)

Sets the texture rendered on the face mesh.

Note: This is only used if the face mesh material hasn't been overridden.

Parameters

texture

public void setFaceRegionsRenderable (ModelRenderable renderable)

Sets the Renderable that is mapped to the regions of the face. It must be rigged with bones that match the face regions. Use the provided sample .fbx file to export a face regions renderable in the correct format.

Parameters

renderable