gsCore.h File Reference

Classes
class	gsProperty
class	gsUserDefs
class	gsMultiTouchState
class	gsTouch
class	gsTouch::gsTouchListener
class	gsMouse
class	gsJoystick
class	gsKeyboard
class	gsEngine
class	gsObject
class	gsHUD
class	gsHUDElement
class	gsStaticBatch
class	gsScene
class	gsGameObjectInstance
class	gsContactInfo
class	gsGameObject
class	gsMessageListenerCallback
class	gsMessageManager
class	gsCurve
class	gsLight
class	gsCamera
class	gsEntity
class	gsSkeleton
class	gsParticles
class	gsDebugger
class	gsRecastDebugger
class	gsSubMesh
class	gsMesh
class	gsTween
class	gsProcedural
class	gsLuaStream

Namespaces
	Ogre

Typedefs
typedef OIS::MultiTouchState	gkMultiTouchState

Enumerations
enum	TweenTransition {   TWT_LINEAR, TWT_SINE, TWT_QUINT, TWT_QUART,   TWT_QUAD, TWT_EXPO, TWT_ELASTIC, TWT_CUBIC,   TWT_CIRC, TWT_BOUNCE, TWT_BACK }
enum	TweenEq { TWE_EASE_IN, TWE_EASE_OUT, TWE_EASE_IN_OUT }
enum	gsRenderSystem {   GS_RS_GL, GS_RS_GLES, GS_RS_D3D9, GS_RS_D3D10,   GS_RS_D3D11 }
enum	gsShaderProgrammType { ST_VERTEX, ST_FRAGMENT }
enum	gsPropertyType { PROP_NULL, PROP_BOOL, PROP_NUMBER, PROP_STRING }
enum	gsTransformSpace { TS_LOCAL, TS_PARENT, TS_WORLD }
enum	gsGameObjectTypes {   OBT_UNKNOWN = 0, OBT_CAMERA, OBT_LIGHT, OBT_ENTITY,   OBT_EMPTY, OBT_SKELETON, OBT_CURVE }
enum	gsLightType { LI_POINT, LI_SPOT, LI_DIR }
enum	gsEngineEvents { EVT_TICK }
enum	gsMouseButton { LEFT = 0, RIGHT, MIDDLE }
enum	gsTouchType {   MT_None = 0, MT_Pressed, MT_Released, MT_Moved,   MT_Cancelled }
enum	gsCompositorOp { COP_ADD = 0, COP_DEL, COP_REPLACE, COP_RESET }
enum	gsSceneUpdateFlags {   UPDATE_NONE = 0, UPDATE_PHYSICS = 1 << 0, UPDATE_LOGIC_BRICKS = 1 << 1, UPDATE_NODE_TREES = 1 << 2,   UPDATE_ANIMATIONS = 1 << 3, UPDATE_SOUNDS = 1 << 4, UPDATE_DBVT = 1 << 5, UPDATE_DEBUG = 1 << 6,   UPDATE_ALL = 0xFFFFFFFF }
enum	gsCompressionLevel { COMPRESSION_BEST = 9, COMPRESSION_FAST = 1, COMPRESSION_NO = 0 }

Functions
int	getNumJoysticks (void)
gkHUD *	getHUD (const gkString &name)
gkScene *	getActiveScene (void)
gkScene *	getScene (const gkString &sceneName, const gkString &groupName="")
gkScene *	addScene (const gkString &sceneName, int zorder)
gkScene *	addScene (gsScene *scene, int zorder)
gkGameObjectInstance *	createGroupInstance (const gkString &name, gsVector3 loc=gsVector3(0, 0, 0), gsVector3 orientation=gsVector3(0, 0, 0), gsVector3 scale=gsVector3(1, 1, 1), const gkString &resGroup="")
	createGroupInstance More...
gkGameObjectInstance *	createGroupInstance (gsScene *scene, const gkString &name, gsVector3 loc=gsVector3(0, 0, 0), gsVector3 orientation=gsVector3(0, 0, 0), gsVector3 scale=gsVector3(1, 1, 1), const gkString &resGroup="")
gkGameObjectInstance *	createGroupInstance (gkScene *scene, const gkString &name, gsVector3 loc=gsVector3(0, 0, 0), gsVector3 orientation=gsVector3(0, 0, 0), gsVector3 scale=gsVector3(1, 1, 1), const gkString &resGroup="")
gkGameObjectInstance *	createGroupInstance (gsScene *scene, const gkString &name, const gkString &resGroup)
void	updateStaticBatch (gkString groupName="", gsScene *scene=0)
bool	groupExists (gkString name)
int	getGroupCount (gsScene *gsscene=0)
gkString	getGroupNameAt (int i, gsScene *gsscene=0)
void	destroyResourceGroup (const gkString &resGrpName)
void	addResourceLocation (const gkString &group, const gkString &type, const gkString &path, bool recursive=false)
void	loadResource (const gkString &group, const gkString &path)
void	loadBlend (const gkString &name, const gkString &sceneName="", const gkString &groupName="", bool ignoreLibraries=true)
void	unloadBlendFile (const gkString &name)
void	unloadAllBlendFiles ()
void	downloadFile (const gkString &name, const gkString &to, const gkString &postData="", bool overwrite=true, bool checkPeerCA=false, bool checkPeerHostname=false)
gkString	downloadToString (bool blocking, const gkString &url, const gkString &postData="", bool checkPeerCA=false, bool checkPeerHostname=false)
void	nbDownload ()
void	nbPoll ()
void	nbSetCallback (gsSelf self, gsFunction func)
void	nbSetCallback (gsFunction func)
bool	nbIsRunning ()
void	sendMessage (const gkString &from, const gkString &to, const gkString &subject, const char *body)
void	sendEventMessage (const gkString &type, const gkString &value="", const gkString &ext="", bool queued=true)
void	gsDebugPrint (const char *str)
void	infoClear (void)
void	infoLock (bool lockIt)
void	infoShow (bool showIt)
gkString	getScriptFolder ()
bool	gsSetCompositorChain (gsCompositorOp op, const gkString &compositorName)
bool	import (const gkString &scriptName, bool multiCall=false)
gkString	getPlatform ()
bool	isMobile ()
bool	isSoundAvailable ()
bool	isMaterialInitialized (const gkString &matName)
void	initMaterial (const gkString &matName)
gkString	getWindowTitle ()
void	setMaterialParam (const gkString &matName, int shaderType, const gkString &paramName, float value)
void	setMaterialParam (const gkString &matName, int shaderType, const gkString &paramName, int value)
void	setMaterialParam (const gkString &matName, int shaderType, const gkString &paramName, gsVector3 *vec3)
void	setMaterialParam (const gkString &matName, int shaderType, const gkString &paramName, gsVector4 *vec4)
void	log (const gkString &log)
void	logDisable ()
void	logEnable (bool verbose=true)
gkString	md5 (const gkString &md5)
gkString	blowfishEncrypt (const gkString &key, const gkString &in)
gkString	blowfishDecrypt (const gkString &key, const gkString &in)
bool	isNetworkAvailable (const gkString &url="http://www.googlemail.com")
void	asyncIsNetworkAvailable (gsSelf self, gsFunction func, const gkString &url="http://www.googlemail.com")
void	ribbon (gsGameObject *gobj, float width=5, float widthChange=2, int length=400, int maxElements=80, const gkString &materialName="Examples/LightRibbonTrail", gsVector3 initCol=gsVector3(1.0, 0.8, 0), gsVector4 changeCol=gsVector4(0.5, 0.5, 0.5, 0.5))
int	scancodeToInt (gkScanCode code)
unsigned long	getTime ()
unsigned long	getSystemTime ()
gsVector2	getScreenSize ()
void	setScreenSize (int width, int height)
float	getFPS ()
int	native_getScreenshotAsString (lua_State *L)
gkString	getDataDirectory (const gkString &folder="")
gkString	getWorkingFolder ()
gkString	compressString (const gkString &inputString, gsCompressionLevel compLevel)
const char *	compressCString (char *input, int &len, gsCompressionLevel compLevel)
gkString	uncompressString (const gkString &data)
void	executeScript (const gkString &luaScript)
void	setSinglestepMode (bool singlestepMode)
bool	inSinglestepMode ()
void	requestSinglestep ()

Typedef Documentation

typedef OIS::MultiTouchState gkMultiTouchState

Enumeration Type Documentation

enum gsCompositorOp

Enumerator
COP_ADD
COP_DEL
COP_REPLACE
COP_RESET

enum gsCompressionLevel

Enumerator
COMPRESSION_BEST
COMPRESSION_FAST
COMPRESSION_NO

enum gsEngineEvents

Enumerator
EVT_TICK

enum gsGameObjectTypes

Enumerator
OBT_UNKNOWN
OBT_CAMERA
OBT_LIGHT
OBT_ENTITY
OBT_EMPTY
OBT_SKELETON
OBT_CURVE

enum gsLightType

Enumerator
LI_POINT
LI_SPOT
LI_DIR

enum gsMouseButton

Enumerator
LEFT
RIGHT
MIDDLE

enum gsPropertyType

Enumerator
PROP_NULL
PROP_BOOL
PROP_NUMBER
PROP_STRING

enum gsRenderSystem

Enumerator
GS_RS_GL
GS_RS_GLES
GS_RS_D3D9
GS_RS_D3D10
GS_RS_D3D11

enum gsSceneUpdateFlags

Enumerator
UPDATE_NONE
UPDATE_PHYSICS
UPDATE_LOGIC_BRICKS
UPDATE_NODE_TREES
UPDATE_ANIMATIONS
UPDATE_SOUNDS
UPDATE_DBVT
UPDATE_DEBUG
UPDATE_ALL

enum gsShaderProgrammType

Enumerator
ST_VERTEX
ST_FRAGMENT

enum gsTouchType

Enumerator
MT_None
MT_Pressed
MT_Released
MT_Moved
MT_Cancelled

enum gsTransformSpace

Enumerator
TS_LOCAL
TS_PARENT
TS_WORLD

enum TweenEq

Enumerator
TWE_EASE_IN
TWE_EASE_OUT
TWE_EASE_IN_OUT

enum TweenTransition

Enumerator
TWT_LINEAR
TWT_SINE
TWT_QUINT
TWT_QUART
TWT_QUAD
TWT_EXPO
TWT_ELASTIC
TWT_CUBIC
TWT_CIRC
TWT_BOUNCE
TWT_BACK

Function Documentation

void addResourceLocation	(	const gkString &	group,
		const gkString &	type,
		const gkString &	path,
		bool	recursive = false
	)

gkScene* addScene	(	const gkString &	sceneName,
		int	zorder
	)

gkScene* addScene	(	gsScene *	scene,
		int	zorder
	)

void asyncIsNetworkAvailable	(	gsSelf	self,
		gsFunction	func,
		const gkString &	url = "http://www.googlemail.com"
	)

gkString blowfishDecrypt	(	const gkString &	key,
		const gkString &	in
	)

gkString blowfishEncrypt	(	const gkString &	key,
		const gkString &	in
	)

const char* compressCString	(	char *	input,
		int &	len,
		gsCompressionLevel	compLevel
	)

gkString compressString	(	const gkString &	inputString,
		gsCompressionLevel	compLevel
	)

gkGameObjectInstance* createGroupInstance	(	const gkString &	name,
		gsVector3	loc = gsVector3(0, 0, 0),
		gsVector3	orientation = gsVector3(0, 0, 0),
		gsVector3	scale = gsVector3(1, 1, 1),
		const gkString &	resGroup = ""
	)

createGroupInstance

gkGameObjectInstance* createGroupInstance	(	gsScene *	scene,
		const gkString &	name,
		gsVector3	loc = gsVector3(0, 0, 0),
		gsVector3	orientation = gsVector3(0, 0, 0),
		gsVector3	scale = gsVector3(1, 1, 1),
		const gkString &	resGroup = ""
	)

gkGameObjectInstance* createGroupInstance	(	gkScene *	scene,
		const gkString &	name,
		gsVector3	loc = gsVector3(0, 0, 0),
		gsVector3	orientation = gsVector3(0, 0, 0),
		gsVector3	scale = gsVector3(1, 1, 1),
		const gkString &	resGroup = ""
	)

gkGameObjectInstance* createGroupInstance	(	gsScene *	scene,
		const gkString &	name,
		const gkString &	resGroup
	)

void destroyResourceGroup

(

const gkString &

resGrpName

)

void downloadFile	(	const gkString &	name,
		const gkString &	to,
		const gkString &	postData = "",
		bool	overwrite = true,
		bool	checkPeerCA = false,
		bool	checkPeerHostname = false
	)

gkString downloadToString	(	bool	blocking,
		const gkString &	url,
		const gkString &	postData = "",
		bool	checkPeerCA = false,
		bool	checkPeerHostname = false
	)

void executeScript

(

const gkString &

luaScript

)

gkScene* getActiveScene

(

void

)

gkString getDataDirectory

(

const gkString &

folder = ""

)

float getFPS

(

)

int getGroupCount

(

gsScene *

gsscene = 0

)

gkString getGroupNameAt	(	int	i,
		gsScene *	gsscene = 0
	)

gkHUD* getHUD

(

const gkString &

name

)

int getNumJoysticks

(

void

)

gkString getPlatform

(

)

gkScene* getScene	(	const gkString &	sceneName,
		const gkString &	groupName = ""
	)

gsVector2 getScreenSize

(

)

gkString getScriptFolder

(

)

unsigned long getSystemTime

(

)

unsigned long getTime

(

)

gkString getWindowTitle

(

)

gkString getWorkingFolder

(

)

bool groupExists

(

gkString

name

)

void gsDebugPrint

(

const char *

str

)

bool gsSetCompositorChain	(	gsCompositorOp	op,
		const gkString &	compositorName
	)

bool import	(	const gkString &	scriptName,
		bool	multiCall = false
	)

void infoClear

(

void

)

void infoLock

(

bool

lockIt

)

void infoShow

(

bool

showIt

)

void initMaterial

(

const gkString &

matName

)

bool inSinglestepMode

(

)

bool isMaterialInitialized

(

const gkString &

matName

)

bool isMobile

(

)

bool isNetworkAvailable

(

const gkString &

url = "http://www.googlemail.com"

)

bool isSoundAvailable

(

)

void loadBlend	(	const gkString &	name,
		const gkString &	sceneName = "",
		const gkString &	groupName = "",
		bool	ignoreLibraries = true
	)

void loadResource	(	const gkString &	group,
		const gkString &	path
	)

void log

(

const gkString &

log

)

void logDisable

(

)

void logEnable

(

bool

verbose = true

)

gkString md5

(

const gkString &

md5

)

int native_getScreenshotAsString

(

lua_State *

L

)

void nbDownload

(

)

bool nbIsRunning

(

)

void nbPoll

(

)

void nbSetCallback	(	gsSelf	self,
		gsFunction	func
	)

void nbSetCallback

(

gsFunction

func

)

void requestSinglestep

(

)

void ribbon	(	gsGameObject *	gobj,
		float	width = 5,
		float	widthChange = 2,
		int	length = 400,
		int	maxElements = 80,
		const gkString &	materialName = "Examples/LightRibbonTrail",
		gsVector3	initCol = gsVector3(1.0, 0.8, 0),
		gsVector4	changeCol = gsVector4(0.5, 0.5, 0.5, 0.5)
	)

int scancodeToInt

(

gkScanCode

code

)

void sendEventMessage	(	const gkString &	type,
		const gkString &	value = "",
		const gkString &	ext = "",
		bool	queued = true
	)

void sendMessage	(	const gkString &	from,
		const gkString &	to,
		const gkString &	subject,
		const char *	body
	)

void setMaterialParam	(	const gkString &	matName,
		int	shaderType,
		const gkString &	paramName,
		float	value
	)

void setMaterialParam	(	const gkString &	matName,
		int	shaderType,
		const gkString &	paramName,
		int	value
	)

void setMaterialParam	(	const gkString &	matName,
		int	shaderType,
		const gkString &	paramName,
		gsVector3 *	vec3
	)

void setMaterialParam	(	const gkString &	matName,
		int	shaderType,
		const gkString &	paramName,
		gsVector4 *	vec4
	)

void setScreenSize	(	int	width,
		int	height
	)

void setSinglestepMode

(

bool

singlestepMode

)

gkString uncompressString

(

const gkString &

data

)

void unloadAllBlendFiles

(

)

void unloadBlendFile

(

const gkString &

name

)

void updateStaticBatch	(	gkString	groupName = "",
		gsScene *	scene = 0
	)