cybsdk.IVirtDevice.IVirtDevice Class Reference

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

Inheritance diagram for cybsdk.IVirtDevice.IVirtDevice:

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

Detailed Description

Main interface all Virtualizer Devices have to implement.

Main interface all Virtualizer Devices have to implement. 

Member Function Documentation

Open()

bool cybsdk.IVirtDevice.IVirtDevice.Open

(

self

)

Opens the connection to the Virtualizer device.

Remarks

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

Returns

true if the connection was successfully opened, otherwise false.

Opens the connection to the Virtualizer device. 

Reimplemented in cybsdk._VirtDevice.VirtDevice.

IsOpen()

bool cybsdk.IVirtDevice.IVirtDevice.IsOpen

(

self

)

Checks if the connection was opened before.

Checks if the connection was opened before. 

Reimplemented in cybsdk._VirtDevice.VirtDevice.

Close()

bool cybsdk.IVirtDevice.IVirtDevice.Close

(

self

)

Closes the connection to the Virtualizer device.

Closes the connection to the Virtualizer device. 

Reimplemented in cybsdk._VirtDevice.VirtDevice.

GetDeviceInfo()

VirtDeviceInfo cybsdk.IVirtDevice.IVirtDevice.GetDeviceInfo

(

self

)

Returns the USB infos of this device.

Returns the USB infos of this device. 

Reimplemented in cybsdk._VirtDevice.VirtDevice.

GetPlayerHeight()

float cybsdk.IVirtDevice.IVirtDevice.GetPlayerHeight

(

self

)

Returns the current player height relative to the default height.

Remarks

The default height is set by the ResetPlayerHeight method.

height < -threshold: crouching

height > threshold: jumping

Returns

1.00f = 1cm.

Returns the current player height relative to the default height. 

Reimplemented in cybsdk._VirtDevice.VirtDevice.

ResetPlayerHeight()

def cybsdk.IVirtDevice.IVirtDevice.ResetPlayerHeight

(

self

)

Assigns the current height to the default height.

Remarks

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

Assigns the current height to the default height. 

Reimplemented in cybsdk._VirtDevice.VirtDevice.

GetPlayerOrientation()

float cybsdk.IVirtDevice.IVirtDevice.GetPlayerOrientation

(

self

)

Returns the orientation of the player as an absolute value.

Remarks

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

Returns

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

Returns the orientation of the player as an absolute value. 

Reimplemented in cybsdk._VirtDevice.VirtDevice.

ResetPlayerOrientation()

def cybsdk.IVirtDevice.IVirtDevice.ResetPlayerOrientation

(

self

)

Assigns the current orientation to the default vector.

Remarks

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.

Assigns the current orientation to the default vector. 

Reimplemented in cybsdk._VirtDevice.VirtDevice.

GetMovementSpeed()

float cybsdk.IVirtDevice.IVirtDevice.GetMovementSpeed

(

self

)

Returns the current movement speed in meters per second.

Returns

1.00f = 1m/s

Returns the current movement speed in meters per second. 

Reimplemented in cybsdk._VirtDevice.VirtDevice.

GetMovementDirection()

float cybsdk.IVirtDevice.IVirtDevice.GetMovementDirection

(

self

)

Returns the movement direction relative to the current player orientation.

Remarks

The origin is the GetPlayerOrientation method and increases clockwise.

Returns

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

Returns the movement direction relative to the current player orientation. 

Reimplemented in cybsdk._VirtDevice.VirtDevice.

HasHaptic()

bool cybsdk.IVirtDevice.IVirtDevice.HasHaptic

(

self

)

Checks if the Virtualizer device supports haptic feedback.

Checks if the Virtualizer device supports haptic feedback. 

Reimplemented in cybsdk._VirtDevice.VirtDevice.

HapticPlay()

def cybsdk.IVirtDevice.IVirtDevice.HapticPlay

(

self

)

Play a signal on the haptic unit.

Play a signal on the haptic unit.  

Reimplemented in cybsdk._VirtDevice.VirtDevice.

HapticStop()

def cybsdk.IVirtDevice.IVirtDevice.HapticStop

(

self

)

Stop the haptic unit.

Stop the haptic unit.  

Reimplemented in cybsdk._VirtDevice.VirtDevice.

HapticSetGain()

def cybsdk.IVirtDevice.IVirtDevice.HapticSetGain	(		self,
		int	gain
	)

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

Parameters

gain	The value can be 0, 1, 2 or 3. Set the gain (dB) level of the haptic unit.

Reimplemented in cybsdk._VirtDevice.VirtDevice.

HapticSetFrequency()

def cybsdk.IVirtDevice.IVirtDevice.HapticSetFrequency	(		self,
		int	frequency
	)

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

Parameters

frequency

The value is valid between 0Hz and 80Hz. Set the frequency (Hz) of a sine wave on the haptic unit.

Reimplemented in cybsdk._VirtDevice.VirtDevice.

HapticSetVolume()

def cybsdk.IVirtDevice.IVirtDevice.HapticSetVolume	(		self,
		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). Sets the haptic feedback (change of amplitude) in the baseplate.

Reimplemented in cybsdk._VirtDevice.VirtDevice.

---

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

• IVirtDevice.py