General

Detailed Description

The functions in this group provide general information about the status of stereo output and device tracking.

List of Functions

void  ZSCore::SetStereoEnabled (bool isStereoEnabled)
  Set whether stereoscopic 3D is enabled.
bool  ZSCore::IsStereoEnabled ()
  Check whether stereoscopic 3D rendering is enabled.
void  ZSCore::SetTrackingEnabled (bool isEnabled)
  Set whether tracking is enabled.
bool  ZSCore::IsTrackingEnabled ()
  Check whether tracking is enabled.
void  ZSCore::SetEyesSwapped (bool areEyesSwapped)
  Set whether the left and right eyes are swapped.
bool  ZSCore::AreEyesSwapped ()
  Check whether the left and right eyes are swapped.
Camera  ZSCore::GetStereoCamera (CameraType cameraType)
  Get a camera from the ZSCore stereo rig based on a specified camera type.
static Matrix4x4  ZSCore::ConvertFromRightToLeft (Matrix4x4 right)
  Convert a matrix in right handed space to left handed space.
delegate void  ZSCore::CoreEventHandler (ZSCore sender)

List of Enumerations

enum   ZSCore::GlPluginEventType {
  ZSCore::RenderTargetLeft = 10000,
  ZSCore::RenderTargetRight = 10001,
  ZSCore::FrameDone = 10002,
  ZSCore::DisableStereo = 10003,
  ZSCore::InitializeLRDetect = 10004,
  ZSCore::UpdateLRDetectFullscreen = 10005,
  ZSCore::UpdateLRDetectWindowed = 10006,
  ZSCore::SyncLRDetectFullscreen = 10007,
  ZSCore::SyncLRDetectWindowed = 10008
}
enum   ZSCore::PluginError {
  ZSCore::Okay = 0,
  ZSCore::NotImplemented = 1,
  ZSCore::NotInitialized = 2,
  ZSCore::AlreadyInitialized = 3,
  ZSCore::InvalidParameter = 4,
  ZSCore::InvalidContext = 5,
  ZSCore::InvalidHandle = 6,
  ZSCore::RuntimeIncompatible = 7,
  ZSCore::RuntimeNotFound = 8,
  ZSCore::SymbolNotFound = 9,
  ZSCore::DisplayNotFound = 10,
  ZSCore::DeviceNotFound = 11,
  ZSCore::TargetNotFound = 12,
  ZSCore::CapabilityNotFound = 13,
  ZSCore::BufferTooSmall = 14
}
enum   ZSCore::CameraType {
  ZSCore::Left = 0,
  ZSCore::Right = 1,
  ZSCore::Final = 2,
  ZSCore::NumTypes
}

List of Variables

GameObject  ZSCore::CurrentCamera = null
bool  ZSCore::EnableStereo = true
bool  ZSCore::EnableTracking = true
float  ZSCore::InterPupillaryDistance = 0.06f

List of Events

CoreEventHandler  ZSCore::Updated

Function Descriptions

bool ZSCore:: AreEyesSwapped ( ) [inline]

Check whether the left and right eyes are swapped.

Returns:
True if the left and right eyes are swapped. False if not.
static Matrix4x4 ZSCore:: ConvertFromRightToLeft ( Matrix4x4  right ) [inline, static]

Convert a matrix in right handed space to left handed space.

Parameters:
right A right-handed matrix.
Returns:
A left-handed matrix.
delegate void ZSCore:: CoreEventHandler ( ZSCore  sender )

A function for handling events raised by a ZSCore object.

Camera ZSCore:: GetStereoCamera ( CameraType  cameraType ) [inline]

Get a camera from the ZSCore stereo rig based on a specified camera type.

Parameters:
cameraType The camera type: Left, Right, or Final.
Returns:
Reference to the underlying Unity camera.
bool ZSCore:: IsStereoEnabled ( ) [inline]

Check whether stereoscopic 3D rendering is enabled.

Returns:
True if stereoscopic 3D is enabled. False if not.
bool ZSCore:: IsTrackingEnabled ( ) [inline]

Check whether tracking is enabled.

Returns:
True if tracking is enabled. False if not.
void ZSCore:: SetEyesSwapped ( bool  areEyesSwapped ) [inline]

Set whether the left and right eyes are swapped.

Parameters:
areEyesSwapped True if the left and right eyes are swapped. False if not.
void ZSCore:: SetStereoEnabled ( bool  isStereoEnabled ) [inline]

Set whether stereoscopic 3D is enabled.

Parameters:
isStereoEnabled True to enable stereoscopic 3D. False if not.
void ZSCore:: SetTrackingEnabled ( bool  isEnabled ) [inline]

Set whether tracking is enabled.

Parameters:
isEnabled True if tracking is enabled. False if not.

Enumeration Descriptions

enum ZSCore::CameraType

Identifies a specific camera managed by the ZSCore stereo camera rig.

Enumerator:
Left 
Right 
Final 
NumTypes 
enum ZSCore::GlPluginEventType

Identifies rendering events defined by the native zSpace Unity plugin.

Enumerator:
RenderTargetLeft 
RenderTargetRight 
FrameDone 
DisableStereo 
InitializeLRDetect 
UpdateLRDetectFullscreen 
UpdateLRDetectWindowed 
SyncLRDetectFullscreen 
SyncLRDetectWindowed 
enum ZSCore::PluginError

Identifies an error in the native zSpace Unity plugin.

Enumerator:
Okay 
NotImplemented 
NotInitialized 
AlreadyInitialized 
InvalidParameter 
InvalidContext 
InvalidHandle 
RuntimeIncompatible 
RuntimeNotFound 
SymbolNotFound 
DisplayNotFound 
DeviceNotFound 
TargetNotFound 
CapabilityNotFound 
BufferTooSmall 

Variable Descriptions

GameObject ZSCore::CurrentCamera = null

The camera around which the stereo rig will be placed.

bool ZSCore::EnableStereo = true

Whether stereo rendering is enabled.

bool ZSCore::EnableTracking = true

Whether head and stylus tracking are enabled.

float ZSCore::InterPupillaryDistance = 0.06f

The physical separation, or inter-pupillary distance, between the eyes in meters.

Event Descriptions

CoreEventHandler ZSCore::Updated

Raised after this instance's tracking data and stereo frustum has been refreshed. Called immediately before the beginning of a Unity frame.