Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(schema): add frames and graph edge information #181

Merged
merged 5 commits into from
Oct 8, 2024

Conversation

eeberhard
Copy link
Member

@eeberhard eeberhard commented Oct 8, 2024

Description

As referenced in the original design spec, this adds two (non-breaking) enhancements to the draft schema, after which I would declare it ready to release as version 2-0-0.

Frames

Frames are quite simple to define:

frames:
  target:   # reference frame is "world" by default
    position:
      x: 0.5
      y: 0.0
      z: 1.0
    orientation:
      w: 1.0
      x: 0.0
      y: 0.0
      z: 0.0
  offset:
    reference_frame: target
    position:
      x: 0.5
      y: 0.0
      z: 1.0
    orientation:
      w: 1.0
      x: 0.0
      y: 0.0
      z: 0.0

Edges

The edge path information is stored under graph: edges: [edge_id]: path. By including the path sub-property, this leaves room for future expansion, for example to customize the position or content of an edge label. In practice it would look like this:

graph:
  positions:
    on_start:
      x: -40
      y: -20
    components:
      signal_point_attractor:
        x: 680
        y: 400
    buttons:
      button:
        x: -320
        y: 620
  buttons:
    button:
      on_click:
        set:
          parameter: linear_precision
          value: !!float 1.0
          component: signal_point_attractor
  edges:
    on_start_on_start_load_signal_point_attractor:
      path:
        - x: 360
          y: 20
        - x: 360
          y: 460
  sequence_sequence_event_trigger_0_load_signal_point_attractor:
    path:
        - x: 620
          y: 460
  button_on_click_set_parameter_signal_point_attractor:
    path:
        - x: 180
          y: 640
        - x: 180
          y: 460

Review guidelines

Estimated Time of Review: 5 minutes

Checklist before merging:

  • Confirm that the relevant changelog(s) are up-to-date in case of any user-facing changes

@eeberhard eeberhard merged commit 393dcfd into main Oct 8, 2024
@eeberhard eeberhard deleted the feat/edges-and-frames branch October 8, 2024 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants