ViewRenderable

public class ViewRenderable

Renders a 2D Android view in 3D space by attaching it to a Node with 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 Classes

class	ViewRenderable.Builder		Factory class for ViewRenderable
enum	ViewRenderable.HorizontalAlignment		Controls the horizontal alignment of the ViewRenderable relative to the Node it is attached to.
enum	ViewRenderable.VerticalAlignment		Controls the vertical alignment of the ViewRenderable relative to the Node it is attached to.

Inherited Constants

From class com.google.ar.sceneform.rendering.Renderable

int	RENDER_PRIORITY_DEFAULT
int	RENDER_PRIORITY_FIRST
int	RENDER_PRIORITY_LAST

Inherited Fields

From class com.google.ar.sceneform.rendering.Renderable

protected CollisionShape

collisionShape

Public Methods

static ViewRenderable.Builder	builder() Constructs a ViewRenderable
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.
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.

Inherited Methods

From class com.google.ar.sceneform.rendering.Renderable

CollisionShape	getCollisionShape() Get the CollisionShape used for collision detection with this Renderable.
Material	getMaterial(int submeshIndex) Returns the material bound to the specified submesh.
Material	getMaterial() Returns the material bound to the first submesh.
int	getRenderPriority() Get the render priority that controls the order of rendering.
int	getSubmeshCount() Returns the number of submeshes that this renderable has.
String	getSubmeshName(int submeshIndex) Returns the name associated with the specified submesh.
boolean	isShadowCaster() Returns true if configured to cast shadows on other renderables.
boolean	isShadowReceiver() Returns true if configured to receive shadows cast by other renderables.
abstract Renderable	makeCopy() Creates a new instance of this Renderable.
void	setCollisionShape(CollisionShape collisionShape) Set the CollisionShape used for collision detection with this Renderable.
void	setMaterial(Material material) Sets the material bound to the first submesh.
void	setMaterial(int submeshIndex, Material material) Sets the material bound to the specified submesh.
void	setRenderPriority(int renderPriority) Set the render priority to control the order of rendering.
void	setShadowCaster(boolean isShadowCaster) Sets whether the renderable casts shadow on other renderables in the scene.
void	setShadowReceiver(boolean isShadowReceiver) Sets whether the renderable receives shadows cast by other renderables in the scene.
void	updateFromDefinition(RenderableDefinition definition)

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 Methods

public static ViewRenderable.Builder builder ()

Constructs a ViewRenderable

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 CENTER.

public ViewSizer getSizer ()

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

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 BOTTOM.

public View getView ()

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

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.

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 CENTER.

Parameters

horizontalAlignment

public void setSizer (ViewSizer viewSizer)

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

Parameters

viewSizer

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 BOTTOM.

Parameters

verticalAlignment