Skip to main content

Scene

Struct Scene 

Source
pub struct Scene {
    pub viewport_width: f32,
    pub viewport_height: f32,
    pub zoom: f32,
    pub pan_x: f32,
    pub pan_y: f32,
    /* private fields */
}
Expand description

A scene containing all canvas elements.

Fields§

§viewport_width: f32

Viewport width in pixels.

§viewport_height: f32

Viewport height in pixels.

§zoom: f32

Current zoom level (1.0 = 100%).

§pan_x: f32

Pan offset X.

§pan_y: f32

Pan offset Y.

Implementations§

Source§

impl Scene

Source

pub fn new(width: f32, height: f32) -> Self

Create a new empty scene with the given viewport size.

Source

pub fn add_element(&mut self, element: Element) -> ElementId

Add an element to the scene.

Source

pub fn remove_element(&mut self, id: &ElementId) -> CanvasResult<Element>

Remove an element from the scene.

§Errors

Returns an error if the element is not found.

Source

pub fn get_element(&self, id: ElementId) -> Option<&Element>

Get an element by ID.

Source

pub fn get_element_mut(&mut self, id: ElementId) -> Option<&mut Element>

Get a mutable reference to an element by ID.

Source

pub fn elements(&self) -> impl Iterator<Item = &Element>

Get all elements in the scene.

Source

pub fn elements_mut(&mut self) -> impl Iterator<Item = &mut Element>

Get mutable references to all elements in the scene.

Source

pub fn root_elements(&self) -> impl Iterator<Item = &Element>

Get root-level elements (not children of groups).

Source

pub fn set_viewport(&mut self, width: f32, height: f32)

Set the viewport dimensions.

Source

pub fn element_at(&self, x: f32, y: f32) -> Option<ElementId>

Find the element at the given canvas coordinates. Returns the ID of the topmost (highest z-index) interactive element.

Source

pub fn select(&mut self, id: ElementId) -> CanvasResult<()>

Select an element.

§Errors

Returns an error if the element is not found.

Source

pub fn deselect_all(&mut self)

Deselect all elements.

Source

pub fn selected_elements(&self) -> impl Iterator<Item = &Element>

Get currently selected elements.

Source

pub fn element_count(&self) -> usize

Get the number of elements in the scene.

Source

pub fn is_empty(&self) -> bool

Check if the scene is empty.

Source

pub fn clear(&mut self)

Clear all elements from the scene.

Source

pub fn to_json(&self) -> CanvasResult<String>

Serialize the scene to JSON.

§Errors

Returns an error if serialization fails.

Source

pub fn from_json(json: &str) -> CanvasResult<Self>

Deserialize a scene from JSON.

§Errors

Returns an error if deserialization fails.

Trait Implementations§

Source§

impl Clone for Scene

Source§

fn clone(&self) -> Scene

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Scene

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Scene

Source§

fn default() -> Scene

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Scene

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&Scene> for ViewportDocument

Source§

fn from(scene: &Scene) -> Self

Converts to this type from the input type.
Source§

impl Serialize for Scene

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Scene

§

impl RefUnwindSafe for Scene

§

impl Send for Scene

§

impl Sync for Scene

§

impl Unpin for Scene

§

impl UnwindSafe for Scene

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,