sp::tool Namespace Reference

This namespace contains all extendet tools for particular game development which should be used in a level editor. More...

Namespaces
namespace	AudioPCMPlotter
	Namespace for audio PCM raw data plotter.
namespace	CommandLineTasks
namespace	Debugging
	Namespace for debugging functions.
namespace	ImageModifier
	Image modifier namespace to bake normal maps, blur images etc.
namespace	LightmapGen
	Namespace with all data structures for lightmap generation.
namespace	Toolset
Classes
struct	SCastShadowObject
struct	SGetShadowObject
struct	SLightmapLight
class	LightmapGenerator
	The lightmap generator class is a utility actually only used in a world editor. More...
class	Storyboard
class	StoryboardConsequence
class	Event
class	EventTimer
class	TriggerCounter
class	TriggerSwitch
class	LogicGate
class	Trigger
class	MeshBooleanOperator
struct	SParticle
class	ParticleAnimator
class	PathNode
class	PathEdge
class	PathGraph
class	ScriptFramework
class	ScriptLoader
struct	SXMLAttribute
struct	SXMLTag
class	XMLParser
class	CommandLineUI
class	InputService
class	GeneralPurposeTexture
class	MatrixTexture
class	VectorTexture
struct	SToken
	Script token structure. More...
class	TokenParser
class	WebPageRenderer
Typedefs
typedef boost::function< bool(f32 Progress)>	LightmapProgressCallback
typedef boost::function< void(const ELightmapGenerationStates State, const io::stringc &Info)>	LightmapStateCallback
typedef bool(*	PFNPARTICLECALLBACKPROC )(SParticle *Object)
Enumerations
enum	ELightmapGenerationsFlags { LIGHTMAPFLAG_NOCOLORS = 0x00000001, LIGHTMAPFLAG_NOTRANSPARENCY = 0x00000002 }
enum	ELightmapGenerationStates {   LIGHTMAPSTATE_INITIALIZING, LIGHTMAPSTATE_PARTITIONING, LIGHTMAPSTATE_SHADING, LIGHTMAPSTATE_BLURING,   LIGHTMAPSTATE_BAKING, LIGHTMAPSTATE_COMPLETED }
enum	ELogicGates {   LOGICGATE_AND, LOGICGATE_NAND, LOGICGATE_OR, LOGICGATE_NOR,   LOGICGATE_XOR, LOGICGATE_XNOR }
	Logic gates are used for combinatory logic in the storyboard. More...
enum	EModelCombinations { COMBINATION_UNION, COMBINATION_DIFFERENCE, COMBINATION_DIFFERENCEINV, COMBINATION_INTERSECTION }
enum	EParticleAttribute { PARTICLE_LOOP, PARTICLE_ONESHOT }
enum	EParticleBlendMode { PARTICLE_NOBLENDING, PARTICLE_BLENDIN, PARTICLE_BLENDOUT }
enum	ECommandLineFlags { CMDFLAG_SCROLL = 0x01, CMDFLAG_MEMENTO = 0x02, CMDFLAG_DISABLE_INPUT = 0x04, CMDFLAG_COMMON }
	Command line user interface options. More...
enum	ETokenTypes {   TOKEN_UNKNOWN, TOKEN_NAME, TOKEN_STRING, TOKEN_NUMBER_INT,   TOKEN_NUMBER_FLOAT, TOKEN_COMMA, TOKEN_DOT, TOKEN_COLON,   TOKEN_SEMICOLON, TOKEN_EXCLAMATION_MARK, TOKEN_QUESTION_MARK, TOKEN_BRACKET_LEFT,   TOKEN_BRACKET_RIGHT, TOKEN_SQUARED_BRACKET_LEFT, TOKEN_SQUARED_BRACKET_RIGHT, TOKEN_BRACE_LEFT,   TOKEN_BRACE_RIGHT, TOKEN_GREATER_THAN, TOKEN_LESS_THAN, TOKEN_GREATER_THAN_OR_EQUAL,   TOKEN_LESS_THAN_OR_RQUAL, TOKEN_EQUAL, TOKEN_ASSIGN, TOKEN_NOT_EQUAL,   TOKEN_INC, TOKEN_DEC, TOKEN_ADD, TOKEN_SUB,   TOKEN_MUL, TOKEN_DIV, TOKEN_MOD, TOKEN_ADD_ASSIGN,   TOKEN_SUB_ASSIGN, TOKEN_MUL_ASSIGN, TOKEN_DIV_ASSIGN, TOKEN_MOD_ASSIGN,   TOKEN_LOGIC_AND, TOKEN_LOGIC_OR, TOKEN_BITWISE_NOT, TOKEN_BITWISE_AND,   TOKEN_BITWISE_OR, TOKEN_BITWISE_XOR, TOKEN_BITWISE_NOT_ASSIGN, TOKEN_BITWISE_AND_ASSIGN,   TOKEN_BITWISE_OR_ASSIGN, TOKEN_BITWISE_XOR_ASSIGN, TOKEN_SHIFT_LEFT, TOKEN_SHIFT_RIGHT,   TOKEN_SHIFT_LEFT_ASSIGN, TOKEN_SHIFT_RIGHT_ASSIGN }
	Script token types. More...

---

Detailed Description

This namespace contains all extendet tools for particular game development which should be used in a level editor.

---

Typedef Documentation

typedef boost::function<bool (f32 Progress)> sp::tool::LightmapProgressCallback

The lightmap progress callback will be called several times during lightmap generation as feedback for the user.

Parameters:

[in]

Progress

Specifies the generation progress. This is in the range [0.0 .. 1.0].

Returns:

True when the generation is to be continued. Otherwise lightmap generation will be canceled.

typedef boost::function<void (const ELightmapGenerationStates State, const io::stringc &Info)> sp::tool::LightmapStateCallback

The lightmap state callback will be called every time the generation state changes, i.e. when the generation state changes from lightmap-texel-generation to lightmap-texture-bluring.

Parameters:

[in]	State	Specifies the current state of lightmap generation.
[in]	Info	Specifies a short information string about the current state.

See also:

ELightmapGenerationStates

typedef bool(* sp::tool::PFNPARTICLECALLBACKPROC)(SParticle *Object)

---

Enumeration Type Documentation

enum sp::tool::ECommandLineFlags

Command line user interface options.

Enumerator:

CMDFLAG_SCROLL	Enables scrolling. This can be used for drawing and input functions.
CMDFLAG_MEMENTO	Enables memento and stores all enterd commands. Get the previous memento by pressing page-up key.
CMDFLAG_DISABLE_INPUT	Disables command execution by user input.
CMDFLAG_COMMON	All common command line flags are enabled.

enum sp::tool::ELightmapGenerationsFlags

Enumerator:

LIGHTMAPFLAG_NOCOLORS	Colored lighting is disabled. When all lights have the diffuse color (255, 255, 255) this flag has no effect.
LIGHTMAPFLAG_NOTRANSPARENCY	Transparency textures ray-casting is disabled. This may occur in much faster lightmap generation.

enum sp::tool::ELightmapGenerationStates

Enumerator:

LIGHTMAPSTATE_INITIALIZING	Initialization state. Occrus at start up.
LIGHTMAPSTATE_PARTITIONING	Scene partitioning state. Occurs when the scene will be partitioned.
LIGHTMAPSTATE_SHADING	Lightmap texel generation state. Occurs every time a new light source is used for lightmap texel generation.
LIGHTMAPSTATE_BLURING	Lightmap texture bluring. Occurs when the lightmap image buffers are being blured. Only occurs when bluring is enabled.
LIGHTMAPSTATE_BAKING	Final lightmap texture baking state. Occurs when texture bleeding is reduced and the final lightmap textures are created.
LIGHTMAPSTATE_COMPLETED	Lightmap generation has been completed successful. Occurs when lightmap generation is done.

enum sp::tool::ELogicGates

Logic gates are used for combinatory logic in the storyboard.

Enumerator:

LOGICGATE_AND
LOGICGATE_NAND
LOGICGATE_OR
LOGICGATE_NOR
LOGICGATE_XOR
LOGICGATE_XNOR

enum sp::tool::EModelCombinations

Enumerator:

COMBINATION_UNION
COMBINATION_DIFFERENCE
COMBINATION_DIFFERENCEINV
COMBINATION_INTERSECTION

enum sp::tool::EParticleAttribute

Enumerator:

PARTICLE_LOOP
PARTICLE_ONESHOT

enum sp::tool::EParticleBlendMode

Enumerator:

PARTICLE_NOBLENDING
PARTICLE_BLENDIN
PARTICLE_BLENDOUT

enum sp::tool::ETokenTypes

Script token types.

Enumerator:

TOKEN_UNKNOWN	Unknown token.
TOKEN_NAME	Name of a variable, function, keyword etc.
TOKEN_STRING	ANSI C strings.
TOKEN_NUMBER_INT	Integer numbers.
TOKEN_NUMBER_FLOAT	Floating point numbers.
TOKEN_COMMA	,
TOKEN_DOT
TOKEN_COLON	:
TOKEN_SEMICOLON	;
TOKEN_EXCLAMATION_MARK	!
TOKEN_QUESTION_MARK	?
TOKEN_BRACKET_LEFT	(
TOKEN_BRACKET_RIGHT	)
TOKEN_SQUARED_BRACKET_LEFT	[
TOKEN_SQUARED_BRACKET_RIGHT	]
TOKEN_BRACE_LEFT	{
TOKEN_BRACE_RIGHT	}
TOKEN_GREATER_THAN	>
TOKEN_LESS_THAN	<
TOKEN_GREATER_THAN_OR_EQUAL	>=
TOKEN_LESS_THAN_OR_RQUAL	<=
TOKEN_EQUAL	==
TOKEN_ASSIGN	=
TOKEN_NOT_EQUAL	!=
TOKEN_INC	++
TOKEN_DEC	--
TOKEN_ADD	+
TOKEN_SUB
TOKEN_MUL	*
TOKEN_DIV	/
TOKEN_MOD	%
TOKEN_ADD_ASSIGN	+=
TOKEN_SUB_ASSIGN	-=
TOKEN_MUL_ASSIGN	*=
TOKEN_DIV_ASSIGN	/=
TOKEN_MOD_ASSIGN	=
TOKEN_LOGIC_AND	&&
TOKEN_LOGIC_OR	||
TOKEN_BITWISE_NOT	~
TOKEN_BITWISE_AND	&
TOKEN_BITWISE_OR	|
TOKEN_BITWISE_XOR	^
TOKEN_BITWISE_NOT_ASSIGN	~=
TOKEN_BITWISE_AND_ASSIGN	&=
TOKEN_BITWISE_OR_ASSIGN	|=
TOKEN_BITWISE_XOR_ASSIGN	^=
TOKEN_SHIFT_LEFT	<<
TOKEN_SHIFT_RIGHT	>>
TOKEN_SHIFT_LEFT_ASSIGN	<<=
TOKEN_SHIFT_RIGHT_ASSIGN	>>=