CybSDK.IVirtDevice Interface Reference

Main interface all Virtualizer Devices have to implement. More...

Inheritance diagram for CybSDK.IVirtDevice:

Public Member Functions
bool	Open ()
	Opens the connection to the Virtualizer device. More...
bool	IsOpen ()
	Checks if the connection was opened before. More...
bool	Close ()
	Closes the connection to the Virtualizer device. More...
VirtDeviceInfo	GetDeviceInfo ()
	Returns the USB infos of this device. More...
float	GetPlayerHeight ()
	Returns the current player height relative to the default height. More...
void	ResetPlayerHeight ()
	Assigns the current height to the default height. More...
float	GetPlayerOrientation ()
	Returns the orientation of the player as an absolute value. More...
void	ResetPlayerOrientation ()
	Assigns the current orientation to the default vector. More...
float	GetMovementSpeed ()
	Returns the current movement speed in meters per second. More...
float	GetMovementDirection ()
	Returns the movement direction relative to the current player orientation. More...
bool	HasHaptic ()
	Checks if the Virtualizer device supports haptic feedback. More...
void	HapticPlay ()
	Play a signal on the haptic unit. More...
void	HapticStop ()
	Stop the haptic unit. More...
void	HapticSetGain (int gain)
	Set the gain (dB) level of the haptic unit. More...
void	HapticSetFrequency (int frequency)
	Set the frequency (Hz) of a sine wave on the haptic unit. More...
void	HapticSetVolume (int volume)
	Sets the haptic feedback (change of amplitude) in the baseplate. More...

Detailed Description

Main interface all Virtualizer Devices have to implement.

Member Function Documentation

Open()

bool CybSDK.IVirtDevice.Open

(

)

Opens the connection to the Virtualizer device.

No other application can open this device at the same time.

Returns

true if the connection was successfully opened, otherwise false.

Implements CybSDK.CVirtDevice.

IsOpen()

bool CybSDK.IVirtDevice.IsOpen

(

)

Checks if the connection was opened before.

Implements CybSDK.CVirtDevice.

Close()

bool CybSDK.IVirtDevice.Close

(

)

Closes the connection to the Virtualizer device.

Implements CybSDK.CVirtDevice.

GetDeviceInfo()

VirtDeviceInfo CybSDK.IVirtDevice.GetDeviceInfo

(

)

Returns the USB infos of this device.

GetPlayerHeight()

float CybSDK.IVirtDevice.GetPlayerHeight

(

)

Returns the current player height relative to the default height.

The default height is set by the ResetPlayerHeight method.

height < -threshold: crouching

height > threshold: jumping

Returns

1.00f = 1cm.

Implements CybSDK.CVirtDevice.

ResetPlayerHeight()

void CybSDK.IVirtDevice.ResetPlayerHeight

(

)

Assigns the current height to the default height.

This method should be called while the player is asked to stand upright.

Implements CybSDK.CVirtDevice.

GetPlayerOrientation()

float CybSDK.IVirtDevice.GetPlayerOrientation

(

)

Returns the orientation of the player as an absolute value.

The origin is set by the ResetPlayerOrientation method and increases clockwise.

Returns

logical: 0.00f to 1.00f (= physical: 0° to 360°).

Implements CybSDK.CVirtDevice.

ResetPlayerOrientation()

void CybSDK.IVirtDevice.ResetPlayerOrientation

(

)

Assigns the current orientation to the default vector.

This method should be called while the player is asked to look forward.

This orientation should be used to calibrate the HMD.

Deprecated:

Unused as new Virtualizers orient themselves automatically.

Implements CybSDK.CVirtDevice.

GetMovementSpeed()

float CybSDK.IVirtDevice.GetMovementSpeed

(

)

Returns the current movement speed in meters per second.

Returns

1.00f = 1m/s

Implements CybSDK.CVirtDevice.

GetMovementDirection()

float CybSDK.IVirtDevice.GetMovementDirection

(

)

Returns the movement direction relative to the current player orientation.

The origin is the GetPlayerOrientation method and increases clockwise.

Returns

logical: -1.00f to 1.00f (= physical: -180° to 180°).

Implements CybSDK.CVirtDevice.

HasHaptic()

bool CybSDK.IVirtDevice.HasHaptic

(

)

Checks if the Virtualizer device supports haptic feedback.

Implements CybSDK.CVirtDevice.

HapticPlay()

void CybSDK.IVirtDevice.HapticPlay

(

)

Play a signal on the haptic unit.

Implements CybSDK.CVirtDevice.

HapticStop()

void CybSDK.IVirtDevice.HapticStop

(

)

Stop the haptic unit.

Implements CybSDK.CVirtDevice.

HapticSetGain()

void CybSDK.IVirtDevice.HapticSetGain

(

int

gain

)

Set the gain (dB) level of the haptic unit.

Parameters

gain	The value can be 0, 1, 2 or 3.

Implements CybSDK.CVirtDevice.

HapticSetFrequency()

void CybSDK.IVirtDevice.HapticSetFrequency

(

int

frequency

)

Set the frequency (Hz) of a sine wave on the haptic unit.

Parameters

frequency

The value is valid between 0Hz and 80Hz.

Implements CybSDK.CVirtDevice.

HapticSetVolume()

void CybSDK.IVirtDevice.HapticSetVolume

(

int

volume

)

Sets the haptic feedback (change of amplitude) in the baseplate.

Parameters

volume

The value is valid between 0 (no feedback) and 100 (full feedback).

Implements CybSDK.CVirtDevice.

---

The documentation for this interface was generated from the following file:

• IVirtDevice.cs