Skip to main content

Vixxy

🔺 Requires Basis

Vixxy is a user-accessible interface to toggle or trigger effects on an avatar in Basis.

This component is primarily intended to be used through the Unity inspector directly by non-programmer users.

Create a toggle​

Create a new GameObject in your avatar and add a HVR Vixxy Control component to it.

Then in the Settings category, click the "Create menu on this control" button.

warning

This documentation will skim through the configuration; some options will not be explained as they will only become useful later in the development of Vixxy.

Therefore, you do not need to touch anything else in the Settings category.

  • Leave the Address field empty.
  • Keep the Networked setting checked.

Unity_7s7gXnMNpa.png

Drag objects into the Toggle Objects category:

  • Objects placed in Enable these when active will be visible when the menu is turned ON and become invisible when the menu is turned OFF.
  • Objects placed in Disable these when active will be visible when the menu is turned OFF and become visible when the menu is turned ON.

If you want to toggle a component instead of the object itself, drag the object into the Toggle Objects category, and then choose the desired component in the dropdown.

Unity_b2PeSbJZYG.png

Use more than two choices​

If you want more than two choices, open the Settings category and click the "+ Add choice" button.

After adding choices, you should give each choice a description. This description will be displayed in the menu.

b.png

Toggles will be displayed differently when there are more than two choices. Tick or untick the checkboxes to affect the state of each object depending on the choice.

c.png

You may change the type of menu through the component created earlier when you clicked the "Create menu on this control" button, in the HVR Vixxy Menu Item component.

There are three different types of controls achievable:

  • A toggle between two choices (OFF/ON).
  • A dropdown selection between three choices or more.
  • A slider, which can be used between any number of choices.

Unity_xyQLLDm8mo.png

These controls are accessible in-app through "Settings > Avatar Customization":

Unity_GWuNR4ZCCz.png

Change Properties​

If you need to change the value of blendshapes or change the values inside shaders, open the Change Properties category.

d.png

Create the first object group​

In the Properties category, click + to create a group.

Drag the objects to change into that group.

Search for properties​

In the components that will show up below, click one of Properties, Materials, BlendShapes to start looking for properties to affect.

A search field will appear at the top. Type a few letters corresponding to the property you're looking for, and press the "Add" button to add it.

When done, press the _ button at the top right to minimize the search.

You can then edit the property.

Available functions​

The following is possible as of the current version:

  • ✅ Toggle GameObjects and many Component types ON/OFF (using the Toggle Objects section previously explained).
  • ✅ Change the value of blendshapes.
  • ✅ Change float values in material properties.
  • ✅ Change color values in material properties.
  • ✅ Change texture slots in material properties.
  • ✅ Change the text string of a TextMeshPro / TextMeshProUGUI / Text component, with float number formatting.

The following is not yet available as of the current version.

  • ❌ Cannot change material slot in a Renderer.
  • ❌ Cannot change any other property.
  • ❌ Cannot translate, scale, or rotate objects.

Multiple object groups​

If you need to change the properties of different objects in a different way, press + to create another group.

Display a number inside TextMeshPro​

The text inside TextMeshPro components and Text components can be modified. Here are some examples to get you started:

You can display absolute values using {0}, {0:0}, or {0:0.00}.

For a value of 93.1234:

  • Heart rate: {0} shows Heart rate: 93.1234
  • Heart rate: {0:0} shows Heart rate: 93
  • Heart rate: {0:0.0} shows Heart rate: 93.1
  • Heart rate: {0:0.00} shows Heart rate: 93.12

If your values use 0.0 to represent 0% and 1.0 to represent 100%, they can be displayed as a percentage using {1}, {1:0}, or {1:0.00}. You do not need to display the percent sign if you wish not to.

For a value of 0.123456:

  • Power: {1}% shows Power: 12.3456%
  • Power: {1:0}% shows Power: 12%
  • Power: {1:0.0}% shows Power: 12.3%
  • Power: {1:0.00}% shows Power: 12.34%

Unity_pOt5W729BJ.png

A period . will always be displayed for the decimal separator, even if the computer OS language is set to French.

Additional settings​

Networking​

When the Networked option is checked, the state of this object will be made visible to other users.

The Advanced Networking dropdown currenlty has no effect.