Constructor Detail

• RiveFileController

  RiveFileController(Loop loop, Boolean autoplay, File file, Artboard activeArtboard, Function0<Unit> onStart)

Method Detail

• getRefs

   AtomicInteger getRefs()

  The number of objects referencing this controller.

  When refs 0 the object will be kept alive with its references. When refs reaches 0 it will release the file, if any.

• setRefs

   Unit setRefs(AtomicInteger refs)

  The number of objects referencing this controller.

  When refs 0 the object will be kept alive with its references. When refs reaches 0 it will release the file, if any.

• getIsActive

   final Boolean getIsActive()

  Whether this controller is active or not. If this is false, it will prevent advancing or drawing.

• setIsActive

   final Unit setIsActive(Boolean isActive)

  Whether this controller is active or not. If this is false, it will prevent advancing or drawing.

• getFit

   final Fit getFit()

• setFit

   final Unit setFit(Fit fit)

• getAlignment

   final Alignment getAlignment()

• setAlignment

   final Unit setAlignment(Alignment alignment)

• getLayoutScaleFactor

   final Float getLayoutScaleFactor()

  The scale factor to use for Fit.LAYOUT. If null, it will use a density determined by Rive (automatic). See RiveFileController.layoutScaleFactorAutomatic for more details.

• setLayoutScaleFactor

   final Unit setLayoutScaleFactor(Float layoutScaleFactor)

• getLayoutScaleFactorAutomatic

   final Float getLayoutScaleFactorAutomatic()

  The automatic scale factor set by Rive. This value will only be used if layoutScaleFactor is not set (null).

• setLayoutScaleFactorAutomatic

   final Unit setLayoutScaleFactorAutomatic(Float layoutScaleFactorAutomatic)

• getFile

   final File getFile()

• setFile

   final Unit setFile(File file)

• getActiveArtboard

   final Artboard getActiveArtboard()

• setActiveArtboard

   final Unit setActiveArtboard(Artboard activeArtboard)

• getAnimations

   final List<LinearAnimationInstance> getAnimations()

• getStateMachines

   final List<StateMachineInstance> getStateMachines()

• getPlayingAnimations

   final <ERROR CLASS><LinearAnimationInstance> getPlayingAnimations()

• getPlayingStateMachines

   final <ERROR CLASS><StateMachineInstance> getPlayingStateMachines()

• getPausedAnimations

   final Set<LinearAnimationInstance> getPausedAnimations()

• getPausedStateMachines

   final Set<StateMachineInstance> getPausedStateMachines()

• getIsAdvancing

   final Boolean getIsAdvancing()

• getArtboardBounds

   final RectF getArtboardBounds()

• getTargetBounds

   final RectF getTargetBounds()

• setTargetBounds

   final Unit setTargetBounds(RectF targetBounds)

• getListeners

   final <ERROR CLASS><RiveFileController.Listener> getListeners()

• getEventListeners

   final <ERROR CLASS><RiveFileController.RiveEventListener> getEventListeners()

• getLoop

   final Loop getLoop()

• setLoop

   final Unit setLoop(Loop loop)

• getAutoplay

   final Boolean getAutoplay()

• setAutoplay

   final Unit setAutoplay(Boolean autoplay)

• getOnStart

   final Function0<Unit> getOnStart()

• setOnStart

   final Unit setOnStart(Function0<Unit> onStart)

• getRefCount

   Integer getRefCount()

• saveControllerState

   final ControllerState saveControllerState()

  Get a copy of the state of this controller and acquire a reference to the file to prevent it being released from memory.

  Returns a ControllerState object with everything the controller was using. If the controller is pointing to stale data, it will return null.

• restoreControllerState

   final Unit restoreControllerState(ControllerState state)

  Restore a copy of the state to this Controller.

  It also release()s any resources currently associated with this Controller in favor of the ones stored on the state.

• advance

  @WorkerThread() final Unit advance(Float elapsed)

  Note: This is happening in the render thread: this function is synchronized with a ReentrantLock stored on the File because this is a critical section with the UI thread. When advancing or performing operations around an animations data structure, be conscious of thread safety.

• setRiveFile

   final Unit setRiveFile(File file, String artboardName)

  Assigns the file to this Controller and instances the artboard provided via artboardName. If none is provided, it instantiates the first (i.e. default) artboard. If this controller is set to autoplay it will also start playing.

• selectArtboard

   final Unit selectArtboard(String name)

  Instances the artboard with the specified name. If none is provided, it instantiates the first (i.e. default) artboard. If this controller is set to autoplay it will also start playing.

• autoplay

   final Unit autoplay()

• play

   final Unit play(List<String> animationNames, Loop loop, Direction direction, Boolean areStateMachines, Boolean settleInitialState)

• play

   final Unit play(String animationName, Loop loop, Direction direction, Boolean isStateMachine, Boolean settleInitialState)

• play

   final Unit play(Loop loop, Direction direction, Boolean settleInitialState)

  Restarts paused animations if there are any. Otherwise, it starts playing the first animation (timeline or state machine) in the Artboard.

• pause

   final Unit pause()

• pause

   final Unit pause(List<String> animationNames, Boolean areStateMachines)

• pause

   final Unit pause(String animationName, Boolean isStateMachine)

• stopAnimations

   final Unit stopAnimations()

  Named stopAnimations to avoid conflicting with stop.

• stopAnimations

   final Unit stopAnimations(List<String> animationNames, Boolean areStateMachines)

• stopAnimations

   final Unit stopAnimations(String animationName, Boolean isStateMachine)

• fireState

   final Unit fireState(String stateMachineName, String inputName, String path)

• setBooleanState

   final Unit setBooleanState(String stateMachineName, String inputName, Boolean value, String path)

• setNumberState

   final Unit setNumberState(String stateMachineName, String inputName, Float value, String path)

• fireStateAtPath

   final Unit fireStateAtPath(String inputName, String path)

• setBooleanStateAtPath

   final Unit setBooleanStateAtPath(String inputName, Boolean value, String path)

• setNumberStateAtPath

   final Unit setNumberStateAtPath(String inputName, Float value, String path)

• getTextRunValue

   final String getTextRunValue(String textRunName)

  Get the current value for a text run named textRunName on the active artboard if it exists.

• getTextRunValue

   final String getTextRunValue(String textRunName, String path)

  Get the text value for a text run named textRunName on the nested artboard represented at path.

• setTextRunValue

   final Unit setTextRunValue(String textRunName, String textValue)

  Set the text value for a text run named textRunName to textValue on the active artboard.

• setTextRunValue

   final Unit setTextRunValue(String textRunName, String textValue, String path)

  Set the text value for a text run named textRunName to textValue on the nested artboard represented at path.

• getVolume

   final Float getVolume()

  Get the active Artboard's volume.

• setVolume

   final Unit setVolume(Float value)

  Set the active Artboard's volume to value.

• pointerEvent

   final Unit pointerEvent(PointerEvents eventType, Float x, Float y)

• registerListener

   Unit registerListener(RiveFileController.Listener listener)

• unregisterListener

   Unit unregisterListener(RiveFileController.Listener listener)

• addEventListener

   final Unit addEventListener(RiveFileController.RiveEventListener listener)

  Adds a RiveEventListener to get notified on RiveEvents.

  Remove with: removeEventListener.

• removeEventListener

   final Unit removeEventListener(RiveFileController.RiveEventListener listener)

  Removes the listener.

• release

   Integer release()

  Release a reference associated with this Controller. If refs == 0, then give up all resources and release the file.