Package com.google.ar.sceneform.rendering

Class ViewRenderable

java.lang.Object

com.google.ar.sceneform.rendering.Renderable

com.google.ar.sceneform.rendering.ViewRenderable

@RequiresApi(api=24)
public class ViewRenderable
extends Renderable

Renders a 2D Android view in 3D space by attaching it to a Node with Node.setRenderable(Renderable). By default, the size of the view is 1 meter in the Scene per 250dp in the layout. Use a ViewSizer to control how the size of the view in the Scene is calculated.

 future = ViewRenderable.builder().setView(context, R.layout.view).build();
 viewRenderable = future.thenAccept(...);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ViewRenderable.Builder	Factory class for ViewRenderable
static class	ViewRenderable.HorizontalAlignment	Controls the horizontal alignment of the ViewRenderable relative to the Node it is attached to.
static class	ViewRenderable.VerticalAlignment	Controls the vertical alignment of the ViewRenderable relative to the Node it is attached to.

Field Summary

Fields inherited from class com.google.ar.sceneform.rendering.Renderable

DEFAULT_ANIMATION_FRAME_RATE, RENDER_PRIORITY_DEFAULT, RENDER_PRIORITY_FIRST, RENDER_PRIORITY_LAST

Method Summary

Modifier and Type	Method	Description
static ViewRenderable.Builder	builder()	Constructs a ViewRenderable
Matrix	getFinalModelMatrix(Matrix originalMatrix)	Takes the model matrix from the TransformProvider for rendering this Node and scales it to size it appropriately based on the meters to pixel ratio for the view.
ViewRenderable.HorizontalAlignment	getHorizontalAlignment()	Gets the ViewRenderable.HorizontalAlignment that controls where the ViewRenderable is positioned relative to the Node it is attached to along the x-axis.
ViewSizer	getSizer()	Gets the ViewSizer that controls the size of this ViewRenderable in the Scene.
ViewRenderable.VerticalAlignment	getVerticalAlignment()	Gets the ViewRenderable.VerticalAlignment that controls where the ViewRenderable is positioned relative to the Node it is attached to along the y-axis.
android.view.View	getView()	The 2D Android View that is rendered by this ViewRenderable.
ViewRenderable	makeCopy()	Creates a new instance of this ViewRenderable.
void	setHorizontalAlignment(ViewRenderable.HorizontalAlignment horizontalAlignment)	Sets the ViewRenderable.HorizontalAlignment that controls where the ViewRenderable is positioned relative to the Node it is attached to along the x-axis.
void	setSizer(ViewSizer viewSizer)	Sets the ViewSizer that controls the size of this ViewRenderable in the Scene.
void	setVerticalAlignment(ViewRenderable.VerticalAlignment verticalAlignment)	Sets the ViewRenderable.VerticalAlignment that controls where the ViewRenderable is positioned relative to the Node it is attached to along the y-axis.

Methods inherited from class com.google.ar.sceneform.rendering.Renderable

createInstance, getAnimationFrameRate, getCollisionShape, getId, getMaterial, getMaterial, getRenderPriority, getSubmeshCount, getSubmeshName, isShadowCaster, isShadowReceiver, setCollisionShape, setMaterial, setMaterial, setRenderPriority, setShadowCaster, setShadowReceiver, updateFromDefinition

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getView

public android.view.View getView()

The 2D Android View that is rendered by this ViewRenderable.

makeCopy

public ViewRenderable makeCopy()

Creates a new instance of this ViewRenderable.

The new renderable will have unique copy of all mutable state. All materials referenced by the ViewRenderable will also be instanced. Immutable data will be shared between the instances. The new ViewRenderable will reference the same getFilamentEngine View as the original ViewRenderable.

Specified by:

makeCopy in class Renderable

getSizer

public ViewSizer getSizer()

Gets the ViewSizer that controls the size of this ViewRenderable in the Scene.

setSizer

public void setSizer(ViewSizer viewSizer)

Sets the ViewSizer that controls the size of this ViewRenderable in the Scene.

getHorizontalAlignment

public ViewRenderable.HorizontalAlignment getHorizontalAlignment()

Gets the ViewRenderable.HorizontalAlignment that controls where the ViewRenderable is positioned relative to the Node it is attached to along the x-axis. The default is ViewRenderable.HorizontalAlignment.CENTER.

setHorizontalAlignment

public void setHorizontalAlignment(ViewRenderable.HorizontalAlignment horizontalAlignment)

Sets the ViewRenderable.HorizontalAlignment that controls where the ViewRenderable is positioned relative to the Node it is attached to along the x-axis. The default is ViewRenderable.HorizontalAlignment.CENTER.

getVerticalAlignment

public ViewRenderable.VerticalAlignment getVerticalAlignment()

Gets the ViewRenderable.VerticalAlignment that controls where the ViewRenderable is positioned relative to the Node it is attached to along the y-axis. The default is ViewRenderable.VerticalAlignment.BOTTOM.

setVerticalAlignment

public void setVerticalAlignment(ViewRenderable.VerticalAlignment verticalAlignment)

Sets the ViewRenderable.VerticalAlignment that controls where the ViewRenderable is positioned relative to the Node it is attached to along the y-axis. The default is ViewRenderable.VerticalAlignment.BOTTOM.

getFinalModelMatrix

public Matrix getFinalModelMatrix(Matrix originalMatrix)

Takes the model matrix from the TransformProvider for rendering this Node and scales it to size it appropriately based on the meters to pixel ratio for the view.

Overrides:

getFinalModelMatrix in class Renderable

Parameters:

originalMatrix -

builder

public static ViewRenderable.Builder builder()

Constructs a ViewRenderable