ControllerSettingsConfig Class

Use this component on a gameobject under the App object's hierarchy to configure the default settings for controllers

Inheritance Hierarchy

SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDK.ConfigConfigComponent
            ImmerseSDK.ConfigControllerSettingsConfig

Namespace: ImmerseSDK.Config
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)

Syntax

public class ControllerSettingsConfig : ConfigComponent, 
	IControllerSettingsConfig, IConfigProperty

The ControllerSettingsConfig type exposes the following members.

Constructors

	Name	Description
	ControllerSettingsConfig	Initializes a new instance of the ControllerSettingsConfig class

Properties

	Name	Description
	AutoPointDistance	Distance (in meters) to use instead as minimum for going into auto-point state if there are engageable as well as interactable objects around
	CursorSize	Size of the cursor on Dialogs and other UI elements
	HapticFeedbackDurationSeconds	How long in seconds the haptic feedback will last
	HapticFeedbackOnDrop	Enable/Disable haptic Feedback when objects are dropped
	HapticFeedbackOnPickUp	Enable/Disable haptic Feedback when objects are pickedUp
	HapticFeedbackOnSnap	Enable/Disable haptic Feedback when the object can be snapped
	HighlightColor	Alternate color to use for EngageObject highlight
	HighlightCornerOutlines	Draw corners for the EngageObject highlight
	HighlightFillAmount	Fill Amount for the EngageObject highlight
	HighlightLineIntensity	Intensity for the EngageObject highlight
	HighlightLineThickness	Thinkness for the EngageObject highlight
	MinTriggerValueForHandUi	Minimum amount of trigger press before HandUI will not be displayed
	RadiusOfEffectForEngage	Distance (in meters) for the radius of object detection, measured from the interaction point on the controller
	ShouldHighlightEngageObject	True to enable highlighting the object that will be engaged when you press the trigger, otherwise false
	UseAvatarColorForHighlight	True to use the avatar color for the EngageObject highlight, otherwise use ColorForForHighlight property

Fields

	Name	Description
	_autoPointDistance	Distance (in meters) to use instead as minimum for going into auto-point state if there are engageable as well as interactable objects around
	_cursorSize	Size of the cursor on Dialogs and other UI elements
	_hapticFeedbackDurationSeconds	How long in seconds the haptic feedback will last
	_hapticFeedbackOnDrop	Enable/Disable haptic Feedback when objects are dropped
	_hapticFeedbackOnPickUp	Enable/Disable haptic Feedback when objects are pickedUp
	_hapticFeedbackOnSnap	Enable/Disable haptic Feedback when the object can be snapped
	_highlightColor	Alternate color to use for EngageObject highlight
	_highlightCornerOutlines	Draw corners for the EngageObject highlight
	_highlightFillAmount	Fill Amount for the EngageObject highlight
	_highlightLineIntensity	Intensity for the EngageObject highlight
	_highlightLineThickness	Thinkness for the EngageObject highlight
	_minTriggerValueForHandUi	Minimum amount of trigger press before HandUI will not be displayed
	_radiusOfEffectForEngage	Distance (in meters) for the radius of object detection, measured from the interaction point on the controller
	_shouldHighlightEngageObject	True to enable highlighting the object that will be engaged when you press the trigger, otherwise false
	_useAvatarColorForHighlight	True to use the avatar color for the EngageObject highlight, otherwise use ColorForForHighlight property

Extension Methods

	Name	Description
	GetCopyOf	Copies all properties of a component from source to target. Uses reflection to set properties. (Defined by ComponentExtensions.)
	WaitForT	Waits for a singleton on a coroutine (Defined by SingletonManager.)