Visometry.VisionLib.SDK.Core.RuntimeParameter Class Reference

The RuntimeParameter can be used to set tracking parameters at runtime. More...

Inherits Visometry.VisionLib.SDK.Core.TrackingManagerReference.

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 class	ParameterType { String = 0 , Int , Float , Bool }

Public Member Functions
void	SetValue (bool value)
	Set tracking attribute to given value. More...
void	SetValue (float value)
	Set tracking attribute to given value. More...
void	SetValue (int value)
	Set tracking parameter to given value. More...
void	SetValue (string value)
	Set tracking parameter 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 Visometry.VisionLib.SDK.Core.TrackingManagerReference
virtual bool	InitWorkerReference ()
	Initializes the trackingManager and Worker member variables. More...
virtual void	ResetReference ()
Properties inherited from Visometry.VisionLib.SDK.Core.TrackingManagerReference
TrackingManager	trackingManager [get]
	Reference to used TrackingManager. More...
Worker	worker [get]

Detailed Description

The RuntimeParameter can be used to set tracking parameters at runtime.

You can use the VLRuntimeParameters 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.

Member Function Documentation

SetValue() [1/4]

void Visometry.VisionLib.SDK.Core.RuntimeParameter.SetValue ( bool  value )

inline

Set tracking attribute to given value.

The name of the attribute can be specified with the parameterName member variable.

SetValue() [2/4]

void Visometry.VisionLib.SDK.Core.RuntimeParameter.SetValue ( float  value )

inline

Set tracking attribute to given value.

The name of the attribute can be specified with the parameterName member variable.

SetValue() [3/4]

void Visometry.VisionLib.SDK.Core.RuntimeParameter.SetValue ( int  value )

inline

Set tracking parameter to given value.

The name of the attribute can be specified with the parameterName member variable.

SetValue() [4/4]

void Visometry.VisionLib.SDK.Core.RuntimeParameter.SetValue ( string  value )

inline

Set tracking parameter to given value.

The name of the attribute can be specified with the parameterName member variable.

Field Documentation

boolValueChangedEvent

OnBoolValueChangedEvent Visometry.VisionLib.SDK.Core.RuntimeParameter.boolValueChangedEvent

Event, which will be invoked after receiving the value of a boolean parameter.

Used if parameterType is set to ParameterType.Bool.

changing

bool Visometry.VisionLib.SDK.Core.RuntimeParameter.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.

floatValueChangedEvent

OnFloatValueChangedEvent Visometry.VisionLib.SDK.Core.RuntimeParameter.floatValueChangedEvent

Event, which will be invoked after receiving the value of a floating

Used if parameterType is set to ParameterType.Float.

intValueChangedEvent

OnIntValueChangedEvent Visometry.VisionLib.SDK.Core.RuntimeParameter.intValueChangedEvent

Event, which will be invoked after receiving the value of an integer parameter.

Used if parameterType is set to ParameterType.Int.

parameterName

string Visometry.VisionLib.SDK.Core.RuntimeParameter.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

ParameterType Visometry.VisionLib.SDK.Core.RuntimeParameter.parameterType

Type of the parameter.

Right now this value can't be changed at runtime.

Only the corresponding events will get called.

stringValueChangedEvent

OnStringValueChangedEvent Visometry.VisionLib.SDK.Core.RuntimeParameter.stringValueChangedEvent

Event, which will be invoked after receiving the value of a string parameter.

Used if parameterType is set to ParameterType.String.