Data Structures
class	AnimEvent

class	SoundEvent

class	vobject

class	PacketInputAdapter

class	Material

class	Link< Class T >

Typedefs
typedef int[]	vobject

Functions
class vobject	WriteBool (bool value)

proto native IEntitySource	ToEntitySource ()

proto native void	WriteInt (int value)

proto native void	WriteFloat (float value)

proto native void	WriteString (string value)

proto native void	WriteVector (vector value)

proto native void	WriteMatrixAsQuaternionVector (vector mat[4])

proto native void	WriteIntAsByte (int value)

proto native void	WriteIntAsUByte (int value)

proto native void	WriteIntAsHalf (int value)

proto native void	WriteIntAsUHalf (int value)

proto native void	WriteFloatAsByte (float value, float min, float max)

proto native void	WriteFloatAsHalf (float value, float min, float max)

proto native void	MakeScreenshot (string name)

proto native int	GetFPS ()

SkyDome API
proto native int	LoadSkyPresets (string presetsFile)

proto native int	InitSky (string presetName)

proto native int	SetSkyPreset (string presetName, float stormy, float dayTime)

proto native int	LerpSkyPreset (string presetName1, string presetName2, float dayTime, float stormy1, float stormy2, float lerpVal)

proto native int	LerpSkyPreset3 (string presetName1, string presetName2, string presetName3, float dayTime, float stormy1, float stormy2, float stormy3, float w1, float w2, float w3)

proto native void	SetSkyUserPlanets (bool enabled)

proto native bool	SetSkyPlanet (int index, float azimuthDeg, float zenithDeg)

proto native bool	SetSkyPlanetSize (int index, float angleDeg)

proto native void	SetStarsObserverTime (int year, int month, int day, int hour, int minute, float sec, int offsetSec)

proto native void	SetStarsObserverPosition (float latitudeDeg, float longitudeDeg)

proto native void	SetRealStarAutoUpdate (bool update)

proto native void	SetNightLayerRotMatrix (vector mat[3])

proto native void	SetStarsRotMatrix (vector mat[3])

Variables
class PacketInputAdapter	WriteBool

Materials API
typedef int[]	Material

int	VectortoRGBA (vector vec, float h)

int	ARGB (int a, int r, int g, int b)

int	ARGBF (float fa, float fr, float fg, float fb)
	Converts <0.0, 1.0> ARGB into color. More...

int	AWHITE (int a)

int	LerpARGB (int c1, int c2)

Typedef Documentation

◆ Material

typedef int [] Material

Definition at line 265 of file proto.c.

◆ vobject

typedef int [] vobject

Definition at line 46 of file proto.c.

Function Documentation

◆ ARGB()

int ARGB	(	int	a,
		int	r,
		int	g,
		int	b
	)

Definition at line 322 of file proto.c.

◆ ARGBF()

int ARGBF	(	float	fa,
		float	fr,
		float	fg,
		float	fb
	)

Converts <0.0, 1.0> ARGB into color.

Definition at line 332 of file proto.c.

◆ AWHITE()

int AWHITE ( int a )

Definition at line 338 of file proto.c.

◆ GetFPS()

proto native int GetFPS ( )

Returns actual fps (average in last 10 frames)

◆ InitSky()

proto native int InitSky ( string presetName )

initialize sky with preset, must be called to set the global planets setting

Parameters

presetName name of preset to be set (one of presets from file loaded using LoadSkyPresets)

◆ LerpARGB()

int LerpARGB	(	int	c1,
		int	c2
	)

Definition at line 344 of file proto.c.

◆ LerpSkyPreset()

proto native int LerpSkyPreset	(	string	presetName1,
		string	presetName2,
		float	dayTime,
		float	stormy1,
		float	stormy2,
		float	lerpVal
	)

lerp two sky presets and set the result using day time

Parameters

presetName1	name of preset1 to be set (one of presets from file loaded using LoadSkyPresets)
presetName2	name of preset2 to be set (one of presets from file loaded using LoadSkyPresets)
dayTime	day of time <0, 1>
stormy1	stormy parameter for preset1 <0, 1>
stormy2	stormy parameter for preset2 <0, 1>
lerpVal	lerp value between two presets

◆ LerpSkyPreset3()

proto native int LerpSkyPreset3	(	string	presetName1,
		string	presetName2,
		string	presetName3,
		float	dayTime,
		float	stormy1,
		float	stormy2,
		float	stormy3,
		float	w1,
		float	w2,
		float	w3
	)

lerp three sky presets using barycentric coordinates and set the result using day time

Parameters

presetName1	name of preset1 to be set (one of presets from file loaded using LoadSkyPresets)
presetName2	name of preset2 to be set (one of presets from file loaded using LoadSkyPresets)
presetName2	name of preset3 to be set (one of presets from file loaded using LoadSkyPresets)
dayTime	day of time <0, 1>
stormy1	stormy parameter for preset1 <0, 1>
stormy2	stormy parameter for preset2 <0, 1>
stormy3	stormy parameter for preset3 <0, 1>
w1	weight for preset1
w2	weight for preset2
w3	weight for preset3

◆ LoadSkyPresets()

proto native int LoadSkyPresets ( string presetsFile )

load all sky presets from xml file

Parameters

presetFile name of XML file with presets

◆ MakeScreenshot()

proto native void MakeScreenshot ( string name )

makes screenshot and stores it in to a DDS format file if the name begins with '$' the screenshot in stored in the fullpath according to the name parameter otherwise the screenshot is stored in "$profile:ScreenShotes/DATE TIME-NAME.dds" where DATE, TIME AND NAME are replaced by actual values

Parameters

name	name of the screenshot

◆ SetNightLayerRotMatrix()

proto native void SetNightLayerRotMatrix ( vector mat[3] )

night sky layer rotation matrix

Parameters

mat	rotation matrix

◆ SetRealStarAutoUpdate()

proto native void SetRealStarAutoUpdate ( bool update )

update of stars

Parameters

update true = automatic stars update, false = update is on user by SetStarsRotMatrix

◆ SetSkyPlanet()

proto native bool SetSkyPlanet	(	int	index,
		float	azimuthDeg,
		float	zenithDeg
	)

set planet position

Parameters

index	index of planet, 0 = sun usually
azimuthDeg	azimuth position in degrees
zenithDeg	zenith position in degrees

◆ SetSkyPlanetSize()

proto native bool SetSkyPlanetSize	(	int	index,
		float	angleDeg
	)

set planet size in degrees

Parameters

index	index of planet, 0 = sun usually
angleDeg	angle size in degrees

◆ SetSkyPreset()

proto native int SetSkyPreset	(	string	presetName,
		float	stormy,
		float	dayTime
	)

set sky preset to day time and stormy parameter

Parameters

presetName	name of preset to be set (one of presets from file loaded using LoadSkyPresets)
stormy	stormy parameter <0, 1>
dayTime	day of time <0, 1>

◆ SetSkyUserPlanets()

proto native void SetSkyUserPlanets ( bool enabled )

user can set planets to its own positions on skydome using SetSkyPresetPlanet function, if disabled, the planets are positioned automatically using sky preset setting

Parameters

enabled enable/disable

◆ SetStarsObserverPosition()

proto native void SetStarsObserverPosition	(	float	latitudeDeg,
		float	longitudeDeg
	)

set observer position

Parameters

latitudeDeg	latitude in degrees
longitudeDeg	longitude in degrees

◆ SetStarsObserverTime()

proto native void SetStarsObserverTime	(	int	year,
		int	month,
		int	day,
		int	hour,
		int	minute,
		float	sec,
		int	offsetSec
	)

set UTC time for real time stars

Parameters

year
month
day
hour
minute
sec
offsetSec	to take into account time difference between Greenwich and local time (position dependency, summer/winter time)

◆ SetStarsRotMatrix()

proto native void SetStarsRotMatrix ( vector mat[3] )

stars rotation matrix, is different from night rotation matrix because we don't know the time when night layers was captured

Parameters

mat	rotation matrix

◆ ToEntitySource()

proto native IEntitySource WriteBool::ToEntitySource ( )

◆ VectortoRGBA()

int VectortoRGBA	(	vector	vec,
		float	h
	)

Definition at line 298 of file proto.c.

◆ WriteBool()

class vobject WriteBool ( bool value )

◆ WriteFloat()

proto native void WriteFloat ( float value )

◆ WriteFloatAsByte()

proto native void WriteFloatAsByte	(	float	value,
		float	min,
		float	max
	)

◆ WriteFloatAsHalf()

proto native void WriteFloatAsHalf	(	float	value,
		float	min,
		float	max
	)

◆ WriteInt()

proto native void WriteInt ( int value )

◆ WriteIntAsByte()

proto native void WriteIntAsByte ( int value )

◆ WriteIntAsHalf()

proto native void WriteIntAsHalf ( int value )

◆ WriteIntAsUByte()

proto native void WriteIntAsUByte ( int value )

◆ WriteIntAsUHalf()

proto native void WriteIntAsUHalf ( int value )

◆ WriteMatrixAsQuaternionVector()

proto native void WriteMatrixAsQuaternionVector ( vector mat[4] )

◆ WriteString()

proto native void WriteString ( string value )

◆ WriteVector()

proto native void WriteVector ( vector value )

Variable Documentation

◆ WriteBool

class PacketInputAdapter WriteBool

Data Structures

Typedefs

Functions

Variables

Materials API

Typedef Documentation

◆ Material

◆ vobject

Function Documentation

◆ ARGB()

◆ ARGBF()

◆ AWHITE()

◆ GetFPS()

◆ InitSky()

◆ LerpARGB()

◆ LerpSkyPreset()

◆ LerpSkyPreset3()

◆ LoadSkyPresets()

◆ MakeScreenshot()

◆ SetNightLayerRotMatrix()

◆ SetRealStarAutoUpdate()

◆ SetSkyPlanet()

◆ SetSkyPlanetSize()

◆ SetSkyPreset()

◆ SetSkyUserPlanets()

◆ SetStarsObserverPosition()

◆ SetStarsObserverTime()

◆ SetStarsRotMatrix()

◆ ToEntitySource()

◆ VectortoRGBA()

◆ WriteBool()

◆ WriteFloat()

◆ WriteFloatAsByte()

◆ WriteFloatAsHalf()

◆ WriteInt()

◆ WriteIntAsByte()

◆ WriteIntAsHalf()

◆ WriteIntAsUByte()

◆ WriteIntAsUHalf()

◆ WriteMatrixAsQuaternionVector()

◆ WriteString()

◆ WriteVector()

Variable Documentation

◆ WriteBool