AaronCameron.net
What's your point?
Not a Member? - Login or Create an Account...MC Offline
Monday the 17th of June 2013 @ 11:56pm
Front Page Projects Your Profile About
[]

LibN2L-4 Library Code Reference

Classes
Compounds
Files
Members
Method Index
Full Reference

n2l Namespace Reference

Classes

Typedefs

Enumerations

Functions

Variables


Typedef Documentation

typedef tUint n2l::tActionBindingID
 

Definition at line 66 of file gui/types.h.

typedef cDynVar n2l::tActionData
 

Definition at line 67 of file gui/types.h.

typedef tSint n2l::tAudioChannel
 

Definition at line 45 of file audio/types.h.

typedef tUbyte n2l::tAudioVolume
 

Definition at line 46 of file audio/types.h.

typedef tFloat n2l::tAudioVolumef
 

Definition at line 47 of file audio/types.h.

typedef cBezier33<tDouble, tDouble> n2l::tBezier33d
 

Definition at line 70 of file geometry/types.h.

typedef cBezier33<tFloat, tFloat> n2l::tBezier33f
 

Definition at line 69 of file geometry/types.h.

typedef bool n2l::tBool
 

Definition at line 56 of file base/types.h.

typedef char n2l::tChar
 

Definition at line 32 of file base/types.h.

typedef double n2l::tDouble
 

Definition at line 53 of file base/types.h.

typedef std::vector<tString> n2l::tFileFormatList
 

Definition at line 74 of file vfsTypes.h.

typedef float n2l::tFloat
 

Definition at line 52 of file base/types.h.

typedef tString n2l::tFsFileBuffer
 

Definition at line 41 of file vfsTypes.h.

typedef tUint n2l::tFsFileSize
 

Definition at line 45 of file vfsTypes.h.

typedef tString n2l::tFsNodeName
 

Definition at line 38 of file vfsTypes.h.

typedef tUint32 n2l::tFsPermissions
 

Definition at line 57 of file vfsTypes.h.

typedef tUbyte n2l::tGlyphID
 

Definition at line 33 of file fonts/types.h.

typedef cColour n2l::tGuiColour
 

Definition at line 39 of file gui/types.h.

typedef tString n2l::tGuiName
 

Definition at line 36 of file gui/types.h.

typedef tMousePos n2l::tGuiPos
 

Definition at line 37 of file gui/types.h.

typedef tFloat n2l::tHertz
 

Definition at line 32 of file timing/types.h.

typedef tUint n2l::tKeyMods
 

Definition at line 394 of file events/types.h.

typedef long double n2l::tLDouble
 

Definition at line 54 of file base/types.h.

typedef tUint32 n2l::tMaterialOptions
 

Definition at line 62 of file materialTypes.h.

typedef cMatrix44<tDouble> n2l::tMatrix44d
 

Definition at line 76 of file geometry/types.h.

typedef cMatrix44<tFloat> n2l::tMatrix44f
 

Definition at line 75 of file geometry/types.h.

typedef tVector2f n2l::tMousePos
 

Definition at line 41 of file events/types.h.

typedef tUint n2l::tMusicOptions
 

Definition at line 42 of file audio/types.h.

typedef cPlane3<tDouble> n2l::tPlane3d
 

Definition at line 79 of file geometry/types.h.

typedef cPlane3<tFloat> n2l::tPlane3f
 

Definition at line 78 of file geometry/types.h.

typedef cQuaternion<tDouble> n2l::tQuaterniond
 

Definition at line 82 of file geometry/types.h.

typedef cQuaternion<tFloat> n2l::tQuaternionf
 

Definition at line 81 of file geometry/types.h.

typedef cRectangle2<tDouble,tDouble,tDouble> n2l::tRectangle2d
 

Definition at line 59 of file geometry/types.h.

typedef cRectangle2<tFloat,tFloat,tFloat> n2l::tRectangle2f
 

Definition at line 58 of file geometry/types.h.

typedef cRectangle2<tSint,tSint,tSint> n2l::tRectangle2s
 

Definition at line 57 of file geometry/types.h.

typedef cRectangle2<tUint,tSint,tUint> n2l::tRectangle2u
 

Definition at line 56 of file geometry/types.h.

typedef cRectangle3<tDouble,tDouble,tDouble> n2l::tRectangle3d
 

Definition at line 64 of file geometry/types.h.

typedef cRectangle3<tFloat,tFloat,tFloat> n2l::tRectangle3f
 

Definition at line 63 of file geometry/types.h.

typedef cRectangle3<tSint,tSint,tSint> n2l::tRectangle3s
 

Definition at line 62 of file geometry/types.h.

typedef cRectangle3<tUint,tSint,tUint> n2l::tRectangle3u
 

Definition at line 61 of file geometry/types.h.

typedef tUint32 n2l::tRenderOptions
 

Definition at line 45 of file rObjectTypes.h.

typedef tSint8 n2l::tSbyte
 

Definition at line 43 of file base/types.h.

typedef tSint32 n2l::tSint
 

Definition at line 50 of file base/types.h.

typedef signed short n2l::tSint16
 

Definition at line 37 of file base/types.h.

typedef signed int n2l::tSint32
 

Definition at line 40 of file base/types.h.

typedef signed char n2l::tSint8
 

Definition at line 34 of file base/types.h.

typedef tSint16 n2l::tSshort
 

Definition at line 46 of file base/types.h.

typedef cString n2l::tString
 

Definition at line 58 of file base/types.h.

typedef tVector2s n2l::tSysMousePos
 

Definition at line 40 of file events/types.h.

typedef tUint n2l::tTimestamp
 

Definition at line 34 of file timing/types.h.

typedef cTriangle3<tDouble> n2l::tTriangle3d
 

Definition at line 67 of file geometry/types.h.

typedef cTriangle3<tFloat> n2l::tTriangle3f
 

Definition at line 66 of file geometry/types.h.

typedef tUint8 n2l::tUbyte
 

Definition at line 44 of file base/types.h.

typedef tUint n2l::tUID
 

Definition at line 64 of file base/types.h.

typedef tUint32 n2l::tUint
 

Definition at line 49 of file base/types.h.

typedef unsigned short n2l::tUint16
 

Definition at line 36 of file base/types.h.

typedef unsigned int n2l::tUint32
 

Definition at line 39 of file base/types.h.

typedef unsigned char n2l::tUint8
 

Definition at line 33 of file base/types.h.

typedef tUint16 n2l::tUshort
 

Definition at line 47 of file base/types.h.

typedef cVector2<tDouble,tDouble,tDouble> n2l::tVector2d
 

Definition at line 54 of file geometry/types.h.

typedef cVector2<tFloat,tFloat,tFloat> n2l::tVector2f
 

Definition at line 53 of file geometry/types.h.

typedef cVector2<tSint,tSint,tUint> n2l::tVector2s
 

Definition at line 52 of file geometry/types.h.

typedef cVector2<tUint,tSint,tUint> n2l::tVector2u
 

Definition at line 51 of file geometry/types.h.

typedef cVector3<tUbyte,tSshort,tUbyte> n2l::tVector3b
 

Definition at line 47 of file geometry/types.h.

typedef cVector3<tDouble,tDouble,tDouble> n2l::tVector3d
 

Definition at line 49 of file geometry/types.h.

typedef cVector3<tFloat,tFloat,tFloat> n2l::tVector3f
 

Definition at line 48 of file geometry/types.h.

typedef cVector3<tSint,tSint,tSint> n2l::tVector3s
 

Definition at line 46 of file geometry/types.h.

typedef cVector3<tUint,tSint,tUint> n2l::tVector3u
 

Definition at line 45 of file geometry/types.h.

typedef tString n2l::tVfsFileBuffer
 

Definition at line 40 of file vfsTypes.h.

typedef tUint n2l::tVfsFileSize
 

Definition at line 43 of file vfsTypes.h.

typedef ino_t n2l::tVfsINode
 

Definition at line 47 of file vfsTypes.h.

typedef tString n2l::tVfsNodeName
 

Definition at line 37 of file vfsTypes.h.


Enumeration Type Documentation

anonymous enum
 

Enumerator:
R_Normal 
R_NoTextures 
R_NoNormals 
R_Wireframe 
R_FaceLighting 
R_NoMaterials 
R_MultiPass 
R_TwoSided 
R_ShowNormals 

Definition at line 33 of file rObjectTypes.h.

anonymous enum
 

Enumerator:
MatOpt_Normal  Use the material as normal.
MatOpt_NoTextures  Don't rebind a new texture if defined in the material.

This does not effect other maps.

MatOpt_Disable  Entirely disable rendering of the material.
MatOpt_ZeroSpecular  Set the specular component of the material to zero (0,0,0,1), only rendering the ambient, diffuse and emissive values.

Skips setting the shininess property.

MatOpt_ZeroDiffAmbEmis  Set the diffuse and ambient components of the material to zero (0,0,0,1), only rendering the specular and shininess properties.

Definition at line 33 of file materialTypes.h.

enum n2l::tEventType
 

SDL Event to N2L event rename and merge.

Enumerator:
EventType_None 
EventType_Active 
EventType_Key 
EventType_MouseMotion 
EventType_MouseButton 
EventType_JoystickAxis 
EventType_JoystickTrackball 
EventType_JoystickHat 
EventType_JoystickButton 
EventType_Quit 
EventType_VideoResize 
EventType_VideoExpose 
EventType_Custom1 
EventType_Custom2 
EventType_Custom3 
EventType_Custom4 
EventType_Custom5 
EventType_Custom6 
EventType_Custom7 
EventType_Custom8 
EventType_Custom9 
EventType_NumEventTypes 

Definition at line 45 of file events/types.h.

enum n2l::tFsNodeType
 

Enumerator:
FsNodeType_Undefined 
FsNodeType_Unknown 
FsNodeType_File 
FsNodeType_Directory 

Definition at line 49 of file vfsTypes.h.

enum n2l::tFsPermission
 

Enumerator:
FsPermission_NoneOrUnknown 
FsPermission_Readable 
FsPermission_Writeable 

Definition at line 59 of file vfsTypes.h.

enum n2l::tGuiActionType
 

Enumerator:
GuiActionType_None 
GuiActionType_Deconstructing 
GuiActionType_DimensionsChanged 
GuiActionType_Over 
GuiActionType_Out 
GuiActionType_Pressed 
GuiActionType_Released 
GuiActionType_Clicked 
GuiActionType_Selected 
GuiActionType_Unselected 
GuiActionType_FocusChanged 
GuiActionType_DisableChanged 
GuiActionType_SliderValueChanged 
GuiActionType_ValueChanged 
GuiActionType_EffectComplete 
GuiActionType_Keystroke 
GuiActionType_KeystrokeOutside 
GuiActionType_FirstUpdate 
GuiActionType_NumActionTypes 

Definition at line 41 of file gui/types.h.

enum n2l::tJoystickHat
 

Enumerator:
JoystickHat_Centered 
JoystickHat_Up 
JoystickHat_Right 
JoystickHat_Down 
JoystickHat_Left 
JoystickHat_RightUp 
JoystickHat_RightDown 
JoystickHat_LeftUp 
JoystickHat_LeftDown 

Definition at line 74 of file events/types.h.

enum n2l::tKey
 

Enumerator:
Key_Unknown 
Key_Backspace 
Key_Tab 
Key_Clear 
Key_Return 
Key_Pause 
Key_Escape 
Key_Space 
Key_Exclaim 
Key_QuotedBl 
Key_Hash 
Key_Dollar 
Key_Ampersand 
Key_Quote 
Key_LParen 
Key_RParan 
Key_Asterisk 
Key_Plus 
Key_Comma 
Key_Minus 
Key_Period 
Key_Slash 
Key_0 
Key_1 
Key_2 
Key_3 
Key_4 
Key_5 
Key_6 
Key_7 
Key_8 
Key_9 
Key_Colon 
Key_SemiColon 
Key_Less 
Key_Equals 
Key_Greater 
Key_Question 
Key_At 
Key_LBracket 
Key_BackSlash 
Key_RBracket 
Key_Caret 
Key_Underscore 
Key_BackQuote 
Key_A 
Key_B 
Key_C 
Key_D 
Key_E 
Key_F 
Key_G 
Key_H 
Key_I 
Key_J 
Key_K 
Key_L 
Key_M 
Key_N 
Key_O 
Key_P 
Key_Q 
Key_R 
Key_S 
Key_T 
Key_U 
Key_V 
Key_W 
Key_X 
Key_Y 
Key_Z 
Key_Delete 
Key_World_0 
Key_World_1 
Key_World_2 
Key_World_3 
Key_World_4 
Key_World_5 
Key_World_6 
Key_World_7 
Key_World_8 
Key_World_9 
Key_World_10 
Key_World_11 
Key_World_12 
Key_World_13 
Key_World_14 
Key_World_15 
Key_World_16 
Key_World_17 
Key_World_18 
Key_World_19 
Key_World_20 
Key_World_21 
Key_World_22 
Key_World_23 
Key_World_24 
Key_World_25 
Key_World_26 
Key_World_27 
Key_World_28 
Key_World_29 
Key_World_30 
Key_World_31 
Key_World_32 
Key_World_33 
Key_World_34 
Key_World_35 
Key_World_36 
Key_World_37 
Key_World_38 
Key_World_39 
Key_World_40 
Key_World_41 
Key_World_42 
Key_World_43 
Key_World_44 
Key_World_45 
Key_World_46 
Key_World_47 
Key_World_48 
Key_World_49 
Key_World_50 
Key_World_51 
Key_World_52 
Key_World_53 
Key_World_54 
Key_World_55 
Key_World_56 
Key_World_57 
Key_World_58 
Key_World_59 
Key_World_60 
Key_World_61 
Key_World_62 
Key_World_63 
Key_World_64 
Key_World_65 
Key_World_66 
Key_World_67 
Key_World_68 
Key_World_69 
Key_World_70 
Key_World_71 
Key_World_72 
Key_World_73 
Key_World_74 
Key_World_75 
Key_World_76 
Key_World_77 
Key_World_78 
Key_World_79 
Key_World_80 
Key_World_81 
Key_World_82 
Key_World_83 
Key_World_84 
Key_World_85 
Key_World_86 
Key_World_87 
Key_World_88 
Key_World_89 
Key_World_90 
Key_World_91 
Key_World_92 
Key_World_93 
Key_World_94 
Key_World_95 
Key_KP0 
Key_KP1 
Key_KP2 
Key_KP3 
Key_KP4 
Key_KP5 
Key_KP6 
Key_KP7 
Key_KP8 
Key_KP9 
Key_KP_Period 
Key_KP_Divide 
Key_KP_Multiply 
Key_KP_Minus 
Key_KP_Plus 
Key_KP_Enter 
Key_KP_Equals 
Key_Up 
Key_Down 
Key_Right 
Key_Left 
Key_Insert 
Key_Home 
Key_End 
Key_PageUp 
Key_PageDown 
Key_F1 
Key_F2 
Key_F3 
Key_F4 
Key_F5 
Key_F6 
Key_F7 
Key_F8 
Key_F9 
Key_F10 
Key_F11 
Key_F12 
Key_F13 
Key_F14 
Key_F15 
Key_NumLock 
Key_CapsLock 
Key_ScrollLock 
Key_RShift 
Key_LShift 
Key_RCtrl 
Key_LCtrl 
Key_RAlt 
Key_LAlt 
Key_RMeta 
Key_LMeta 
Key_LSuper 
Key_RSuper 
Key_Mode 
Key_Compose 
Key_Help 
Key_Print 
Key_SysReq 
Key_Break 
Key_Menu 
Key_Power 
Key_Euro 
Key_Undo 
Key_NumKeys 

Definition at line 126 of file events/types.h.

enum n2l::tKeyMod
 

Enumerator:
KMod_None 
KMod_LShift 
KMod_RShift 
KMod_LCtrl 
KMod_RCtrl 
KMod_LAlt 
KMod_RAlt 
KMod_LMeta 
KMod_RMeta 
KMod_Num 
KMod_Caps 
KMod_Mode 
KMod_Shift 
KMod_Ctrl 
KMod_Alt 
KMod_Meta 
KMod_InCaps 

Definition at line 372 of file events/types.h.

enum n2l::tMouseAxis
 

Lookup for and number of mouse axis.

These values have mostly no meaning, but are included preparing for the day that mouse have three axis somehow. If/when that day comes anything that counts on two axis will break, and so this lookup mostly exists for teh 'MouseAxis_NumMouseAxis' value.

Enumerator:
MouseAxis_X 
MouseAxis_Y 
MouseAxis_NumMouseAxis 

Definition at line 108 of file events/types.h.

enum n2l::tMouseButton
 

Enumerator:
MouseButton_Unknown 
MouseButton_Left 
MouseButton_Middle 
MouseButton_Right 
MouseButton_Up 
MouseButton_Down 
MouseButton_NumMouseButtons 

Definition at line 89 of file events/types.h.

enum n2l::tMusicOption
 

Enumerator:
MusicOpt_None 
MusicOpt_Loop 
MusicOpt_NumMusicOptions 

Definition at line 34 of file audio/types.h.

enum n2l::tSDLSubSystemInitFlag
 

Enumerator:
SDLSubSystemInitFlag_Timer 
SDLSubSystemInitFlag_Audio 
SDLSubSystemInitFlag_Video 
SDLSubSystemInitFlag_Joystick 
SDLSubSystemInitFlag_Cdrom 

Definition at line 39 of file subSystemManager.h.

enum n2l::tVfsPermission
 

Enumerator:
VfsPermission_NoneOrUnknown 
VfsPermission_Readable 
VfsPermission_Writeable 
VfsPermission_Executable 

Definition at line 66 of file vfsTypes.h.


Function Documentation

const tBezier33f n2l::asBezier33f const cDynVar &  iDef  ) 
 

Definition at line 45 of file dynVarUtils.cpp.

References asVector3f().

Referenced by n2l::cGuiSEFollowB3Curve::load().

const tString n2l::asBinaryMaskString const tUint  i_mask  ) 
 

const tString n2l::asBinaryMaskString const tUint32  iMask  ) 
 

Definition at line 104 of file babelFish.cpp.

References _n2l::asArbitraryBinaryMaskString().

Referenced by n2l::cSurfaceProperties::asString(), and n2l::cPixelFormat::asString().

const tDouble n2l::asDouble const tString iNum  ) 
 

Definition at line 167 of file babelFish.cpp.

References n2l::cString::c_str(), and n2l::cString::size().

const tFloat n2l::asFloat const tString iNum  ) 
 

Definition at line 159 of file babelFish.cpp.

References n2l::cString::c_str(), and n2l::cString::size().

Referenced by n2l::cDynVar::asNumeric(), n2l::cDynVar::eval(), n2l::cRWavefrontModel::load(), n2l::cRK3DRawAsciiModel::load(), and n2l::cDynVar::operator const tFloat().

const tMatrix44f n2l::asMatrix44f const cDynVar &  iDef  ) 
 

Definition at line 68 of file dynVarUtils.cpp.

References asMatrix44f().

tMatrix44f & n2l::asMatrix44f tMatrix44f oMat,
const cDynVar &  iDef
 

Definition at line 52 of file dynVarUtils.cpp.

References n2l::cMatrix44< TComponent >::identity(), and n2l::cDynVar::isArray().

Referenced by asMatrix44f().

const tUint n2l::asSint const tString iNum  )  [inline]
 

Definition at line 55 of file babelFish.h.

References asSint32().

Referenced by n2l::cGuiTextInput::load().

const tSint16 n2l::asSint16 const tString iNum  ) 
 

Definition at line 135 of file babelFish.cpp.

References n2l::cString::c_str(), and n2l::cString::size().

const tSint32 n2l::asSint32 const tString iNum  ) 
 

Definition at line 119 of file babelFish.cpp.

References n2l::cString::c_str(), and n2l::cString::size().

Referenced by n2l::cDynVar::asNumeric(), asSint(), n2l::cDynVar::eval(), and n2l::cDynVar::operator const tSint().

const tSint8 n2l::asSint8 const tString iNum  ) 
 

Definition at line 151 of file babelFish.cpp.

References n2l::cString::c_str(), and n2l::cString::size().

const tString n2l::asString const tBool  iBool  ) 
 

Definition at line 96 of file babelFish.cpp.

const tString n2l::asString const tDouble  iNum,
const tUint  iPrecision
 

Definition at line 58 of file babelFish.cpp.

References MaxDoubleCharLength.

const tString n2l::asString const tSint32  iNum  ) 
 

Definition at line 49 of file babelFish.cpp.

References MaxInt32CharLength.

const tString n2l::asString const tUint32  iNum  ) 
 

Definition at line 40 of file babelFish.cpp.

References MaxInt32CharLength.

Referenced by n2l::cGuiCanvas::add(), n2l::cGuiSlider::alignment(), n2l::cDynVar::anyTypeStr(), n2l::cSurfaceProperties::asString(), n2l::cPixelFormat::asString(), n2l::cJoystick::axis(), n2l::cGuiElement::bindAction(), n2l::cGLTexture::bitsForFormat(), n2l::cGuiElement::broadcastAction(), n2l::cJoystick::button(), n2l::cGuiElement::cGuiElement(), n2l::cAudioMixer::channelVolume(), n2l::cJoystickManager::closeJoystick(), n2l::cRPovRayModel::defaultTexture(), n2l::cVector3< TComponent, TComponentDiff, TMagnitude >::dump(), n2l::cVector2< tFloat, tFloat, tFloat >::dump(), n2l::cRWavefrontModel::dump(), n2l::cRMd2::dump(), n2l::cRectangle3< TComponent, TComponentDiff, TMagnitude >::dump(), n2l::cRectangle2< TComponent, TComponentDiff, TMagnitude >::dump(), n2l::cQuaternion< TComponent >::dump(), n2l::cPlane3< TComponent >::dump(), n2l::cMatrix44< TComponent >::dump(), n2l::cMatrix< TComponent, Rows, Cols >::dump(), n2l::cDynVar::dump(), n2l::cColour::dump(), n2l::cVfsDirectoryInterface::findUniqueName(), n2l::cResourceManager::getReferenceReport(), n2l::cGuiSButtonSelectBox::getValueByIndex(), n2l::cJoystick::hat(), n2l::cJoystick::inverted(), n2l::cVfsStat::isSymLink(), n2l::cJoystickManager::joystickName(), n2l::cJoystickManager::joystickOpened(), n2l::cGuiTextDisplay::lineInfo(), n2l::cRWavefrontModel::load(), n2l::cRPovRayModel::load(), n2l::cRK3DRawAsciiModel::load(), n2l::cColourMod::modType(), n2lGetEnv(), n2l::cJoystickManager::openJoystick(), n2l::cDynVar::operator const tString(), n2l::cConfParsingError::operator tString(), n2l::cVfsStat::readLink(), n2l::cDynVar::serialize(), n2l::cDisplayCommonImp::softDriver(), n2l::cConfParsingErrors::summary(), n2l::cGuiElement::unbindAction(), n2l::cVfsDirectory::unlinkNode(), and vfsGetCWD().

const tUint n2l::asUint const tString iNum  )  [inline]
 

Definition at line 54 of file babelFish.h.

References asUint32().

Referenced by n2l::cGuiElement::load().

const tUint16 n2l::asUint16 const tString iNum  ) 
 

Definition at line 127 of file babelFish.cpp.

References n2l::cString::c_str(), and n2l::cString::size().

const tUint32 n2l::asUint32 const tString iNum  ) 
 

Definition at line 111 of file babelFish.cpp.

References n2l::cString::c_str(), and n2l::cString::size().

Referenced by asUint(), n2l::cRWavefrontModel::load(), and n2l::cRK3DRawAsciiModel::load().

const tUint8 n2l::asUint8 const tString iNum  ) 
 

Definition at line 143 of file babelFish.cpp.

References n2l::cString::c_str(), and n2l::cString::size().

tVector3f & n2l::asVector3f tVector3f oV3,
const cDynVar &  iDef
 

Definition at line 39 of file dynVarUtils.cpp.

References n2l::cVector3< TComponent, TComponentDiff, TMagnitude >::set().

const tVector3f n2l::asVector3f const cDynVar &  iDef  ) 
 

Definition at line 32 of file dynVarUtils.cpp.

Referenced by asBezier33f(), n2l::cRSkyMobile2::load(), and n2l::cGuiSEModelOrbit::load().

const tAudioChannel n2l::Audio_AnyFreeChannel 1  ) 
 

const tAudioChannel n2l::Audio_NoChannel 1  ) 
 

Referenced by n2l::cAudioSource::playing(), n2l::cAudioSource::pos(), and n2l::cAudioSource::stop().

const tFsNodeName n2l::cleanFsPath const tFsNodeName iName  ) 
 

Take a fs path and/or file and return one that is safe for usage with the vfs library.

Namely, remove any ./ ../ references which may be used to access data outside the cwd. This method will also remove any double seperators such as //.

Definition at line 201 of file vfsUtilities.cpp.

References _n2l::AltFsPathSeperatorSymbol, _n2l::cleanPath(), and _n2l::FsPathSeperatorSymbol.

Referenced by getFsNodeType().

const tVfsNodeName n2l::cleanVfsPath const tVfsNodeName iName  ) 
 

Take a Vfs path and/or file and return one that is safe for usage with the vfs library.

Namely, remove any ./ ../ references which may be used to access data outside the vfs root. This method will also remove any double seperators such as //.

Definition at line 195 of file vfsUtilities.cpp.

References _n2l::cleanPath(), and VfsPathSeperatorSymbol.

Referenced by convertFsLiteralNameToVfs(), n2l::cVfsDirectory::copyNode(), n2l::cVfsDirectoryInterface::findUniqueName(), n2l::cVfsDirectory::newDirectoryNode(), and n2l::cVfsDirectory::newFileNode().

const tVfsNodeName n2l::convertFsLiteralNameToVfs const tFsNodeName i_name  ) 
 

Take a fs path and return it as a vfs path to the same resource.

Definition at line 186 of file vfsUtilities.cpp.

References cleanVfsPath(), _n2l::FsPathSeperatorSymbol, substringReplace(), and VfsPathSeperatorSymbol.

Referenced by n2l::cVfsFile::cVfsFile(), and vfsGetHomeDir().

const tFloat n2l::degToRad const tFloat iDeg  )  [inline]
 

Depricated.

Definition at line 34 of file geometry/misc.h.

Referenced by n2lBuildRotationMatrix(), n2l::cRFreeCamera::pitchD(), n2l::cRFreeCamera::rollD(), n2l::cVector3< TComponent, TComponentDiff, TMagnitude >::rotateD(), n2l::cRFreeCamera::rotateD(), and n2l::cRFreeCamera::yawD().

void n2l::delay const tUint  iMSeconds  ) 
 

Note:
This method is deprecated, use n2lDelay instead.

Definition at line 73 of file time.cpp.

Referenced by n2l::cOscillator::wait().

void n2l::explode const tString iStr,
std::vector< tString > &  oTokens,
const char  iSplitChar = ',',
const char  iEscapeChar = '\\',
const char  iQuoteChar = '\0',
const tBool  iStripEscapes = true
 

void n2l::explode const tString i_str,
vector< tString > &  o_tokens,
const char  i_splitChar,
const char  i_escapeChar,
const char  i_quoteChar,
const tBool  iStripEscapes
 

Definition at line 117 of file stringUtilities.cpp.

References n2l::cString::begin(), and n2l::cString::end().

Referenced by _n2l::cleanPath(), n2l::cConfiguration::decodeBuffer(), n2l::cRWavefrontModel::load(), n2l::cRK3DRawAsciiModel::load(), splitVfsPathBlocks(), and vfsGetExecBinaryDir().

const tString::size_type n2l::findUnescaped const tString i_str,
const char  i_char,
const tString::size_type  i_sPos,
const char  i_escapeChar,
const char  i_quoteChar
 

Definition at line 180 of file stringUtilities.cpp.

References n2l::cString::npos, and n2l::cString::size().

Referenced by n2l::cConfiguration::decodeBuffer().

const tString n2l::getEscapedString const tString iStr,
const tString iTargetChars = "\"",
const char  iEscapeChar = '\\'
 

Get an escaped copy of a string.

The provided string will be copied and returned with the target characters escaped by the provided escape character. The escape character will also be escaped if it appears in the original string.

Note:
In effect, the escape character itself is always considered to be in the target characters.
Parameters:
i_targetChars A string containing a list of characters to be escaped. Treated as a string of characters. No double character checking takes place, so characters put into the targetChars string twice will be double escaped (resulting in an escaped escape character, and the original target being untouched)
i_escapeChar The character to use as an escape.
i_str The string to copy and escape. This string is not mutated.

Definition at line 34 of file stringUtilities.cpp.

References n2l::cString::begin(), n2l::cString::end(), and n2l::cString::size().

Referenced by implode().

void n2l::getFsNodeDump const tFsNodeName i_name,
tString o_buffer
 

Definition at line 146 of file vfsUtilities.cpp.

References n2l::cString::append(), n2l::cString::c_str(), n2l::cString::clear(), getFsNodeSize(), and n2l::cString::reserve().

Referenced by n2l::cVfsFile::getBuffer().

const tUint n2l::getFsNodePermissions const tFsNodeName  ) 
 

Definition at line 106 of file vfsUtilities.cpp.

const tFsFileSize n2l::getFsNodeSize const tFsNodeName i_name  ) 
 

Definition at line 112 of file vfsUtilities.cpp.

References n2l::cString::c_str().

Referenced by getFsNodeDump(), and n2l::cVfsFile::size().

const tFsNodeType n2l::getFsNodeType const tFsNodeName iName  ) 
 

Definition at line 86 of file vfsUtilities.cpp.

References n2l::cString::c_str(), cleanFsPath(), FsNodeType_Directory, FsNodeType_File, and FsNodeType_Unknown.

const tUint n2l::getTicks  ) 
 

Note:
This method is deprecated, use n2lGetTicks instead.

Definition at line 53 of file time.cpp.

Referenced by n2l::cOscillator::isTime(), n2l::cOscillator::sync(), n2l::cOscillator::timeLeft(), and n2l::cOscillator::triggered().

const tUint n2l::getVfsNodePermissions const tVfsNodeName iName  ) 
 

Definition at line 100 of file vfsUtilities.cpp.

const tBool n2l::getVfsStat const tVfsNodeName iName  ) 
 

const tString n2l::implode const std::vector< tString > &  oTokens,
const char  iSplitChar = ',',
const char  iEscapeChar = '\\',
const char  iQuoteChars = '\0'
 

const tString n2l::implode const vector< tString > &  o_tokens,
const char  i_splitChar,
const char  i_escapeChar,
const char  i_quoteChar
 

Definition at line 91 of file stringUtilities.cpp.

References n2l::cString::begin(), and getEscapedString().

Referenced by _n2l::cleanPath().

const bool n2l::inArray const tString iStr,
const std::vector< tString > &  iArray
 

const bool n2l::inArray const tString iStr,
const vector< tString > &  iArray
 

Definition at line 168 of file stringUtilities.cpp.

const bool n2l::isNumericStr const tString iString,
const bool  iDecimalsAllowed
 

Definition at line 197 of file babelFish.cpp.

References n2l::cString::begin(), n2l::cString::empty(), and n2l::cString::end().

Referenced by n2l::cDynVar::eval().

template<typename TType>
const TType& n2l::n2l_max const TType &  iA,
const TType &  iB
 

Note:
This method is deprecated, use n2lMax instead

Definition at line 59 of file base/misc.h.

Referenced by n2l::cRK3DRawAsciiModel::centerAroundOrigin(), n2l::cAudioMixer::musicVolume(), and n2l::cGuiProgressBar::value().

template<typename TType>
const TType& n2l::n2l_min const TType &  iA,
const TType &  iB
 

Note:
This method is deprecated, use n2lMin instead

Definition at line 40 of file base/misc.h.

Referenced by n2l::cRK3DRawAsciiModel::centerAroundOrigin(), n2l::cGuiSlider::dimensionChanged(), n2l::cTextureFont::draw(), n2l::cAudioMixer::musicVolume(), n2l::cRWavefrontModel::normalizeDimensions(), and n2l::cGuiProgressBar::value().

template<typename TType>
void n2l::n2l_swap TType &  iA,
TType &  iB
 

Note:
This method is deprecated, use n2lSwap instead

Definition at line 78 of file base/misc.h.

Referenced by n2l::cGuiFill::draw().

void n2l::n2lBuildRotationMatrix tMatrix44f oMatrix,
const tFloat iTheta,
const tVector3f iAxis
 

void n2l::n2lBuildRotationMatrix cMatrix< tFloat, 4, 4 > &  oMatrix,
const tFloat iTheta,
const tVector3f iAxis
 

Definition at line 33 of file matrixUtilities.cpp.

References n2l::cMatrix< TComponent, Rows, Cols >::data(), degToRad(), n2l::cMatrix< TComponent, Rows, Cols >::identity(), n2l::cVector3< TComponent, TComponentDiff, TMagnitude >::x(), n2l::cVector3< TComponent, TComponentDiff, TMagnitude >::y(), and n2l::cVector3< TComponent, TComponentDiff, TMagnitude >::z().

void n2l::n2lDebug const tString iText,
const tBool  iNewLine
 

Definition at line 60 of file misc.cpp.

Referenced by n2l::cResourceManager::clearCachedResource(), n2l::cResourceManager::clearUnusedCache(), n2l::cResourceManager::get(), n2l::cResourceManager::getGuiElement(), n2l::cResourceManager::getVfsNode(), and n2l::cResourceManager::refreshTextures().

const tFloat n2l::n2lDegToRad const tFloat iDeg  )  [inline]
 

Definition at line 37 of file geometry/misc.h.

Referenced by n2l::cMatrix44< TComponent >::eulerRotD().

void n2l::n2lDelay const tUint  iMSeconds  ) 
 

Definition at line 59 of file time.cpp.

Referenced by n2l::cGuiApp::run().

const tString n2l::n2lGetEnv const tString iName  ) 
 

Definition at line 64 of file system.cpp.

References asString(), and n2l::cString::c_str().

Referenced by vfsGetExecBinaryDir().

const tUint n2l::n2lGetTicks  ) 
 

Definition at line 47 of file time.cpp.

Referenced by n2l::cParticleSystem::draw(), n2l::cResourceManager::get(), n2l::cResourceManager::getGuiElement(), n2l::cResourceManager::getVfsNode(), n2l::cGuiApp::run(), and n2l::cParticleSystem::update().

template<class TClass>
const cAutoPtr<const TClass> n2l::n2lgui_loadOrBuild const cDynVar &  iVal  ) 
 

Interpret a dynVar value and either load it from the resource manager if it is a string, or build the resource from the value if it is an array (definition).

Definition at line 39 of file guiUtilities.h.

References n2l::cDynVar::isString().

void n2l::n2lGuiShutdown  ) 
 

Definition at line 126 of file gui/startup.cpp.

void n2l::n2lGuiStartup  ) 
 

Definition at line 33 of file gui/startup.cpp.

References n2l::cGuiACFactory::current(), n2l::cGuiSEFactory::current(), n2l::cGuiFactory::current(), n2l::cGuiModelView::loadNew(), n2l::cGuiSprite::loadNew(), n2l::cGuiACFactory::registerLoader(), n2l::cGuiSEFactory::registerLoader(), and n2l::cGuiFactory::registerLoader().

template<typename TType>
const TType& n2l::n2lMax const TType &  iA,
const TType &  iB
 

Definition at line 67 of file base/misc.h.

Referenced by n2l::cRVisualTriMesh::boundingRadius(), n2l::cAudioMixer::channelVolume(), n2l::cColour::clampToZeroOne(), n2l::cRVisualTriMesh::dimensions(), n2l::cPEmitter::frequency(), n2l::cRSkyBox::load(), n2l::cGuiSound::lrBias(), n2l::cVector3< TComponent, TComponentDiff, TMagnitude >::maxComp(), n2l::cVector2< tFloat, tFloat, tFloat >::maxComp(), n2l::cVector3< TComponent, TComponentDiff, TMagnitude >::maxCompMag(), n2l::cAudioChunk::play(), n2l::cAudioSource::pos(), n2l::cRVisualTriMesh::scaledBoundingRadius(), n2l::cMaterial::shininess(), n2l::cGuiSEAutoscroll::textToScroll(), n2l::cParticle::update(), and n2l::cGuiSound::volume().

const tFloat n2l::n2lMaxMag const tFloat iA,
const tFloat iB
[inline]
 

Take the maximum magintude of A and B keeping the sign of A.

Definition at line 52 of file geometry/misc.h.

template<typename TType>
const TType& n2l::n2lMin const TType &  iA,
const TType &  iB
 

Definition at line 48 of file base/misc.h.

Referenced by n2l::cGuiSEModelOrbit::actOn(), n2l::cGuiSEFollowB3Curve::actOn(), n2l::cGuiSEColourTrans::actOn(), n2l::cGuiSEAutoscroll::actOn(), n2l::cTextureFont::calcSize(), n2l::cAudioMixer::channelVolume(), n2l::cColour::clampToZeroOne(), n2l::cRVisualTriMesh::dimensions(), n2l::cPEmitter::frequency(), n2l::cMatrix< TComponent, Rows, Cols >::identity(), n2l::cGuiTextDisplay::lineOffset(), n2l::cGuiSound::lrBias(), n2l::cAudioChunk::play(), n2l::cAudioChunk::playAtPos(), n2l::cMaterial::shininess(), and n2l::cGuiSound::volume().

const tFloat n2l::n2lMinMag const tFloat iA,
const tFloat iB
[inline]
 

Take the minimum magintude of A and B keeping the sign of A.

Definition at line 42 of file geometry/misc.h.

void n2l::n2lPreciseDelay const tUint  iMSeconds  ) 
 

Will sleep as long as possible (given the system granularity) and busywait any remaining time.

Definition at line 65 of file time.cpp.

const tUID n2l::n2lProcessGID  ) 
 

Definition at line 30 of file system.cpp.

const tUID n2l::n2lProcessUID  ) 
 

Definition at line 20 of file system.cpp.

const tFloat n2l::n2lRadToDeg const tFloat iRad  )  [inline]
 

Definition at line 38 of file geometry/misc.h.

const tSint n2l::n2lRandom const tSint  iOutOf  ) 
 

Definition at line 46 of file misc.cpp.

Referenced by n2l::cPParticleSpec::newParticle(), and n2l::cPEmitter::updateInto().

const tFloat n2l::n2lRandomPCent  ) 
 

Definition at line 53 of file misc.cpp.

const tBool n2l::n2lSetEnv const tString iName,
const tString iValue
 

Definition at line 40 of file system.cpp.

References n2l::cString::c_str().

Referenced by n2l::cAudioMixer::openAudio().

void n2l::n2lShutdown  ) 
 

Definition at line 46 of file base/startup.cpp.

void n2l::n2lStartup  ) 
 

Definition at line 36 of file base/startup.cpp.

template<typename TType>
void n2l::n2lSwap TType &  iA,
TType &  iB
 

Definition at line 87 of file base/misc.h.

void n2l::n2lTimerShutdown  ) 
 

Definition at line 40 of file timing/startup.cpp.

References releaseSDL().

void n2l::n2lTimerStartup  ) 
 

Definition at line 33 of file timing/startup.cpp.

References requireSDL().

const tBool n2l::n2lUnsetEnv const tString iName  ) 
 

Definition at line 52 of file system.cpp.

References n2l::cString::c_str().

Referenced by n2l::cAudioMixer::openAudio().

const cString n2l::operator+ const cString::tChar *const   iStrA,
const cString &  iStrB
[inline]
 

Definition at line 147 of file cString.h.

std::ostream& n2l::operator<< std::ostream &  ioStream,
const cDynVar &  iVar
 

Add a cDynVar to an ostream.

This operator overload will automatically cast the value of iVar to string, and add that string to the ostream.

ostream& n2l::operator<< ostream &  ioStream,
const cDynVar &  iVar
 

Definition at line 1206 of file cDynVar.cpp.

std::ostream& n2l::operator<< std::ostream &  ioStream,
const cString &  iVar
[inline]
 

Definition at line 149 of file cString.h.

References n2l::cString::c_str().

const tString & n2l::ordinalSuffix const tUint iNum  ) 
 

Definition at line 174 of file babelFish.cpp.

const tFloat n2l::radToDeg const tFloat iRad  )  [inline]
 

Definition at line 35 of file geometry/misc.h.

Referenced by n2l::cVector3< TComponent, TComponentDiff, TMagnitude >::anglefD().

const tSint n2l::random const tSint  iOutOf = 0  ) 
 

Note:
This method is deprecated, use n2lRandom instead

Definition at line 38 of file misc.cpp.

Referenced by n2l::cLineEmitter::updateInto().

void n2l::releaseSDL  ) 
 

Definition at line 144 of file subSystemManager.cpp.

References _n2l::getSDLInitReferenceCountPtr().

Referenced by n2lTimerShutdown(), releaseSDLNet(), releaseSDLSubSystem(), releaseSDLTTF(), and shutdownTimer().

void n2l::releaseSDLNet  ) 
 

Definition at line 107 of file subSystemManager.cpp.

References _n2l::getSDLNetInitReferenceCountPtr(), and releaseSDL().

void n2l::releaseSDLSubSystem const tSDLSubSystemInitFlag  i_subSystemFlag  ) 
 

Definition at line 62 of file subSystemManager.cpp.

References _n2l::getSDLSubSystemReferenceCountPtr(), and releaseSDL().

Referenced by n2l::cAudioMixer::closeAudio(), n2l::cJoystick::~cJoystick(), n2l::cJoystickManager::~cJoystickManager(), n2l::cMutex::~cMutex(), and n2l::cSurfaceCommonImp::~cSurfaceCommonImp().

void n2l::releaseSDLTTF  ) 
 

Definition at line 185 of file subSystemManager.cpp.

References _n2l::getSDLTTFInitReferenceCountPtr(), and releaseSDL().

Referenced by n2l::cTTFSurfaceFactory::~cTTFSurfaceFactory().

void n2l::requireSDL  ) 
 

Definition at line 125 of file subSystemManager.cpp.

References _n2l::getSDLInitReferenceCountPtr().

Referenced by n2lTimerStartup(), requireSDLNet(), requireSDLSubSystem(), requireSDLTTF(), and startupTimer().

void n2l::requireSDLNet  ) 
 

Definition at line 85 of file subSystemManager.cpp.

References _n2l::getSDLNetInitReferenceCountPtr(), and requireSDL().

void n2l::requireSDLSubSystem const tSDLSubSystemInitFlag  i_subSystemFlag  ) 
 

Definition at line 38 of file subSystemManager.cpp.

References _n2l::getSDLSubSystemReferenceCountPtr(), and requireSDL().

Referenced by n2l::cMutex::cMutex(), n2l::cSurfaceCommonImp::cSurfaceCommonImp(), and n2l::cAudioMixer::openAudio().

void n2l::requireSDLTTF  ) 
 

Definition at line 163 of file subSystemManager.cpp.

References _n2l::getSDLTTFInitReferenceCountPtr(), and requireSDL().

Referenced by n2l::cTTFSurfaceFactory::cTTFSurfaceFactory().

const tString::size_type n2l::rfindUnescaped const tString i_str,
const char  i_char,
const tString::size_type  i_sPos,
const char  i_escapeChar,
const char  i_quoteChar
 

Definition at line 202 of file stringUtilities.cpp.

References n2l::cString::npos, and n2l::cString::size().

void n2l::shutdownN2LTimer  ) 
 

void n2l::shutdownTimer  ) 
 

Definition at line 41 of file time.cpp.

References releaseSDL().

const tString & n2l::simpleGuessVfsFileType const tVfsNodeName iName  ) 
 

Try to guess from a files name what it contains.

This method will not open or examine a file to try to determine its type. Normally it's extension will be checked, if it is not recognized a value of VfsFileType_Unknown will be returned.

Parameters:
iName The VfsFilename to attempt to guess the type of.
Returns:
a VfsFileType_* string constant representing the guessed file type.

Definition at line 258 of file vfsUtilities.cpp.

References n2l::cString::find(), n2l::cString::find_last_of(), n2l::cString::npos, n2l::cString::size(), n2l::cString::substr(), VfsFileType_BMP, VfsFileType_BZIP2, VfsFileType_GIF, VfsFileType_GZIP, VfsFileType_JPEG, VfsFileType_MP3, VfsFileType_OGG, VfsFileType_PCX, VfsFileType_PNG, VfsFileType_TAR, VfsFileType_TGA, VfsFileType_TIFF, VfsFileType_Unknown, VfsFileType_WAV, and VfsFileType_ZIP.

const std::vector< tFsNodeName > n2l::splitVfsPathBlocks const tVfsNodeName i_name  ) 
 

Definition at line 208 of file vfsUtilities.cpp.

References explode(), and VfsPathSeperatorSymbol.

Referenced by n2l::cVfsFile::cVfsFile().

void n2l::startupN2LTimer  ) 
 

void n2l::startupTimer  ) 
 

Definition at line 34 of file time.cpp.

References requireSDL().

const tVfsNodeName n2l::stripFrontLiteralVfsName const tVfsNodeName iName,
tVfsNodeName oStrippedName
 

Take a vfs path and remove the first element, returning both the first element and the remaining vfs path.

Warning:
This method does no cleaning of the passed name, therefore any dangerous paths, such as ../fish/ will return ".." and "fish" externally accessable paths run through this method should be sent through cleanVfsPath() first.
Parameters:
iName The full vfs path to strip from eg. cat/dog/mouse
oStrippedName The first element removed eg. "cat" from the example above
Returns:
The remaining path eg. "dog/mouse" from the example above

Definition at line 225 of file vfsUtilities.cpp.

References n2l::cString::find(), n2l::cString::find_first_not_of(), n2l::cString::npos, n2l::cString::size(), n2l::cString::substr(), and VfsPathSeperatorSymbol.

Referenced by n2l::cVfsDirectory::find().

const tString n2l::strToLower const tString iStr  ) 
 

Definition at line 266 of file stringUtilities.cpp.

References n2l::cString::size().

Referenced by n2l::cConfiguration::find(), n2l::cGuiFactory::load(), n2l::cGuiACIfProp::load(), n2l::cGuiACIf::load(), n2l::cEventTypeLookups::lookupTypeByName(), n2l::cGuiSEFactory::registerLoader(), n2l::cGuiFactory::registerLoader(), and n2l::cGuiACFactory::registerLoader().

const tString n2l::strToUpper const tString iStr  ) 
 

Definition at line 255 of file stringUtilities.cpp.

References n2l::cString::size().

const tString n2l::substringReplace const tString i_from,
const tString i_to,
const tString i_hayStack
 

Definition at line 225 of file stringUtilities.cpp.

References n2l::cString::erase(), n2l::cString::find(), n2l::cString::npos, n2l::cString::replace(), and n2l::cString::size().

Referenced by convertFsLiteralNameToVfs(), n2l::cConfiguration::decodeBuffer(), and n2l::cGuiTextDisplay::text().

const tString n2l::trimmed const tString iStr  ) 
 

Definition at line 245 of file stringUtilities.cpp.

References n2l::cString::find_first_not_of(), n2l::cString::find_last_not_of(), n2l::cString::npos, and n2l::cString::substr().

Referenced by n2l::cConfiguration::decodeBuffer(), and n2l::cRK3DRawAsciiModel::load().

const tString n2l::unescapedString const tString iStr,
const char  iEscapeChar,
const char  iQuoteChar
 

Definition at line 67 of file stringUtilities.cpp.

References n2l::cString::reserve(), and n2l::cString::size().

Referenced by n2l::cConfiguration::decodeBuffer().

const tVfsNodeName n2l::vfsGetCWD  ) 
 

Definition at line 367 of file vfsUtilities.cpp.

References asString().

Referenced by _n2l::cleanPath().

const tVfsNodeName n2l::vfsGetExecBinaryDir const tString iArgV0  ) 
 

Discover the location on the file system of the running program.

This method will search the current PATH for a binary of the same name passed in iArgV0. If iArgV0 contains a path the existance of the file will be confirmed, or followed if it is a symlink, and so-on and so-forth until a final location can be found. If no such appropriate path can be found then an empty string will be returned;

Warning:
This method may return nothing if the binary no longer exists on the filesystem, has been renamed or somehow isn't in the path any longer.

Definition at line 427 of file vfsUtilities.cpp.

References n2l::cAutoPtr< TPtr >::as(), n2l::cString::c_str(), n2l::cString::empty(), explode(), n2l::cAutoPtr< TPtr >::isSet(), n2lGetEnv(), and n2l::cString::size().

const tVfsNodeName n2l::vfsGetHomeDir  ) 
 

Retreive the fsPath of the users's home directory.

Definition at line 392 of file vfsUtilities.cpp.

References convertFsLiteralNameToVfs().

void n2l::vfsNodeFileWithHeader const cVfsNodeInterface &  iNode,
const tString iHeader,
cDynVar &  oDef
 

Definition at line 344 of file vfsUtilities.cpp.

References n2l::cVfsNodeInterface::buffer(), n2l::cString::c_str(), n2l::cVfsNodeInterface::firstLine(), n2l::cVfsNodeInterface::likeFile(), n2l::cString::size(), and n2l::cDynVar::unserialize().

const tUint n2l::vfsNodeFileWithHeader const cVfsNodeInterface &  iNode,
const tString iHeader
 

Validate that a node is a file, and that it has a specific header.

If the node is valid the length offset of the first character after the header line is returned.

Note:
This method throws a bad data use exception describing why it fails if not successful.

This method is identical to its overloaded counterpart, except that it does not copy the vfs buffer into the provided buffer variable. This is done knowing that the vfs node will keep a cached copy, and that the app probably doesn't want to copy all the data, just to save a couple lines of redundent code by doing these tests themselves.

Definition at line 324 of file vfsUtilities.cpp.

References n2l::cVfsNodeInterface::firstLine(), n2l::cVfsNodeInterface::likeFile(), n2l::cVfsNodeInterface::size(), and n2l::cString::size().

const tUint n2l::vfsNodeFileWithHeader const cVfsNodeInterface &  iNode,
const tString iHeader,
tVfsFileBuffer oBuffer
 

Validate that a node is a file, and that it has a specific header.

If the node is valid, the contents of the file are placed in the buffer, and the length offset of the first character after the header line is returned.

Note:
This method throws a bad data use exception describing why it fails if not successful.

Definition at line 303 of file vfsUtilities.cpp.

References n2l::cString::clear(), n2l::cVfsNodeInterface::firstLine(), n2l::cVfsNodeInterface::getBuffer(), n2l::cVfsNodeInterface::likeFile(), and n2l::cString::size().

Referenced by n2l::cRVisualTriMesh::load(), n2l::cRSkyMobile2::load(), n2l::cRSkyMobile::load(), n2l::cRSkyBox::load(), n2l::cRPerspectiveProjection::load(), n2l::cRFreeCamera::load(), n2l::cPParticleSpec::load(), n2l::cPEmitter::load(), n2l::cGuiTextInput::load(), n2l::cGuiSound::load(), n2l::cGuiSEColourTrans::load(), and n2l::cColourMod::load().

const tString n2l::vfsPermissionsAsString const tUint iPerms  ) 
 

Definition at line 76 of file vfsUtilities.cpp.

References VfsPermission_Executable, VfsPermission_Readable, and VfsPermission_Writeable.

Referenced by n2l::cVfsDirectoryInterface::dump().


Variable Documentation

const tFloat n2l::JoystickAxisInverseMagBound = -32768.0f
 

Definition at line 7 of file events/constants.cpp.

Referenced by n2l::cJoystick::axis().

const tFloat n2l::JoystickAxisMagBound = 32768.0f
 

Definition at line 6 of file events/constants.cpp.

Referenced by n2l::cJoystick::axis().

const tUint n2l::PlatformTimerGranularity = TIMER_RESOLUTION
 

Definition at line 31 of file timing/constants.cpp.

Referenced by n2l::cOscillator::wait().

const tUint n2l::ThreadModeChangeLatency = 100
 

Definition at line 32 of file timing/constants.cpp.

const tString n2l::VfsFileType_BMP = "image/bmp"
 

Definition at line 32 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType(), and n2l::cSurface::supportedFileFormats().

const tString n2l::VfsFileType_BZIP2 = "application/x-bzip2"
 

Definition at line 46 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType().

const tString n2l::VfsFileType_GIF = "image/gif"
 

Definition at line 33 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType().

const tString n2l::VfsFileType_GZIP = "application/x-gzip"
 

Definition at line 44 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType().

const tString n2l::VfsFileType_JPEG = "image/jpeg"
 

Definition at line 34 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType(), and n2l::cSurface::supportedFileFormats().

const tString n2l::VfsFileType_K3DRaw = "model/k3d-ascii"
 

Definition at line 51 of file vfsFileTypes.cpp.

Referenced by n2l::cRK3DRawAsciiModel::vfsType().

const tString n2l::VfsFileType_MD2 = "model/quake2-md2"
 

Definition at line 53 of file vfsFileTypes.cpp.

Referenced by n2l::cRMd2::vfsType().

const tString n2l::VfsFileType_MP3 = "audio/mp3"
 

Definition at line 41 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType().

const tString n2l::VfsFileType_OGG = "audio/ogg"
 

Definition at line 42 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType().

const tString n2l::VfsFileType_PCX = "image/pcx"
 

Definition at line 38 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType(), and n2l::cSurface::supportedFileFormats().

const tString n2l::VfsFileType_PNG = "image/png"
 

Definition at line 35 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType(), and n2l::cSurface::supportedFileFormats().

const tString n2l::VfsFileType_POVRay = "model/povray-ascii"
 

Definition at line 54 of file vfsFileTypes.cpp.

Referenced by n2l::cRPovRayModel::vfsType().

const tString n2l::VfsFileType_TAR = "application/x-tar"
 

Definition at line 45 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType().

const tString n2l::VfsFileType_TGA = "image/tga"
 

Definition at line 37 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType().

const tString n2l::VfsFileType_TIFF = "image/tiff"
 

Definition at line 36 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType().

const tString n2l::VfsFileType_TTF = "font/true-type"
 

Definition at line 49 of file vfsFileTypes.cpp.

const tString n2l::VfsFileType_Unknown = "application/octet-stream"
 

Definition at line 30 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType().

const tString n2l::VfsFileType_WAV = "audio/wav"
 

Definition at line 40 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType().

const tString n2l::VfsFileType_Wavefront = "model/wavefront-obj"
 

Definition at line 52 of file vfsFileTypes.cpp.

Referenced by n2l::cRWavefrontModel::vfsType().

const tString n2l::VfsFileType_ZIP = "application/zip"
 

Definition at line 47 of file vfsFileTypes.cpp.

Referenced by simpleGuessVfsFileType().

const char n2l::VfsPathSeperatorSymbol = '/'
 

Definition at line 30 of file vfsConstants.cpp.

Referenced by cleanVfsPath(), convertFsLiteralNameToVfs(), n2l::cVfsDirectory::copyNode(), n2l::cVfsDirectoryInterface::findUniqueName(), n2l::cVfsDirectory::newDirectoryNode(), n2l::cVfsDirectory::newFileNode(), splitVfsPathBlocks(), and stripFrontLiteralVfsName().

©2013 Aaron Cameron