BaseTransformableNode

Page Summary

• BaseTransformableNode is a base class for nodes that can be transformed using gestures through the TransformationSystem.

• It provides methods for selecting, transforming, and handling tap events on the node.

• Subclasses can add and remove transformation controllers to customize the transformation behavior.

• It inherits functionalities from Node and NodeParent for scene graph manipulation and lifecycle management.

• The TransformableNode is a direct subclass of BaseTransformableNode and allows for selection, translation, rotation, and scaling.

public abstract class BaseTransformableNode

Known Direct Subclasses TransformableNode TransformableNode Node that can be selected, translated, rotated, and scaled using gestures from TransformationSystem.

Base class for nodes that can be transformed using gestures from TransformationSystem.

Public Constructors

BaseTransformableNode(TransformationSystem transformationSystem)

Public Methods

TransformationSystem	getTransformationSystem()
boolean	isSelected() Returns true if this node is currently selected by the TransformationSystem.
boolean	isTransforming() Returns true if any of the transformation controllers are actively transforming this node.
void	onTap(HitTestResult hitTestResult, MotionEvent motionEvent) Handles when a node has been tapped.
boolean	select() Sets this as the selected node in the TransformationSystem if there is no currently selected node or if the currently selected node is not actively being transformed.

Protected Methods

void	addTransformationController(BaseTransformationController<?> transformationController)
void	removeTransformationController(BaseTransformationController<?> transformationController)

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

From interface com.google.ar.sceneform.Node.OnTapListener

abstract void

onTap(HitTestResult hitTestResult, MotionEvent motionEvent) Handles when a node has been tapped.

Public Constructors

public BaseTransformableNode (TransformationSystem transformationSystem)

Parameters

transformationSystem

Public Methods

public TransformationSystem getTransformationSystem ()

public boolean isSelected ()

Returns true if this node is currently selected by the TransformationSystem.

public boolean isTransforming ()

Returns true if any of the transformation controllers are actively transforming this node.

public void onTap (HitTestResult hitTestResult, MotionEvent motionEvent)

Handles when a node has been tapped.

getNode() will always be this node or one of its children.

Parameters

hitTestResult	represents the node that was tapped and information about where it was touched
motionEvent	the ACTION_UP MotionEvent that caused the tap

public boolean select ()

Sets this as the selected node in the TransformationSystem if there is no currently selected node or if the currently selected node is not actively being transformed.

Returns

• true if the node was successfully selected

See Also

• isTransforming()

Protected Methods

protected void addTransformationController (BaseTransformationController<?> transformationController)

Parameters

transformationController

protected void removeTransformationController (BaseTransformationController<?> transformationController)

Parameters

transformationController