update osc params - Githubissues

fuwako commented 8 months ago

Description

This is a collection of changes to the OSCParams component and related components.

Fix values sent via OSC being evaluated as 0 by VRChat

Problem: Incorrectly typed data would be sent to VRChat, and parameters would not be correctly driven.

Solution: Payloads are now validated and parsed before being sent to VRChat.

I don't how this will affect other applications, if the OSC implementation is intended to be used with applications besides VRChat.

Implement editing

Editing is now implemented and enabled for param triggers.

A basic view of Custom Params.	Edit was clicked.

Additionally, the removal of assign phrases is now implemented.

A mouseover on an assign phrase.	The assign phrase was clicked and deleted.

Changed behaviors:

The Add custom param trigger dialogue will always open with default values and/or empty input fields.
- Any leftover input will be lost upon canceling or closing the dialog.
Assign phrases
- When the field "Value type" is changed, the currently existing value in the field "Value" will be validated.
- This provides default values for the field "Value" and initializes it with input.
- This handles unregulated input and resets the field "Value" to a default value if it doesn't correspond to the type.
  - This solves a problem wherein noncorresponding input would remain despite "Value type" being changed (e.g., "Value type" of "bool" and "Value" of "123").
- If the existing value is valid, it can be reused.
  - Example: an inputted number for "int" will not be reset and can be reused if the user has chosen "float".
  - Example: an inputted number for "float" will not be reset and can be parsed as an int if the user has chosen "int".
  - This makes the workflow for editing quicker and more convenient.
- The field "Value" is constantly validated on user-input.
- When the user attempts to add an assign phrase with missing input, the action will be blocked.
- When the user successfully adds an assign phrase, the fields will only be partially reset.
- Only the field "Add assign word/phrase" (i.e., keyword) will be reset.
- This allows users to quickly add multiple assign phrases with similar settings without having to reselect the "Value type" and "Value".

Standardize the design of the component title to match other components

Before	After

Fix being only able to use the last declared trigger phrase

Problem: If a param trigger has multiple trigger phrases, only the most recent/last trigger phrase could be used (e.g., in the case of "Apple", "Banana", "Orange", only "Orange" could be used).

Solution: Checks for a trigger phrase now stop as soon as a match is found instead of losing the match to an overwrite.

What is the purpose of this pull request?

[X] Bug fix
[X] New Feature
[ ] Documentation update
[X] Other

fuwako commented 7 months ago

Parameter trigger behaviors

Problem: In VRChat, a user may use a Button control in their Expression Menu to quickly send a pulse or momentary value and run Unity Animator logic. However, mimiuchi simply sets values and cannot simulate pulses.

Solution: The Behavior setting is now implemented. It has 2 options:

Default: The value is set.
Pulse: The value is set, wait some time, another value is set.

^{The new behaviors}	^{A configured assign}
^{An added assign}	^{The overview}

Profiles

Problem: mimiuchi only holds a universal set of param triggers. A VRChat user may want to change their active set of param triggers when using a different avatar or in different situations.

Solution: Profiles are now implemented. Each profile contains a collection of param triggers.

^{The overview}	^{Adding a new profile}
^{Profile selection menu}	^{Profile 1}
^{Profile 2}	^{Profile 3}
^{Profile validation (Error: Required)}	^{Profile validation (Error: Cannot be empty)}
^{Profile validation (Error: Already in use)}	^{Profile validation (Valid)}

New overview design

Problems:

It is cumbersome to reach parameter triggers when many are created.
A very long parameter route will cause the Edit and Delete buttons to be pushed out of the view.

Solutions:

Each parameter trigger is contained in an expandable panel.
The parameter route is now in a container that can be dragged if it contains excessive text.