Struct Patch 

pub struct Patch {
    pub topology: Topology,
    pub layouts: Vec<Layout>,
}

All fixture data of a project: the topology and the layouts derived from it.

Fields

topology: Topology

layouts: Vec<Layout>

Implementations

impl Patch

pub fn addressing(&self, collections: &Collections) -> Addressing

The addresses of every fixture and the universes they fill.

impl Patch

pub fn color_orders(&self, collections: &Collections) -> ColorOrders

The wire order of every addressed pixel that is not RGB. It belongs to the DMX slot, not to what the slot samples, so layouts and modes do not change it.

impl Patch

pub fn layout(&self, layout: LayoutRef) -> Option<&Layout>

pub fn layout_mut(&mut self, layout: LayoutRef) -> Option<&mut Layout>

pub fn fixture(&self, id: FixtureId) -> Option<&Fixture>

pub fn fixture_name(&self, id: FixtureId) -> String

The fixture’s name, or its id where the topology does not hold it.

pub fn layout_refs(&self) -> Vec<LayoutRef>

Every layout, the topology first, in stack order.

pub fn add_layout(&mut self) -> usize

pub fn duplicate_layout(&mut self, index: usize) -> Option<usize>

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

pub fn add_fixture( &mut self, fixture: Fixture, position: LayoutPosition, ) -> FixtureId

Adds a fixture to the topology, and therefore to the default layout.

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

pub fn add_member(&mut self, layout: LayoutRef, id: FixtureId)

Adds id to a user layout at its default-layout position, so a new layout starts out as a copy of the physical arrangement.

pub fn set_member(&mut self, layout: LayoutRef, id: FixtureId, member: bool)

Includes or excludes a fixture. Membership of the default layout cannot be changed — it holds every fixture by construction.

pub fn definition( &self, id: FixtureId, collections: &Collections, ) -> Option<Arc<Asset<FixtureDefinition>>>

The definition asset a fixture uses, if it has one and it is loaded. There is no built-in fallback — definitions live in the asset dir.

pub fn addresses( &self, collections: &Collections, ) -> BTreeMap<FixtureId, ArtnetDMXAddress>

The address of every fixture, derived by walking each chain from its port. A fixture never straddles a universe boundary; it starts the next universe instead.

A fixture whose definition is missing has an unknown channel width, so it and everything after it in its chain get no address at all rather than a wrong one. The same goes for a fixture past MAX_UNIVERSE: Art-Net cannot address its universe; and for a fixture wider than a universe (a malformed definition), which fits nowhere without straddling a boundary and leaves the channels after it unknown.

pub fn lowest_free_universe( &self, collections: &Collections, placing: Option<FixtureId>, ) -> u16

A universe for a chain that is about to need one: the lowest no other chain reaches. Starting it inside a universe an existing chain has already spilled into would overlap them.

pub fn fixture_mode( &self, layout: LayoutRef, mode: usize, id: FixtureId, collections: &Collections, ) -> Option<usize>

Which mode of its own definition id uses in mode of layout. Unassigned fixtures fall back to their definition’s default mode. None when the fixture has no definition to take a mode from.

pub fn set_fixture_mode( &mut self, layout: LayoutRef, mode: usize, id: FixtureId, value: usize, )

Trait Implementations

impl Clone for Patch

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 Patch

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

Formats the value using the given formatter.

impl Default for Patch

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Patch

where Patch: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Patch

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Patch

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 Patch