ViewRenderable.Builder

  • ViewRenderable.Builder is a factory class used to create ViewRenderable instances for displaying Android views in AR scenes.

  • It provides methods to set the source of the view, such as a layout resource or an existing View object.

  • Developers can control the size and alignment of the ViewRenderable within the scene using methods like setSizer, setHorizontalAlignment, and setVerticalAlignment.

  • The build() method is used to finalize the configuration and construct the ViewRenderable instance.
public static final class ViewRenderable.Builder

Factory class for ViewRenderable

Public Methods

CompletableFuture<ViewRenderable>
build()
Constructs a Renderable with the parameters of the builder.
ViewRenderable.Builder
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.
B extends Builder<T extends Renderable, B>
setRegistryId(Object registryId)
ViewRenderable.Builder
setSizer(ViewSizer viewSizer)
Set the ViewSizer that controls the size of the built ViewRenderable in the Scene.
B extends Builder<T extends Renderable, B>
setSource(RenderableDefinition definition)
Build a Renderable from a RenderableDefinition.
B extends Builder<T extends Renderable, B>
setSource(Context context, Uri sourceUri, boolean enableCaching)
B extends Builder<T extends Renderable, B>
setSource(Context context, Callable<InputStream> inputStreamCreator)
B extends Builder<T extends Renderable, B>
setSource(Context context, Uri sourceUri)
B extends Builder<T extends Renderable, B>
setSource(Context context, int resource)
ViewRenderable.Builder
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.
ViewRenderable.Builder
setView(Context context, View view)
ViewRenderable.Builder
setView(Context context, int resourceId)

Protected Methods

void
checkPreconditions()
abstract Class<T extends Renderable>
getRenderableClass()
abstract ResourceRegistry<T extends Renderable>
getRenderableRegistry()
abstract B extends Builder<T extends Renderable, B>
getSelf()
ViewRenderable
makeRenderable()

Inherited Methods

Public Methods

public CompletableFuture<ViewRenderable> build ()

Constructs a Renderable with the parameters of the builder.

Returns

public ViewRenderable.Builder 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 B extends Builder<T extends Renderable, B> setRegistryId (Object registryId)

Parameters
registryId

public ViewRenderable.Builder setSizer (ViewSizer viewSizer)

Set the ViewSizer that controls the size of the built ViewRenderable in the Scene.

Parameters
viewSizer

public B extends Builder<T extends Renderable, B> setSource (RenderableDefinition definition)

Build a Renderable from a RenderableDefinition.

Parameters
definition

public B extends Builder<T extends Renderable, B> setSource (Context context, Uri sourceUri, boolean enableCaching)

Parameters
context
sourceUri
enableCaching

public B extends Builder<T extends Renderable, B> setSource (Context context, Callable<InputStream> inputStreamCreator)

Parameters
context
inputStreamCreator

public B extends Builder<T extends Renderable, B> setSource (Context context, Uri sourceUri)

Parameters
context
sourceUri

public B extends Builder<T extends Renderable, B> setSource (Context context, int resource)

Parameters
context
resource

public ViewRenderable.Builder 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

public ViewRenderable.Builder setView (Context context, View view)

Parameters
context
view

public ViewRenderable.Builder setView (Context context, int resourceId)

Parameters
context
resourceId

Protected Methods

protected void checkPreconditions ()

protected abstract Class<T extends Renderable> getRenderableClass ()

protected abstract ResourceRegistry<T extends Renderable> getRenderableRegistry ()

protected abstract B extends Builder<T extends Renderable, B> getSelf ()

protected ViewRenderable makeRenderable ()