documentation
The VLRuntimeParameterBehaviour can be used to set tracking parameters at runtime. More...
Inherits VLWorkerReferenceBehaviour.
Data Structures | |
| class | OnBoolValueChangedEvent |
| Event with the value of a boolean parameter. More... | |
| class | OnFloatValueChangedEvent |
| Event with the value of a floating point parameter. More... | |
| class | OnIntValueChangedEvent |
| Event with the value of an integer parameter. More... | |
| class | OnStringValueChangedEvent |
| Event with the value of a string parameter. More... | |
Public Types | |
| enum | ParameterType { String = 0, Int, Float, Bool } |
Public Member Functions | |
| void | SetValue (string value) |
| Set tracking parameter to given value. More... | |
| void | SetValue (int value) |
| Set tracking parameter to given value. More... | |
| void | SetValue (float value) |
| Set tracking attribute to given value. More... | |
| void | SetValue (bool value) |
| Set tracking attribute to given value. More... | |
Data Fields | |
| OnBoolValueChangedEvent | boolValueChangedEvent |
| Event, which will be invoked after receiving the value of a boolean parameter. More... | |
| bool | changing |
| Whether the parameter might be changed by the internal tracking pipeline at runtime. More... | |
| OnFloatValueChangedEvent | floatValueChangedEvent |
| Event, which will be invoked after receiving the value of a floating More... | |
| OnIntValueChangedEvent | intValueChangedEvent |
| Event, which will be invoked after receiving the value of an integer parameter. More... | |
| string | parameterName |
| Name of the tracking parameter. More... | |
| ParameterType | parameterType |
| Type of the parameter. More... | |
| OnStringValueChangedEvent | stringValueChangedEvent |
| Event, which will be invoked after receiving the value of a string parameter. More... | |
Additional Inherited Members | |
 Protected Member Functions inherited from VLWorkerReferenceBehaviour | |
| bool | InitWorkerReference () |
| Initializes the workerBehaviour and Worker member variables. More... | |
| Protected Attributes inherited from VLWorkerReferenceBehaviour | |
| VLWorker | worker |
| VLWorkerBehaviour | workerBehaviour |
| Reference to used VLWorkerBehaviour. More... | |
The VLRuntimeParameterBehaviour can be used to set tracking parameters at runtime.
You can use the VLRuntimeParameters_ModelTracker_v1 prefab to create GameObjects with the available parameters attached to them.
The SetValue functions and the events (stringValueChangedEvent, intValueChangedEvent, floatValueChangedEvent, boolValueChangedEvent) can be used to modify parameters using Unity GUI elements.
|
inline |
Set tracking parameter to given value.
The name of the attribute can be specified with the parameterName member variable.
|
inline |
Set tracking parameter to given value.
The name of the attribute can be specified with the parameterName member variable.
|
inline |
Set tracking attribute to given value.
The name of the attribute can be specified with the parameterName member variable.
|
inline |
Set tracking attribute to given value.
The name of the attribute can be specified with the parameterName member variable.
| OnBoolValueChangedEvent VLRuntimeParameterBehaviour.boolValueChangedEvent |
Event, which will be invoked after receiving the value of a boolean parameter.
Used if parameterType is set to ParameterType.Bool.
| bool VLRuntimeParameterBehaviour.changing |
Whether the parameter might be changed by the internal tracking pipeline at runtime.
If a parameter is changing, we will always check for changed values and emit events for it. This check will be skipped for parameters which are constant and events will only be emitted after the initialization.
| OnFloatValueChangedEvent VLRuntimeParameterBehaviour.floatValueChangedEvent |
Event, which will be invoked after receiving the value of a floating
Used if parameterType is set to ParameterType.Float.
| OnIntValueChangedEvent VLRuntimeParameterBehaviour.intValueChangedEvent |
Event, which will be invoked after receiving the value of an integer parameter.
Used if parameterType is set to ParameterType.Int.
| string VLRuntimeParameterBehaviour.parameterName |
Name of the tracking parameter.
Right now this value can't be changed at runtime.
The available parameter names depend on the tracking method.
| ParameterType VLRuntimeParameterBehaviour.parameterType |
Type of the parameter.
Right now this value can't be changed at runtime.
Only the corresponding events will get called.
| OnStringValueChangedEvent VLRuntimeParameterBehaviour.stringValueChangedEvent |
Event, which will be invoked after receiving the value of a string parameter.
Used if parameterType is set to ParameterType.String.