Class JoyVisualizerSettings
ScriptableObject that maps JoyMsg axes and buttons to named gamepad controls and renders a graphical joystick display in the HUD.
Inherited Members
Namespace: Global Namespace
Assembly: Unity.SimulationPro.Foundation.Visualizations.dll
Syntax
[CreateAssetMenu(fileName = "JoyVisualizerSettings", menuName = "Robotics/Sensor Visualizers/Joy", order = 1)]
public class JoyVisualizerSettings : ScriptableObject
Fields
m_Button_Back
Joystick input mapped to the back/select button.
Declaration
public JoyVisualizerSettings.JoyInputType m_Button_Back
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_Button_East
Joystick input mapped to the east (right) face button.
Declaration
public JoyVisualizerSettings.JoyInputType m_Button_East
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_Button_North
Joystick input mapped to the north (top) face button.
Declaration
public JoyVisualizerSettings.JoyInputType m_Button_North
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_Button_Power
Joystick input mapped to the power/home button.
Declaration
public JoyVisualizerSettings.JoyInputType m_Button_Power
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_Button_South
Joystick input mapped to the south (bottom) face button.
Declaration
public JoyVisualizerSettings.JoyInputType m_Button_South
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_Button_Start
Joystick input mapped to the start/menu button.
Declaration
public JoyVisualizerSettings.JoyInputType m_Button_Start
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_Button_West
Joystick input mapped to the west (left) face button.
Declaration
public JoyVisualizerSettings.JoyInputType m_Button_West
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_DPad_Down
Joystick input mapped to the D-pad down direction.
Declaration
public JoyVisualizerSettings.JoyInputType m_DPad_Down
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_DPad_Left
Joystick input mapped to the D-pad left direction.
Declaration
public JoyVisualizerSettings.JoyInputType m_DPad_Left
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_DPad_Right
Joystick input mapped to the D-pad right direction.
Declaration
public JoyVisualizerSettings.JoyInputType m_DPad_Right
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_DPad_Up
Joystick input mapped to the D-pad up direction.
Declaration
public JoyVisualizerSettings.JoyInputType m_DPad_Up
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_DPad_XAxis
Joystick input for the D-pad horizontal axis (used when the D-pad reports analog values).
Declaration
public JoyVisualizerSettings.JoyInputType m_DPad_XAxis
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_DPad_YAxis
Joystick input for the D-pad vertical axis (used when the D-pad reports analog values).
Declaration
public JoyVisualizerSettings.JoyInputType m_DPad_YAxis
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_LShoulder
Joystick input for the left shoulder button (L1/LB).
Declaration
public JoyVisualizerSettings.JoyInputType m_LShoulder
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_LStick_Click
Joystick input for the left stick click (L3).
Declaration
public JoyVisualizerSettings.JoyInputType m_LStick_Click
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_LStick_X
Joystick input for the left stick horizontal axis.
Declaration
public JoyVisualizerSettings.JoyInputType m_LStick_X
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_LStick_Y
Joystick input for the left stick vertical axis.
Declaration
public JoyVisualizerSettings.JoyInputType m_LStick_Y
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_LTrigger
Joystick input for the left trigger (L2/LT).
Declaration
public JoyVisualizerSettings.JoyInputType m_LTrigger
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_RShoulder
Joystick input for the right shoulder button (R1/RB).
Declaration
public JoyVisualizerSettings.JoyInputType m_RShoulder
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_RStick_Click
Joystick input for the right stick click (R3).
Declaration
public JoyVisualizerSettings.JoyInputType m_RStick_Click
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_RStick_X
Joystick input for the right stick horizontal axis.
Declaration
public JoyVisualizerSettings.JoyInputType m_RStick_X
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_RStick_Y
Joystick input for the right stick vertical axis.
Declaration
public JoyVisualizerSettings.JoyInputType m_RStick_Y
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
m_RTrigger
Joystick input for the right trigger (R2/RT).
Declaration
public JoyVisualizerSettings.JoyInputType m_RTrigger
Field Value
| Type | Description |
|---|---|
| JoyVisualizerSettings.JoyInputType |
Methods
ButtonTexture(bool)
Returns a cached texture representing a pressed or unpressed button state.
Declaration
public Texture2D ButtonTexture(bool pressed)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | pressed | Whether the button is currently pressed. |
Returns
| Type | Description |
|---|---|
| Texture2D | A red-filled texture when pressed, or a transparent texture when unpressed. |
CreateGUI(JoyMsg, MessageMetadata)
Creates a GUI action that renders the joystick display for the given message using the configured button and axis mappings.
Declaration
public Action CreateGUI(JoyMsg message, MessageMetadata meta)
Parameters
| Type | Name | Description |
|---|---|---|
| JoyMsg | message | The message data to visualize. |
| MessageMetadata | meta | Metadata about the received message. |
Returns
| Type | Description |
|---|---|
| Action | An Action that draws the joystick HUD when invoked inside an |
GetInputAxisOrButtons(JoyMsg, JoyInputType, JoyInputType, JoyInputType)
Returns the current float value of an axis or the difference between two buttons, preferring the axis when it is not None.
Declaration
public float GetInputAxisOrButtons(JoyMsg message, JoyVisualizerSettings.JoyInputType axis, JoyVisualizerSettings.JoyInputType upButton, JoyVisualizerSettings.JoyInputType downButton)
Parameters
| Type | Name | Description |
|---|---|---|
| JoyMsg | message | The message data to visualize. |
| JoyVisualizerSettings.JoyInputType | axis | The axis to use, or None to fall back to buttons. |
| JoyVisualizerSettings.JoyInputType | upButton | The button treated as the positive direction when |
| JoyVisualizerSettings.JoyInputType | downButton | The button treated as the negative direction when |
Returns
| Type | Description |
|---|---|
| float | The axis value, or the difference between the up and down button values. |
GetInputBool(JoyMsg, JoyInputType)
Returns whether the specified input is currently active (non-zero).
Declaration
public bool GetInputBool(JoyMsg message, JoyVisualizerSettings.JoyInputType inputType)
Parameters
| Type | Name | Description |
|---|---|---|
| JoyMsg | message | The message data to visualize. |
| JoyVisualizerSettings.JoyInputType | inputType | The axis or button to read. |
Returns
| Type | Description |
|---|---|
| bool |
|
GetInputFloat(JoyMsg, JoyInputType)
Returns the current float value of the specified input, reading from the axes array for axis inputs and converting button values to 0 or 1.
Declaration
public float GetInputFloat(JoyMsg message, JoyVisualizerSettings.JoyInputType inputType)
Parameters
| Type | Name | Description |
|---|---|---|
| JoyMsg | message | The message data to visualize. |
| JoyVisualizerSettings.JoyInputType | inputType | The axis or button to read. |
Returns
| Type | Description |
|---|---|
| float | The axis value, or 0 or 1 for buttons. Returns 0 if the index is out of range. |
StickTexture(float, float, bool)
Creates a texture showing a joystick dot at the position corresponding to the given axis values, optionally with a blue pressed-state background.
Declaration
public Texture2D StickTexture(float xAxis, float yAxis, bool clicked)
Parameters
| Type | Name | Description |
|---|---|---|
| float | xAxis | The X axis value in the range [-1, 1]. |
| float | yAxis | The Y axis value in the range [-1, 1]. |
| bool | clicked | Whether the stick click button is currently pressed. |
Returns
| Type | Description |
|---|---|
| Texture2D | A newly created Texture2D showing the stick position. |
TriggerTexture(float)
Creates a texture representing a trigger position bar with a highlighted band at the position corresponding to fraction.
Declaration
public Texture2D TriggerTexture(float fraction)
Parameters
| Type | Name | Description |
|---|---|---|
| float | fraction | The trigger position in the range [0, 1]. |
Returns
| Type | Description |
|---|---|
| Texture2D | A newly created Texture2D showing the trigger position. |