Struct Props

pub struct Props {
    pub graph: Graph,
    pub node_props: HashMap<NodeId, NodeProps>,
    pub time: f32,
    pub dt: f32,
}

Props contains nodes (such as effects, movies, and images) and connectivity information (which nodes feed into which other nodes) that describe an overall visual composition.

Each node has properties, accessed via node_props, describing that node’s behavior.

This Props object is a descriptor: It does not contain any render state or graphics resources. One use case of a Props is passing it to Context.paint for rendering. Another is serializing it out to disk, or deserializing it from a server.

Fields

graph: Graph

The list of node IDs and how they connect

node_props: HashMap<NodeId, NodeProps>

Properties of each node, independent of connectivity

time: f32

Time, in beats. Wraps around at 64 beats.

dt: f32

Time between successive calls to update(), in beats

Implementations

impl Props

pub fn fix(&mut self)

Ensure that props is well-formed, and if it isn’t, make it. Specifically, make sure that the list of nodes in node_props and graph match, and that there are no edges to non-existent nodes.

Trait Implementations

impl Clone for Props

fn clone(&self) -> Props

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Props

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

Formats the value using the given formatter.

impl Default for Props

fn default() -> Props

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Props

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Props

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

where __S: Serializer,

Serialize this value into the given Serde serializer.