# ViewRenderable

public class **ViewRenderable** Renders a 2D Android view in 3D space by attaching it to a `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Node`
with `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Node#setRenderable(com.google.ar.sceneform.rendering.Renderable)`. By default, the size of the
view is 1 meter in the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Scene` per 250dp in the layout. Use a
`https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewSizer` to control how the size of the view in the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Scene` is calculated.

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

### Nested Classes

|---|---|---|---|
| class | [ViewRenderable.Builder](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.Builder) || Factory class for `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` |
| enum | [ViewRenderable.HorizontalAlignment](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.HorizontalAlignment) || Controls the horizontal alignment of the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` relative to the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Node` it is attached to. |
| enum | [ViewRenderable.VerticalAlignment](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.VerticalAlignment) || Controls the vertical alignment of the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` relative to the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Node` it is attached to. |

### Inherited Constants

From class [com.google.ar.sceneform.rendering.Renderable](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable)

|---|---|---|
| int | [RENDER_PRIORITY_DEFAULT](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#RENDER_PRIORITY_DEFAULT) |   |
| int | [RENDER_PRIORITY_FIRST](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#RENDER_PRIORITY_FIRST) |   |
| int | [RENDER_PRIORITY_LAST](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#RENDER_PRIORITY_LAST) |   |

### Inherited Fields

From class [com.google.ar.sceneform.rendering.Renderable](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable)

|---|---|---|
| protected [CollisionShape](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/collision/CollisionShape) | [collisionShape](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#collisionShape) |   |

### Public Methods

|---|---|
| static [ViewRenderable.Builder](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.Builder) | [builder](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable#builder())() Constructs a `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` |
| [ViewRenderable.HorizontalAlignment](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.HorizontalAlignment) | [getHorizontalAlignment](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable#getHorizontalAlignment())() Gets the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.HorizontalAlignment` that controls where the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` is positioned relative to the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Node` it is attached to along the x-axis. |
| [ViewSizer](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewSizer) | [getSizer](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable#getSizer())() Gets the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewSizer` that controls the size of this `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` in the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Scene`. |
| [ViewRenderable.VerticalAlignment](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.VerticalAlignment) | [getVerticalAlignment](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable#getVerticalAlignment())() Gets the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.VerticalAlignment` that controls where the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` is positioned relative to the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Node` it is attached to along the y-axis. |
| [View](https://developer.android.com/reference/android/view/View) | [getView](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable#getView())() The 2D Android `https://developer.android.com/reference/android/view/View` that is rendered by this `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable`. |
| [ViewRenderable](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable) | [makeCopy](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable#makeCopy())() Creates a new instance of this ViewRenderable. |
| void | [setHorizontalAlignment](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable#setHorizontalAlignment(com.google.ar.sceneform.rendering.ViewRenderable.HorizontalAlignment))([ViewRenderable.HorizontalAlignment](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.HorizontalAlignment) horizontalAlignment) Sets the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.HorizontalAlignment` that controls where the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` is positioned relative to the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Node` it is attached to along the x-axis. |
| void | [setSizer](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable#setSizer(com.google.ar.sceneform.rendering.ViewSizer))([ViewSizer](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewSizer) viewSizer) Sets the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewSizer` that controls the size of this `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` in the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Scene`. |
| void | [setVerticalAlignment](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable#setVerticalAlignment(com.google.ar.sceneform.rendering.ViewRenderable.VerticalAlignment))([ViewRenderable.VerticalAlignment](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.VerticalAlignment) verticalAlignment) Sets the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.VerticalAlignment` that controls where the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` is positioned relative to the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Node` it is attached to along the y-axis. |

### Inherited Methods

From class [com.google.ar.sceneform.rendering.Renderable](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable)

|---|---|
| [CollisionShape](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/collision/CollisionShape) | [getCollisionShape](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#getCollisionShape())() Get the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/collision/CollisionShape` used for collision detection with this `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable`. |
| [Material](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Material) | [getMaterial](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#getMaterial(int))(int submeshIndex) Returns the material bound to the specified submesh. |
| [Material](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Material) | [getMaterial](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#getMaterial())() Returns the material bound to the first submesh. |
| int | [getRenderPriority](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#getRenderPriority())() Get the render priority that controls the order of rendering. |
| int | [getSubmeshCount](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#getSubmeshCount())() Returns the number of submeshes that this renderable has. |
| [String](https://developer.android.com/reference/java/lang/String) | [getSubmeshName](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#getSubmeshName(int))(int submeshIndex) Returns the name associated with the specified submesh. |
| boolean | [isShadowCaster](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#isShadowCaster())() Returns true if configured to cast shadows on other renderables. |
| boolean | [isShadowReceiver](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#isShadowReceiver())() Returns true if configured to receive shadows cast by other renderables. |
| abstract [Renderable](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable) | [makeCopy](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#makeCopy())() Creates a new instance of this Renderable. |
| void | [setCollisionShape](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#setCollisionShape(com.google.ar.sceneform.collision.CollisionShape))([CollisionShape](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/collision/CollisionShape) collisionShape) Set the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/collision/CollisionShape` used for collision detection with this `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable`. |
| void | [setMaterial](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#setMaterial(com.google.ar.sceneform.rendering.Material))([Material](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Material) material) Sets the material bound to the first submesh. |
| void | [setMaterial](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#setMaterial(int,%20com.google.ar.sceneform.rendering.Material))(int submeshIndex, [Material](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Material) material) Sets the material bound to the specified submesh. |
| void | [setRenderPriority](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#setRenderPriority(int))(int renderPriority) Set the render priority to control the order of rendering. |
| void | [setShadowCaster](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#setShadowCaster(boolean))(boolean isShadowCaster) Sets whether the renderable casts shadow on other renderables in the scene. |
| void | [setShadowReceiver](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#setShadowReceiver(boolean))(boolean isShadowReceiver) Sets whether the renderable receives shadows cast by other renderables in the scene. |
| void | [updateFromDefinition](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/Renderable#updateFromDefinition(com.google.ar.sceneform.rendering.RenderableDefinition))([RenderableDefinition](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/RenderableDefinition) definition) |

From class java.lang.Object

|---|---|
| [Object](https://developer.android.com/reference/java/lang/Object) | clone() |
| boolean | equals([Object](https://developer.android.com/reference/java/lang/Object) arg0) |
| void | finalize() |
| final [Class](https://developer.android.com/reference/java/lang/Class)\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| [String](https://developer.android.com/reference/java/lang/String) | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

## Public Methods

#### public static [ViewRenderable.Builder](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.Builder)
**builder**
()

Constructs a `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable`

#### public [ViewRenderable.HorizontalAlignment](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.HorizontalAlignment)
**getHorizontalAlignment**
()

Gets the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.HorizontalAlignment` that controls where the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` is
positioned relative to the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Node` it is attached to along the
x-axis. The default is `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.HorizontalAlignment#CENTER`.

#### public [ViewSizer](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewSizer)
**getSizer**
()

Gets the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewSizer` that controls the size of this `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` in the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Scene`.

#### public [ViewRenderable.VerticalAlignment](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.VerticalAlignment)
**getVerticalAlignment**
()

Gets the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.VerticalAlignment` that controls where the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` is positioned
relative to the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Node` it is attached to along the y-axis. The
default is `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.VerticalAlignment#BOTTOM`.

#### public [View](https://developer.android.com/reference/android/view/View)
**getView**
()

The 2D Android `https://developer.android.com/reference/android/view/View` that is rendered by this `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable`.

#### public [ViewRenderable](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/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](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.HorizontalAlignment) horizontalAlignment)

Sets the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.HorizontalAlignment` that controls where the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` is
positioned relative to the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Node` it is attached to along the
x-axis. The default is `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.HorizontalAlignment#CENTER`.

##### Parameters

| horizontalAlignment |   |
|---|---|

#### public void
**setSizer**
([ViewSizer](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewSizer) viewSizer)

Sets the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewSizer` that controls the size of this `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` in the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Scene`.

##### Parameters

| viewSizer |   |
|---|---|

#### public void
**setVerticalAlignment**
([ViewRenderable.VerticalAlignment](https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.VerticalAlignment) verticalAlignment)

Sets the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.VerticalAlignment` that controls where the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable` is positioned
relative to the `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/Node` it is attached to along the y-axis. The
default is `https://developers.google.com/sceneform/reference/com/google/ar/sceneform/rendering/ViewRenderable.VerticalAlignment#BOTTOM`.

##### Parameters

| verticalAlignment |   |
|---|---|