Struct Layout 

pub struct Layout {
    pub name: String,
    pub background: Option<PathBuf>,
    pub members: BTreeMap<FixtureId, LayoutPosition>,
    pub modes: Vec<LayoutMode>,
}

A subset of all fixtures in a user definable 2d arrangement.

Layouts may overlap freely. The topology’s default layout is a Layout too, and is the one that necessarily contains every fixture.

Fields

name: String

background: Option<PathBuf>

members: BTreeMap<FixtureId, LayoutPosition>

modes: Vec<LayoutMode>

modes[0] is the default mode and is never removed.

Implementations

impl Layout

pub const DEFAULT_NAME: &'static str = "Default"

What the layout every fixture belongs to is called. Every collection in patching has a default element, so nothing has to be learned to use one.

pub fn new(name: impl Into<String>) -> Self

pub fn contains(&self, id: FixtureId) -> bool

pub fn mode(&self, index: usize) -> &LayoutMode

The mode at index, falling back to the default mode.

pub fn mode_mut(&mut self, index: usize) -> &mut LayoutMode

pub fn add_mode(&mut self) -> usize

Adds a mode with a name not yet used in this layout.

pub fn remove_mode(&mut self, index: usize)

Removes a mode. The default mode cannot be removed.

pub fn forget(&mut self, id: FixtureId)

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.

impl Default for Layout

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Layout

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Layout

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Layout

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Layout