Struct carnelian::scene::scene::Scene

pub struct Scene { /* private fields */ }

A Carnelian scene is responsible for turning a collection of facets and groups into rendered pixels.

Implementations

impl Scene

pub fn round_scene_corners(&mut self, round_scene_corners: bool)

Set the option to round scene corners.

pub fn add_facet(&mut self, facet: FacetPtr) -> FacetId

Add a facet to the scene, returning its ID.

pub fn remove_facet(&mut self, facet_id: FacetId) -> Result<(), Error>

Remove a particular facet from the scene.

pub fn move_facet_forward(&mut self, facet_id: FacetId) -> Result<(), Error>

Move a facet forward in the facet order list.

pub fn move_facet_backward(&mut self, facet_id: FacetId) -> Result<(), Error>

Move a facet backwards in the facet order list.

pub fn new_group(&mut self) -> GroupId

Create a new group.

pub fn add_facet_to_group( &mut self, facet_id: FacetId, group_id: GroupId, member_data: Option<GroupMemberData> )

Add a facet to a group, removing it from any group it might already belong to.

pub fn remove_facet_from_group(&mut self, facet_id: FacetId, group_id: GroupId)

Remove a facet from a group.

pub fn set_group_arranger(&mut self, group_id: GroupId, arranger: ArrangerPtr)

Set the arranger for a group. No change in facet position will occur until layout is called.

pub fn render( &mut self, render_context: &mut RenderContext, ready_event: Event, context: &ViewAssistantContext ) -> Result<(), Error>

Render the scene. Expected to be called from the view assistant’s render method.

pub fn send_message(&mut self, target: &FacetId, msg: Box<dyn Any>)

Send a message to a facet.

pub fn set_facet_location(&mut self, target: &FacetId, location: Point)

Set the absolute position of a facet.

pub fn set_facet_size(&mut self, target: &FacetId, size: Size)

Set the size of a facet.

pub fn get_facet_location(&self, target: &FacetId) -> Point

Get the absolute position of a facet.

pub fn get_facet_size(&self, target: &FacetId) -> Size

Get the size of a facet.

pub fn get_facet_bounds(&self, target: &FacetId) -> Rect

Get a rectangle created from the absolute position and size of a facet.

pub fn layout(&mut self, target_size: Size)

Run the layout process, positioning groups and facets.

pub fn all_facet_bounds(&self) -> Vec<Rect>

Return the bounds of all facets.

Trait Implementations

impl Debug for Scene

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.