OpenSpace3D 3D HUD API

Functions
	VUIsplitThemeRef (themeref)
	Split a theme reference between definition name and element name.
	VUIdestroyContainer (contstr)
	Destroy a 3D container.
	VUIcreate3dContainer (sessionstr, groupstr, pos, offset, contsize, scale, autoscale, maxautoscaledist, autotarget, opacity, ontop)
	Create a 3D container for VR.
	VUIcreateVrContainer (sessionstr, groupstr, offset, contsize, scale, opacity, ontop, zorder)
	Create a 3D container for VR.
	VUIcreateVrKeyboard (sessionstr, groupstr, scale, opacity)
	Create a 3D keyboard for VR.
	VUIshowVrKeyboard (keybstr, mode)
	Show a 3D keyboard for VR.
	VUIhideVrKeyboard (keybstr)
	Hide a 3D keyboard for VR.
	VUIdestroyVrKeyboard (keybstr)
	Destroy a 3D keyboard for VR.
	VUIcreateContainerGroup (themestr)
	create a container group
	VUIgetThemerefPrefix (ref)
	search base theme ref with "_"
	VUIgetThemePath (basename)
	get theme path from theme name
	VUIreloadElementThemeResource (eltstr, themestr)
	reload theme resources on an element
	VUIreloadThemeResources ()
	reload theme resources
	VUIsetGroupTheme (groupstr, file)
	change the current theme
	VUIsetTheme (file)
	change the current theme

Detailed Description

OpenSpace3D 3D HUD API

Function Documentation

VUIsplitThemeRef()

VUIsplitThemeRef

(

themeref

)

Split a theme reference between definition name and element name.

Prototype: fun [S] [S S]

Parameters

S	: the theme reference

Returns

[S S] : the definition name and element name

VUIdestroyContainer()

VUIdestroyContainer

(

contstr

)

Destroy a 3D container.

Prototype: fun [VUIcontainer] I

Parameters

VUIcontainer

: the 3d container

Returns

I : return 0

VUIcreate3dContainer()

VUIcreate3dContainer	(	sessionstr	,
		groupstr	,
		pos	,
		offset	,
		contsize	,
		scale	,
		autoscale	,
		maxautoscaledist	,
		autotarget	,
		opacity	,
		ontop
	)

Create a 3D container for VR.

Prototype: fun [V3Dsession [F F] [F F] [I I] F I I I I I] VUIcontainer

Parameters

V3Dsession

: the 3d scene structure

Returns

VUIcontainer : the new 3D container

VUIcreateVrContainer()

VUIcreateVrContainer	(	sessionstr	,
		groupstr	,
		offset	,
		contsize	,
		scale	,
		opacity	,
		ontop	,
		zorder
	)

Create a 3D container for VR.

Prototype: fun [V3Dsession [F F] [I I] F I I I] VUIcontainer

Parameters

V3Dsession

: the 3d scene structure

Returns

VUIcontainer : the new 3D container

VUIcreateVrKeyboard()

VUIcreateVrKeyboard	(	sessionstr	,
		groupstr	,
		scale	,
		opacity
	)

Create a 3D keyboard for VR.

Prototype: fun [V3Dsession F I] VUIkeyboard

Parameters

V3Dsession

: the 3d scene structure

Returns

VUIkeyboard : the new 3D keyboard

VUIshowVrKeyboard()

VUIshowVrKeyboard	(	keybstr	,
		mode
	)

Show a 3D keyboard for VR.

Prototype: fun [VUIkeyboard I] VUIkeyboard

Parameters

VUIkeyboard	: the virtual keyboard
I	: keyboard mode 0 default, 1 text, 2 numeric

Returns

VUIkeyboard : the 3D keyboard

VUIhideVrKeyboard()

VUIhideVrKeyboard

(

keybstr

)

Hide a 3D keyboard for VR.

Prototype: fun [VUIkeyboard] VUIkeyboard

Parameters

VUIkeyboard

: the virtual keyboard

Returns

VUIkeyboard : the 3D keyboard

VUIdestroyVrKeyboard()

VUIdestroyVrKeyboard

(

keybstr

)

Destroy a 3D keyboard for VR.

Prototype: fun [VUIkeyboard] I

Parameters

VUIkeyboard

: the virtual keyboard

Returns

I : 0

VUIcreateContainerGroup()

VUIcreateContainerGroup

(

themestr

)

create a container group

Prototype: fun [VUItheme] VUIcontainerGroup

Parameters

VUItheme

: the theme

Returns

VUIcontainerGroup : the new container group

VUIgetThemerefPrefix()

VUIgetThemerefPrefix

(

ref

)

search base theme ref with "_"

Prototype: fun [S] S

Parameters

S	: the theme reference

Returns

S : the base theme reference

VUIgetThemePath()

VUIgetThemePath

(

basename

)

get theme path from theme name

Prototype: fun [S] S

Parameters

S	: the theme name

Returns

S : the theme path

VUIreloadElementThemeResource()

VUIreloadElementThemeResource	(	eltstr	,
		themestr
	)

reload theme resources on an element

Prototype: fun [VUIelement] I

Parameters

VUIelement

: the element structure

Returns

I : 0

VUIreloadThemeResources()

VUIreloadThemeResources

(

)

reload theme resources

Prototype: fun [] I

Returns

I : 0

VUIsetGroupTheme()

VUIsetGroupTheme	(	groupstr	,
		file
	)

change the current theme

Prototype: fun [S] I

Parameters

S	: the theme file path

Returns

I : 0

VUIsetTheme()

VUIsetTheme

(

file

)

change the current theme

Prototype: fun [S] I

Parameters

S	: the theme file path

Returns

I : 0