tuioxide 0.3.1

A Rust implementation of the TUIO 1.1 and TUIO 2.0 protocols, providing both client and server components for sending and receiving multitouch and tangible object data over OSC.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

use crate::tuio11::{Blob, Cursor, Object};

/// A collection of TUIO 1.1 events produced by processing a single OSC bundle.
///
/// Each field contains the events of the corresponding entity type that occurred
/// in the frame: cursors, objects, and blobs.
/// Fields will be empty if no events of that type
/// occurred in the frame.
#[derive(Debug, Default)]
pub struct TuioEvents {
    /// Events for TUIO 1.1 cursor entities (`/tuio/2Dcur`).
    ///
    /// Each [`CursorEvent`] is either an [`Add`](CursorEvent::Add),
    /// [`Update`](CursorEvent::Update), or [`Remove`](CursorEvent::Remove).
    pub cursor_events: Vec<CursorEvent>,

    /// Events for TUIO 1.1 object entities (`/tuio/2Dobj`).
    ///
    /// Each [`ObjectEvent`] is either an [`Add`](ObjectEvent::Add),
    /// [`Update`](ObjectEvent::Update), or [`Remove`](ObjectEvent::Remove).
    pub object_events: Vec<ObjectEvent>,

    /// Events for TUIO 1.1 blob entities (`/tuio/2Dblb`).
    ///
    /// Each [`BlobEvent`] is either an [`Add`](BlobEvent::Add),
    /// [`Update`](BlobEvent::Update), or [`Remove`](BlobEvent::Remove).
    pub blob_events: Vec<BlobEvent>,
}

/// An event emitted when a TUIO 1.1 cursor (fingertip / touch point) changes state.
///
/// Cursors are tracked via the `/tuio/2Dcur` OSC address and represent individual
/// touch contacts on a surface.
#[derive(Debug)]
pub enum CursorEvent {
    /// A new cursor has appeared and been added to the active session.
    Add(Cursor),
    /// An existing cursor has moved or changed its motion properties.
    Update(Cursor),
    /// A cursor is no longer active and has been removed from the session.
    Remove(Cursor),
}

/// An event emitted when a TUIO 1.1 object (tagged tangible) changes state.
///
/// Objects are tracked via the `/tuio/2Dobj` OSC address and represent physical
/// objects with a known class ID placed on a surface.
#[derive(Debug)]
pub enum ObjectEvent {
    /// A new object has appeared and been added to the active session.
    Add(Object),
    /// An existing object has moved, rotated, or changed its motion properties.
    Update(Object),
    /// An object is no longer active and has been removed from the session.
    Remove(Object),
}

/// An event emitted when a TUIO 1.1 blob (unidentified contact region) changes state.
///
/// Blobs are tracked via the `/tuio/2Dblb` OSC address and represent amorphous
/// contact areas on a surface that carry size and area information in addition to
/// position and rotation.
#[derive(Debug)]
pub enum BlobEvent {
    /// A new blob has appeared and been added to the active session.
    Add(Blob),
    /// An existing blob has moved, resized, or changed its motion properties.
    Update(Blob),
    /// A blob is no longer active and has been removed from the session.
    Remove(Blob),
}