Struct carnelian::scene::facets::RiveFacet

pub struct RiveFacet { /* private fields */ }

A facet constructed with the contents of a Rive animation file.

Implementations

impl RiveFacet

pub fn new(size: Size, artboard: Object<Artboard>) -> Self

Create a Rive facet with the contents of a Rive file.

pub fn new_from_file( size: Size, file: &File, artboard_name: Option<&str> ) -> Result<Self, Error>

Given an already loaded Rive file, create a new Rive facet with the given named artboard, or the first if artboard_name is None.

pub fn new_from_path<P: AsRef<Path> + Debug>( size: Size, path: P, artboard_name: Option<&str> ) -> Result<Self, Error>

Given a path to a file, load the file and create a new Rive facet with the given named artboard, or the first if artboard_name is None.

Trait Implementations

impl Facet for RiveFacet

fn update_layers( &mut self, _size: Size, layer_group: &mut dyn LayerGroup, render_context: &mut RenderContext, _view_context: &ViewAssistantContext ) -> Result<(), Error>

Called by the scene on facets when it is time for them to update their contents. Facets can add, remove or change layers in the layer group. Those layers will be combined with all the other facet layers in the scene and added to a render composition for display.

fn calculate_size(&self, _available: Size) -> Size

Should return the current size needed by this facet.

fn handle_message(&mut self, msg: Box<dyn Any>)

Method for receiving arbitrary message, like SetColorMessage or SetTextMessage.

fn associate_facet_id(&mut self, facet_id: FacetId)

Optional method for facets that wish to send themselves messages using an AppSender that they were passed during creation.