Struct carnelian::scene::scene::SceneBuilder

pub struct SceneBuilder { /* private fields */ }

Fluent builder for scenes.

Implementations

impl SceneBuilder

pub fn new() -> Self

Create a new fluent builder for building Scenes.

pub fn round_scene_corners(self, round: bool) -> Self

True if, when running without Scenic, if the scene should round the corners of the screen to match the presentation that sometimes occurs with Scenic.

pub fn enable_mouse_cursor(self, enable: bool) -> Self

If true, when running without Scenic, the mouse cursor should be drawn.

pub fn background_color(self, background_color: Color) -> Self

Set the color to use for the background of a scene.

pub fn mutable(self, mutable: bool) -> Self

If true, the scene can be mutated after being built.

pub fn animated(self, animated: bool) -> Self

If true, the scene should be rendered on every frame.

pub fn rectangle(&mut self, size: Size, color: Color) -> FacetId

Add a rectangle facet of size and color to the scene.

pub fn rounded_rectangle( &mut self, size: Size, corner: Coord, color: Color ) -> FacetId

Add a rounded rectangle facet of size, corner radius and color to the scene.

pub fn space(&mut self, size: Size) -> FacetId

Add a spacing facet of size.

pub fn h_line( &mut self, width: Coord, thickness: Coord, color: Color, location: Option<Point> ) -> FacetId

Add a horizontal line to the scene.

pub fn h_line_with_data( &mut self, width: Coord, thickness: Coord, color: Color, location: Option<Point>, member_data: Option<GroupMemberData> ) -> FacetId

Add a horizontal line to the scene with member data

pub fn v_line( &mut self, height: Coord, thickness: Coord, color: Color, location: Option<Point> ) -> FacetId

Add a vertical line to the scene.

pub fn v_line_with_data( &mut self, height: Coord, thickness: Coord, color: Color, location: Option<Point>, member_data: Option<GroupMemberData> ) -> FacetId

Add a vertical line to the scene with member data.

pub fn text( &mut self, face: FontFace, text: &str, size: f32, location: Point, options: TextFacetOptions ) -> FacetId

Add a text facet to the scene.

pub fn text_with_data( &mut self, face: FontFace, text: &str, size: f32, location: Point, options: TextFacetOptions, member_data: Option<GroupMemberData> ) -> FacetId

Add a text facet to the scene along with some data for the group arranger.

pub fn facet_with_data( &mut self, facet: FacetPtr, member_data: Option<GroupMemberData> ) -> FacetId

Add an object that implements the Facet trait to the scene, along with some data for the group arranger.

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

Add an object that implements the Facet trait to the scene.

pub fn facet_at_location(&mut self, facet: FacetPtr, location: Point) -> FacetId

Add an object that implements the Facet trait to the scene and set its location.

pub fn start_group_with_member_data( &mut self, label: &str, arranger: ArrangerPtr, member_data: Option<GroupMemberData> )

Start a facet group with member data. Any facets added to the scene or

pub fn start_group(&mut self, label: &str, arranger: ArrangerPtr)

Start a facet group. Any facets added to the scene or groups started will become

pub fn end_group(&mut self) -> GroupId

End the current group, returning its group ID.

pub fn group(&mut self) -> GroupBuilder<'_>

Create a group builder.

pub fn build(self) -> Scene

Consume this builder and build the scene.