ModelRenderable

public class ModelRenderable

Renders a 3D Model by attaching it to a Node with setRenderable(Renderable).

future = ModelRenderable.builder().setSource(context, R.raw.renderable).build();
 renderable = future.thenAccept(...);
 

Nested Classes

class

ModelRenderable.Builder

Factory class for ModelRenderable.

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 ModelRenderable.Builder	builder() Constructs a ModelRenderable.
AnimationData	getAnimationData(int index) Returns the AnimationData at the specified position packaged in this ModelRenderable.
AnimationData	getAnimationData(String name) Returns AnimationData with matching name or null.
int	getAnimationDataCount() Returns the total number of AnimationData packaged with this ModelRenderable.
int	getBoneCount() Returns the number of bones in this renderable if it is skinned.
String	getBoneName(int boneIndex) Returns the name of the bone for the specified bone index.
int	getBoneParentIndex(int boneIndex) Returns the index of the parent bone for the specified bone index.
ModelRenderable	makeCopy() Creates a new instance of this ModelRenderable.

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 ModelRenderable.Builder builder ()

Constructs a ModelRenderable.

public AnimationData getAnimationData (int index)

Returns the AnimationData at the specified position packaged in this ModelRenderable.

Parameters

index

Throws

	IndexOutOfBoundsException} - if the index is out of range (index < 0 || index >= getAnimationDataCount()).

public AnimationData getAnimationData (String name)

Returns AnimationData with matching name or null.

Parameters

name

public int getAnimationDataCount ()

Returns the total number of AnimationData packaged with this ModelRenderable.

public int getBoneCount ()

Returns the number of bones in this renderable if it is skinned. If this renderable is not skinned, returns 0.

public String getBoneName (int boneIndex)

Returns the name of the bone for the specified bone index.

Parameters

boneIndex

Throws

IndexOutOfBoundsException	if the boneIndex is >= getBoneCount().

public int getBoneParentIndex (int boneIndex)

Returns the index of the parent bone for the specified bone index. If the bone has no parent it is a root bone and -1 is returned.

Parameters

boneIndex

Throws

IndexOutOfBoundsException	if the boneIndex is >= getBoneCount().

public ModelRenderable makeCopy ()

Creates a new instance of this ModelRenderable.

The new renderable will have unique copy of all mutable state. All materials referenced by the ModelRenderable will also be instanced. Immutable data will be shared between the instances.