sceneview/com.google.ar.sceneform.rendering/RenderableInstance

RenderableInstance

open class RenderableInstance : AnimatableModel

Controls how a Renderable is displayed. There can be multiple RenderableInstances displaying a single Renderable.

Constructors

RenderableInstance

constructor(engine: Engine, assetLoader: AssetLoader, resourceLoader: ResourceLoader, transformProvider: TransformProvider, renderable: Renderable)

Types

SkinningModifier

interface SkinningModifier

Interface for modifying the bone transforms for this specific RenderableInstance.

Properties

open val entity: Int

open val filamentAsset: FilamentAsset

open var isShadowCaster: Boolean

isShadowReceiver

open var isShadowReceiver: Boolean

val renderable: Renderable

open var renderableId: Int

open var renderPriority: Int

Functions

open fun animate(repeat: Boolean): ObjectAnimator

Constructs and returns an ObjectAnimator for all ModelAnimation of this object.

open fun animate(animationIndexes: Array<Int>): ObjectAnimator

Constructs and returns an ObjectAnimator for targeted ModelAnimation with a a given index of this object.

open fun animate(animations: Array<ModelAnimation>): ObjectAnimator

Constructs and returns an ObjectAnimator for a targeted ModelAnimation of this object.

open fun animate(animationNames: Array<String>): ObjectAnimator

Constructs and returns an ObjectAnimator for targeted ModelAnimation with a given name of this object.

applyAnimationChange

open fun applyAnimationChange(animation: ModelAnimation): Boolean

Occurs when a ModelAnimation has received any property changed.

open fun destroy()

Detach and destroy the instance

open fun getAnimation(animationIndex: Int): ModelAnimation

Get the associated ModelAnimation at the given index or throw an IndexOutOfBoundsException.

open fun getAnimation(name: String): ModelAnimation

Get the associated ModelAnimation by name or null if none exist with the given name.

getAnimationCount

open fun getAnimationCount(): Int

Returns the number of ModelAnimation definitions in the model.

getAnimationIndex

open fun getAnimationIndex(name: String): Int

Get the Zero-based index for the animation name of interest or -1 if not found.

getAnimationName

open fun getAnimationName(animationIndex: Int): String

Get the name of the ModelAnimation at the Zero-based index This name corresponds to the one defined and exported in the renderable asset.

getAnimationNames

open fun getAnimationNames(): List<String>

Get the names of the ModelAnimation This names correspond to the ones defined and exported in the renderable asset.

getAnimationOrThrow

open fun getAnimationOrThrow(name: String): ModelAnimation

Get the associated ModelAnimation by name or throw an Exception if none exist with the given name.

getChildEntities

open fun getChildEntities(): Array<Int>

getMaterialInstance

open fun getMaterialInstance(): MaterialInstance

Returns the material bound to the first submesh.

open fun getMaterialInstance(index: Int): MaterialInstance

Returns the material bound to the specified index.

open fun getMaterialInstance(name: String): MaterialInstance

Returns the material bound to the specified name.

getMaterialName

open fun getMaterialName(index: Int): String

Returns the name associated with the specified index.

getMaterialsCount

open fun getMaterialsCount(): Int

Returns the number of materials.

getRelativeTransform

open fun getRelativeTransform(): Matrix

Returns the transform of this renderable relative to it's node.

getRelativeTransformInverse

open fun getRelativeTransformInverse(): Matrix

Returns the inverse transform of this renderable relative to it's node.

getRenderedEntity

open fun getRenderedEntity(): Int

getWorldModelMatrix

open fun getWorldModelMatrix(): Matrix

open fun hasAnimations(): Boolean

Return true if getAnimationCount>0

onModelAnimationChanged

open fun onModelAnimationChanged(animation: ModelAnimation)

Called form the ModelAnimation when it dirty state changed.

open fun prepareForDraw(engine: Engine)

setAnimationsFramePosition

open fun setAnimationsFramePosition(framePosition: Int)

Sets the current position of (seeks) all the animations to the specified frame number according to the getFrameRate This method will apply rotation, translation, and scale to the Renderable that have been targeted.

setAnimationsTimePosition

open fun setAnimationsTimePosition(timePosition: Float)

Sets the current position of (seeks) the animation to the specified time position in seconds.

setBlendOrderAt

open fun setBlendOrderAt(index: Int, blendOrder: Int)

open fun setCulling(isCulling: Boolean)

### Changes whether or not frustum culling is on The view frustum is the region of space in the modeled world that may appear on the screen.

open fun setMaterial(@IntRange(from = 0) primitiveIndex: Int, material: Material)

Sets the material bound to the specified index.

open fun setMaterial(entityIndex: Int, @IntRange(from = 0) primitiveIndex: Int, material: Material)

Sets the material bound to the specified index and entityIndex

setMaterialInstance

open fun setMaterialInstance(materialInstance: MaterialInstance)

Sets the material bound to the first index.

open fun setMaterialInstance(@IntRange(from = 0) primitiveIndex: Int, materialInstance: MaterialInstance)

Sets the material bound to the specified index.

open fun setMaterialInstance(entityIndex: Int, @IntRange(from = 0) primitiveIndex: Int, materialInstance: MaterialInstance)

Sets the material bound to the specified index and entityIndex

open fun setModelMatrix(transformManager: TransformManager, @Size(min = 16) transform: Array<Float>)

setSkinningModifier

open fun setSkinningModifier(@Nullable skinningModifier: RenderableInstance.SkinningModifier)

updateAnimations

open fun updateAnimations(force: Boolean): Boolean

Apply animations changes if fore==true or the animation has dirty values.