SpaceVIL.Common.CommonService Class Reference

CommonService is static class providing methods to getting basic information about the SpaceVIL framework, OS attributes, initializing the SpaceVIL framework and working with clipboard. More...

Static Public Member Functions
static String	GetSpaceVILInfo ()
	Getting basic information about SpaceVIL such as version, date, platform and OS. More...
static SpaceVIL.Core.OSType	GetOSType ()
	Getting the current OS type. More...
static bool	InitSpaceVILComponents ()
	Initializing the mandatory SpaceVIL common components (GLFW, default values and etc.). More...
static String	GetClipboardString ()
	Getting stored text in clipboard. More...
static void	SetClipboardString (String text)
	Placing the specified text to the clipboard. More...
static KeyCode	GetOsControlKeyRight ()
	Getting the default right "control" key KeyCode of current OS (for Mac OS - Command key) More...
static KeyCode	GetOsControlKeyLeft ()
	Getting the default left "control" key KeyCode of current OS (for Mac OS - Command key) More...
static KeyMods	GetOsControlMod ()
	Getting the default "control" modifier KeyCode of current OS (for Mac OS - Command key) More...

Detailed Description

CommonService is static class providing methods to getting basic information about the SpaceVIL framework, OS attributes, initializing the SpaceVIL framework and working with clipboard.

Member Function Documentation

GetClipboardString()

static String SpaceVIL.Common.CommonService.GetClipboardString ( )

static

Getting stored text in clipboard.

Returns

The text as System.String.

GetOsControlKeyLeft()

static KeyCode SpaceVIL.Common.CommonService.GetOsControlKeyLeft ( )

static

Getting the default left "control" key KeyCode of current OS (for Mac OS - Command key)

Returns

The keyboard key as SpaceVIL.Core.KeyCode

GetOsControlKeyRight()

static KeyCode SpaceVIL.Common.CommonService.GetOsControlKeyRight ( )

static

Getting the default right "control" key KeyCode of current OS (for Mac OS - Command key)

Returns

The keyboard key as SpaceVIL.Core.KeyCode

GetOsControlMod()

static KeyMods SpaceVIL.Common.CommonService.GetOsControlMod ( )

static

Getting the default "control" modifier KeyCode of current OS (for Mac OS - Command key)

Returns

The keyboard modifier as SpaceVIL.Core.KeyMods

GetOSType()

static SpaceVIL.Core.OSType SpaceVIL.Common.CommonService.GetOSType ( )

static

Getting the current OS type.

Returns

The OS type as SpaceVIL.Core.OSType.

GetSpaceVILInfo()

static String SpaceVIL.Common.CommonService.GetSpaceVILInfo ( )

static

Getting basic information about SpaceVIL such as version, date, platform and OS.

Returns

The information as System.String.

InitSpaceVILComponents()

static bool SpaceVIL.Common.CommonService.InitSpaceVILComponents ( )

static

Initializing the mandatory SpaceVIL common components (GLFW, default values and etc.).

Returns

True: if initialization is successful. False: if initialization is unsuccessful.

SetClipboardString()

static void SpaceVIL.Common.CommonService.SetClipboardString ( String  text )

static

Placing the specified text to the clipboard.

Parameters

text	The text as System.String.

---

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

• CommonService.cs