sp::tool::ScriptFramework Class Reference

#include <spToolScriptFramework.hpp>

List of all members.

Classes
struct	SContainer
struct	SValue
struct	SVector
Public Member Functions
	ScriptFramework (scene::SceneGraph *ActiveSceneGraph=0, audio::SoundDevice *ActiveSoundDevice=0)
virtual	~ScriptFramework ()
virtual io::stringc	getVersion () const
	Returns version of the script framework (e.g. "ConstructiveScriptFramework - v.3.0").
bool	loadScriptFile (const io::stringc &Filename)
virtual void	updateFramework ()
virtual void	clearLists ()
std::vector< video::Texture * >	getTextureList () const
std::vector< audio::Sound * >	getSoundList () const
std::vector< scene::SceneNode * >	getNodeList () const
std::vector< scene::Mesh * >	getMeshList () const
std::vector< scene::Camera * >	getCameraList () const
std::vector< scene::Light * >	getLightList () const
std::vector< scene::Billboard * >	getBillboardList () const
Protected Types
enum	ETokens {   TOKEN_UNKNOWN, TOKEN_STRING, TOKEN_INTEGER, TOKEN_FLOAT,   TOKEN_SEMICOLON, TOKEN_POINT, TOKEN_COMMA, TOKEN_DOUBLEPOINT,   TOKEN_QUOTE, TOKEN_COMMENT, TOKEN_COMMENT_MS, TOKEN_COMMENT_ME,   TOKEN_SLASH, TOKEN_BACKSLASH, TOKEN_STAR, TOKEN_PLUS,   TOKEN_MINUS, TOKEN_EQUAL, TOKEN_HASHKEY, TOKEN_QUESTION,   TOKEN_BLANK, TOKEN_BRACKET_SS, TOKEN_BRACKET_SE, TOKEN_BRACKET_CS,   TOKEN_BRACKET_CE, TOKEN_BRACKET_NS, TOKEN_BRACKET_NE }
enum	EKeywords {   KEYWORD_UNKNOWN, KEYWORD_COMMAND, KEYWORD_VECTOR_BEGIN, KEYWORD_VECTOR_END,   KEYWORD_VARIABLE, KEYWORD_CLASS, KEYWORD_BLOCK, KEYWORD_MEMBER,   KEYWORD_ACCESS, KEYWORD_ATTRIBUTE, KEYWORD_CONSTRUCT_END, KEYWORD_STRING,   KEYWORD_INTEGER, KEYWORD_FLOAT, KEYWORD_BOOLEAN, KEYWORD_LOOP_BEGIN,   KEYWORD_LOOP_END, KEYWORD_LOOP_FROM, KEYWORD_LOOP_TO, KEYWORD_LOOP_STEP,   KEYWORD_OPERATOR }
Protected Member Functions
c8	readNextChar ()
void	decrementFilePos ()
ETokens	readNextToken (bool OnlySingleChar=false)
EKeywords	readNextKeyword ()
bool	readScript ()
bool	readCommand ()
bool	readVector ()
bool	readClass ()
bool	readBlock ()
bool	readLoopBegin ()
bool	readLoopEnd ()
bool	readVariable ()
bool	readValue (SValue &Value)
bool	printError (const io::stringc &Message)
void	printWarning (const io::stringc &Message)
bool	getAccessMember (const io::stringc &Name)
Protected Attributes
io::FileSystem	FileSys_
io::File *	File_
scene::SceneGraph *	ActiveSceneGraph_
audio::SoundDevice *	ActiveSoundDevice_
SContainer< video::Texture >	Textures_
SContainer< audio::Sound >	Sounds_
SContainer< scene::SceneNode >	Nodes_
SContainer< scene::Mesh >	Meshes_
SContainer< scene::Camera >	Cameras_
SContainer< scene::Light >	Lights_
SContainer< scene::Billboard >	Billboards_
io::stringc	CurLine_
u32	CurColumnNr_
u32	CurLineNr_
std::list< io::stringc >	LineList_
c8	CurChar_
ETokens	CurToken_
io::stringc	StrToken_
s32	IntToken_
f32	FltToken_
EKeywords	CurKeyword_
io::stringc	StrKeyword_
io::stringc	Str2Keyword_
c8	OperatorType_
io::stringc	WorkDir_
Static Protected Attributes
static const c8 *	ERRORMSG_WRONGTOKEN

---

Detailed Description

Deprecated:

This has to be re-written, removed or combined with the new TokenParser class.

---

Member Enumeration Documentation

enum sp::tool::ScriptFramework::EKeywords [protected]

Enumerator:

KEYWORD_UNKNOWN
KEYWORD_COMMAND
KEYWORD_VECTOR_BEGIN
KEYWORD_VECTOR_END
KEYWORD_VARIABLE
KEYWORD_CLASS
KEYWORD_BLOCK
KEYWORD_MEMBER
KEYWORD_ACCESS
KEYWORD_ATTRIBUTE
KEYWORD_CONSTRUCT_END
KEYWORD_STRING
KEYWORD_INTEGER
KEYWORD_FLOAT
KEYWORD_BOOLEAN
KEYWORD_LOOP_BEGIN
KEYWORD_LOOP_END
KEYWORD_LOOP_FROM
KEYWORD_LOOP_TO
KEYWORD_LOOP_STEP
KEYWORD_OPERATOR

enum sp::tool::ScriptFramework::ETokens [protected]

Enumerator:

TOKEN_UNKNOWN
TOKEN_STRING
TOKEN_INTEGER
TOKEN_FLOAT
TOKEN_SEMICOLON
TOKEN_POINT
TOKEN_COMMA
TOKEN_DOUBLEPOINT
TOKEN_QUOTE
TOKEN_COMMENT
TOKEN_COMMENT_MS
TOKEN_COMMENT_ME
TOKEN_SLASH
TOKEN_BACKSLASH
TOKEN_STAR
TOKEN_PLUS
TOKEN_MINUS
TOKEN_EQUAL
TOKEN_HASHKEY
TOKEN_QUESTION
TOKEN_BLANK
TOKEN_BRACKET_SS
TOKEN_BRACKET_SE
TOKEN_BRACKET_CS
TOKEN_BRACKET_CE
TOKEN_BRACKET_NS
TOKEN_BRACKET_NE

---

Constructor & Destructor Documentation

sp::tool::ScriptFramework::ScriptFramework	(	scene::SceneGraph *	ActiveSceneGraph = 0,
		audio::SoundDevice *	ActiveSoundDevice = 0
	)

virtual sp::tool::ScriptFramework::~ScriptFramework

(

)

[virtual]

---

Member Function Documentation

virtual void sp::tool::ScriptFramework::clearLists

(

)

[virtual]

void sp::tool::ScriptFramework::decrementFilePos

(

)

[protected]

bool sp::tool::ScriptFramework::getAccessMember

(

const io::stringc &

Name

)

[protected]

std::vector<scene::Billboard*> sp::tool::ScriptFramework::getBillboardList

(

)

const [inline]

std::vector<scene::Camera*> sp::tool::ScriptFramework::getCameraList

(

)

const [inline]

std::vector<scene::Light*> sp::tool::ScriptFramework::getLightList

(

)

const [inline]

std::vector<scene::Mesh*> sp::tool::ScriptFramework::getMeshList

(

)

const [inline]

std::vector<scene::SceneNode*> sp::tool::ScriptFramework::getNodeList

(

)

const [inline]

std::vector<audio::Sound*> sp::tool::ScriptFramework::getSoundList

(

)

const [inline]

std::vector<video::Texture*> sp::tool::ScriptFramework::getTextureList

(

)

const [inline]

virtual io::stringc sp::tool::ScriptFramework::getVersion

(

)

const [virtual]

Returns version of the script framework (e.g. "ConstructiveScriptFramework - v.3.0").

bool sp::tool::ScriptFramework::loadScriptFile

(

const io::stringc &

Filename

)

Loads a "SoftPixel Engine" script file.

Parameters:

Filename,:

Script filename which is to be loaded.

Returns:

True if the script file could be loaded successful. Otherwise false.

bool sp::tool::ScriptFramework::printError

(

const io::stringc &

Message

)

[protected]

void sp::tool::ScriptFramework::printWarning

(

const io::stringc &

Message

)

[protected]

bool sp::tool::ScriptFramework::readBlock

(

)

[protected]

bool sp::tool::ScriptFramework::readClass

(

)

[protected]

bool sp::tool::ScriptFramework::readCommand

(

)

[protected]

bool sp::tool::ScriptFramework::readLoopBegin

(

)

[protected]

bool sp::tool::ScriptFramework::readLoopEnd

(

)

[protected]

c8 sp::tool::ScriptFramework::readNextChar

(

)

[protected]

EKeywords sp::tool::ScriptFramework::readNextKeyword

(

)

[protected]

ETokens sp::tool::ScriptFramework::readNextToken

(

bool

OnlySingleChar = false

)

[protected]

bool sp::tool::ScriptFramework::readScript

(

)

[protected]

bool sp::tool::ScriptFramework::readValue

(

SValue &

Value

)

[protected]

bool sp::tool::ScriptFramework::readVariable

(

)

[protected]

bool sp::tool::ScriptFramework::readVector

(

)

[protected]

virtual void sp::tool::ScriptFramework::updateFramework

(

)

[virtual]

---

Member Data Documentation

scene::SceneGraph* sp::tool::ScriptFramework::ActiveSceneGraph_ [protected]

audio::SoundDevice* sp::tool::ScriptFramework::ActiveSoundDevice_ [protected]

SContainer<scene::Billboard> sp::tool::ScriptFramework::Billboards_ [protected]

SContainer<scene::Camera> sp::tool::ScriptFramework::Cameras_ [protected]

c8 sp::tool::ScriptFramework::CurChar_ [protected]

u32 sp::tool::ScriptFramework::CurColumnNr_ [protected]

EKeywords sp::tool::ScriptFramework::CurKeyword_ [protected]

io::stringc sp::tool::ScriptFramework::CurLine_ [protected]

u32 sp::tool::ScriptFramework::CurLineNr_ [protected]

ETokens sp::tool::ScriptFramework::CurToken_ [protected]

const c8* sp::tool::ScriptFramework::ERRORMSG_WRONGTOKEN [static, protected]

io::File* sp::tool::ScriptFramework::File_ [protected]

io::FileSystem sp::tool::ScriptFramework::FileSys_ [protected]

f32 sp::tool::ScriptFramework::FltToken_ [protected]

s32 sp::tool::ScriptFramework::IntToken_ [protected]

SContainer<scene::Light> sp::tool::ScriptFramework::Lights_ [protected]

std::list<io::stringc> sp::tool::ScriptFramework::LineList_ [protected]

SContainer<scene::Mesh> sp::tool::ScriptFramework::Meshes_ [protected]

SContainer<scene::SceneNode> sp::tool::ScriptFramework::Nodes_ [protected]

c8 sp::tool::ScriptFramework::OperatorType_ [protected]

SContainer<audio::Sound> sp::tool::ScriptFramework::Sounds_ [protected]

io::stringc sp::tool::ScriptFramework::Str2Keyword_ [protected]

io::stringc sp::tool::ScriptFramework::StrKeyword_ [protected]

io::stringc sp::tool::ScriptFramework::StrToken_ [protected]

SContainer<video::Texture> sp::tool::ScriptFramework::Textures_ [protected]

io::stringc sp::tool::ScriptFramework::WorkDir_ [protected]

---

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

• D:/SoftwareEntwicklung/C++/HLC/Tools/SoftPixelEngine/repository/sources/Framework/Tools/spToolScriptFramework.hpp