Struct Study 

pub struct Study {
    pub id: String,
    pub name: String,
    pub duration: f64,
    pub fps: u32,
    pub motors: Vec<Motor>,
    pub clips: Vec<Clip>,
    pub interference: Interference,
    pub motion: Option<Value>,
}

Fields

id: String

name: String

duration: f64

Seconds.

fps: u32

Frames per second: playback, scrubbing and every output use these frames.

motors: Vec<Motor>

clips: Vec<Clip>

interference: Interference

motion: Option<Value>

The published motion (the baked frames of moving occurrences), for a manufacturing-instructions step to attach. Written by the workbench.

Implementations

impl Study

pub fn new(id: &str, name: &str) -> Self

pub fn frame_count(&self) -> usize

Frames from 0 to the duration inclusive.

pub fn frame_time(&self, index: usize) -> f64

The time of frame index, seconds.

pub fn frame_at(&self, time: f64) -> usize

The frame nearest time.

pub fn motor(&self, id: &str) -> Option<&Motor>

pub fn clip(&self, id: &str) -> Option<&Clip>

pub fn validate(&self) -> Result<(), String>

A study the sampler and every output can run: a sane duration and rate, spans inside the study, motors on distinct mates where they overlap, and clips that name what they act on.

impl Study

pub fn sample( &self, time: f64, base: &dyn Fn(&str) -> Option<f64>, ) -> FrameSample

The study at time. base gives a mate’s document value (by constraint id), which a speed motor starts from; a mate it does not know starts at 0.

Trait Implementations

impl Clone for Study

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 Study

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Study

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Study

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Study

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 Study