Epee Engine  0.40
The Epee Engine is an open source cross platform graphics engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | List of all members
EpeeEngine Class Reference

#include <EpeeEngine.h>

Public Member Functions

 EpeeEngine ()
 
 EpeeEngine (std::vector< FileLookUp > filetable)
 
 ~EpeeEngine ()
 
bool EventProcessing (SDL_Event *_event)
 
bool SetUp (unsigned int Screen_Width, unsigned int Screen_Heigth, bool FullSreenMod=false, std::string _WindowName="Your App Name Here", bool _Resize=false, unsigned int _fps=60, unsigned int _BitDepthOfScreen=16, bool Anyformat=false)
 
bool SetUp (std::vector< FileLookUp > filetable, unsigned int Screen_Width, unsigned int Screen_Heigth, bool FullSreenMode=false, const std::string &_WindowName="Your App Name Here", bool _Resize=false, unsigned int _fps=60, unsigned int _BitDepthOfScreen=16, bool Anyformat=false)
 
bool RenderSeen (bool _UpdateScreenNow=false)
 
bool UpdateScreen ()
 
imageCreateImageFromList (const std::string &_symbol, const std::string &_ImageName, int _x, int _y, int _z)
 
bool RemoveIteamFromRendableList (const std::string &_card)
 
bool SetNumberOfMixingChannels (int _NumberOfChannels)
 
SoundFindSound (const std::string &_name)
 
SoundCreateSound (const std::string &_GroupName, const std::string &_FileName, int _Channel=0, int _NumberOfTimesToLoop=0, int _Volume=MIX_MAX_VOLUME)
 
bool DestroySound (const std::string &_name)
 
bool PlaySoundNow (Sound *_pSound)
 
bool SetAndPlayBackGroundMusic (const std::string &_NameOfAudio, int _NumberOfTimesToLoop, int _Volume=MIX_MAX_VOLUME, int _ms=0)
 
bool StopBackGroundMusic (int _ms=0)
 
bool FadeInSound (Sound *_pSound, int _ms)
 
bool FadeOutSound (Sound *_pSound, int _ms)
 
bool FadeOutSound (int _Channel, int _ms)
 
bool StopSoundNow (int _Channel)
 
bool StopSoundNow (Sound *_pSound)
 
bool IsSoundPlaying (Sound *_pSound)
 
bool IsBackGoundMusicPlaying ()
 
bool LoadConfigurationFile (const std::string &_FileName)
 
float GetTimeSinceSetup ()
 
void SleepDelay (Uint32 _millisecounds)
 
textBoxCreateTextBox (const std::string &_Name, int _x, int _y, int _z, const std::string &_TextBoxMessage=" ", const std::string &_AddtoCurrentRenderlist="Current", unsigned int _height=-1, unsigned int _width=-1, const std::string &_Font=True_Type_Font_Defalut, int _FontPoint=18, unsigned int _red=255, unsigned int _blue=255, unsigned int _green=255, const std::string &_FontPath=True_Type_Font_Location)
 
imageCreateImage (const std::string &_fileName, const std::string &_Name, int _x, int _y, int _z, const std::string &_AddtoCurrentRenderlist="Current", bool _Transparency=false)
 
AnimationCreateAnimation (const std::string &_fileName, const std::string &_Name, int _x, int _y, int _z, int _NumberOfFrames, int _fps, int _StartFrame=0, int _Loop=1, int _NumberOfRowsOfFrames=1, bool _Transparency=false, bool _StartNow=true, const std::string &_AddtoCurrentRenderlist="Current")
 
AnimationScriptCreateAnimationScript (const std::string &_Name, EEWidget *_AnimationSprocket, PlayScrtipFuntionPointer *_ScrtipFuntionPointer, int _z, int _TotalNumberOfFrames, int _fps=30, int _StartFrame=0, int _Loop=1, bool _StartNow=true, const std::string &_AddtoCurrentRenderlist="Current")
 
ButtonTBCreateButtonTB (const std::string &_ButtonName, int _Buttonx, int _Buttony, int _Buttonz, const std::string &_ButtonText, bool _SButtonactive=true, const std::string &_AddtoCurrentRenderlist="Current", unsigned int _ButtonTB_height=30, unsigned int _ButtonTB_width=100, const std::string &_ButtonTB_Font=True_Type_Font_Defalut, int _ButtonTB_FontPoint=18, unsigned int _ButtonTB_red=255, unsigned int _ButtonTB_blue=255, unsigned int _ButtonTB_green=255, const std::string &_ButtonFontPath=True_Type_Font_Location)
 
ButtonCreateButton (const std::string &_localfileName, const std::string &_localName, int _localx, int _localy, int _localz, bool _Transparency=false, bool _localactive=true, const std::string &_AddtoCurrentRenderlist="Current")
 
ButtonCreateButton (const std::string &_localName, int _localx, int _localy, int _localz, int _height, int _width, bool _Transparency=false, bool _localactive=true, const std::string &_AddtoCurrentRenderlist="Current")
 
EEWidgetWasAButtonClicked (int _x, int _y)
 
textBoxFindTextBox (const std::string &_name)
 
ButtonFindButton (const std::string &_name)
 
ButtonTBFindButtonTB (const std::string &_name)
 
imageFindImage (const std::string &_name)
 
AnimationFindAnimation (const std::string &_name)
 
imageCloneImage (image *_imageToClone, const std::string &_nameOfImage, const std::string &_RenderList="Current", int _x=-1, int _y=-1, int _z=-1)
 
AnimationCloneAnimation (Animation *_imageToClone, const std::string &_nameOfAnimation, const std::string &_RenderList, int _x=-1, int _y=-1, int _z=-1)
 
textBoxCloneTextBox (textBox *_textBoxToClone, const std::string &_nameOfImage, const std::string &_RenderList="Current", int _x=-1, int _y=-1, int _z=-1)
 
bool DestroySprocket (const std::string &_name)
 
EEWidgetFindEEWidget (const std::string &_name, const std::string &_renderlist="Current")
 
bool ChangeSprocketZ (EEWidget *_SprocketToChange, int _newZ, RenderList *_list=NULL)
 
int GetFps ()
 
bool SetFps (int _fps)
 
bool IsFoucsOnTextBox ()
 
std::string GetCurrentRenderList ()
 
RenderListGetCurrentRenderListptr ()
 
bool SetCurrentRenderList (const std::string &_ListToChangeTo)
 
bool InsertRenderList (RenderList *_newRenderList)
 
bool DestroyRenderList (const std::string &_name)
 
bool RemoveIteamFromRendableList (const std::string &_card, const std::string &_renderList)
 
RenderListFindRenderList (const std::string &_name)
 
RenderListCreateRenderList (const std::string &_name)
 
unsigned int GetTotalRenderList ()
 
bool ValideVersionNumberOfCppWithHeader ()
 
double GetVersionNumberH ()
 
double GetVersionNumberCpp ()
 
void TransferSprocketToNewRenderList (RenderList *_sorceRenderList, RenderList *_destinationRenderList, EEWidget *_sprocketToTransfer)
 
EpeeEngineError GetLastError ()
 
unsigned int GetTotalSprockesCreated ()
 
unsigned int GetTotalSoundsCreated ()
 
void WriteRenderListToFile ()
 
void WriteSoundListToFile ()
 
void TurnOnFPS ()
 
void TurnOffFPS ()
 
void ToggleFullScreen (bool _FullScreen)
 
void ChangedResolution (int _Width, int _height, bool _useCurrentFlags=true, bool _FullScreen=false, bool _Resize=false, bool _AnyFormat=false)
 
bool GetEvent (SDL_Event *_event)
 
unsigned int GetCurrentScreenHeight ()
 
unsigned int GetCurrentScreenWidth ()
 
bool IsKeyDisplayable (SDLKey _KeyToCheck)
 
char IsKeyModifiedByOtherKeys (SDLKey _KeyToCheck)
 
ControlCharactersGetControlCharacters ()
 
void DrawOutlineWithRect (SDL_Surface *_SurfaceToBeOutLined, SDL_Rect *OutLine, Uint8 _red=255, Uint8 _blue=0, Uint8 _green=0, unsigned int _thickness=1)
 
void DrawOutline (SDL_Surface *_SurfaceToBeOutLined, unsigned int _x, unsigned int _y, Uint8 _red=255, Uint8 _blue=0, Uint8 _green=0, unsigned int _thickness=1)
 
template<typename datatype >
datatype StringToNumericData (const std::string &_stringtoconvert, datatype temp)
 
template<typename datatype >
const std::string StringFromNumericData (datatype _value)
 

Constructor & Destructor Documentation

EpeeEngine::EpeeEngine ( )
EpeeEngine::EpeeEngine ( std::vector< FileLookUp filetable)
EpeeEngine::~EpeeEngine ( )

Member Function Documentation

void EpeeEngine::ChangedResolution ( int  _Width,
int  _height,
bool  _useCurrentFlags = true,
bool  _FullScreen = false,
bool  _Resize = false,
bool  _AnyFormat = false 
)
bool EpeeEngine::ChangeSprocketZ ( EEWidget _SprocketToChange,
int  _newZ,
RenderList _list = NULL 
)
Animation * EpeeEngine::CloneAnimation ( Animation _imageToClone,
const std::string &  _nameOfAnimation,
const std::string &  _RenderList,
int  _x = -1,
int  _y = -1,
int  _z = -1 
)
image * EpeeEngine::CloneImage ( image _imageToClone,
const std::string &  _nameOfImage,
const std::string &  _RenderList = "Current",
int  _x = -1,
int  _y = -1,
int  _z = -1 
)
textBox * EpeeEngine::CloneTextBox ( textBox _textBoxToClone,
const std::string &  _nameOfImage,
const std::string &  _RenderList = "Current",
int  _x = -1,
int  _y = -1,
int  _z = -1 
)
Animation * EpeeEngine::CreateAnimation ( const std::string &  _fileName,
const std::string &  _Name,
int  _x,
int  _y,
int  _z,
int  _NumberOfFrames,
int  _fps,
int  _StartFrame = 0,
int  _Loop = 1,
int  _NumberOfRowsOfFrames = 1,
bool  _Transparency = false,
bool  _StartNow = true,
const std::string &  _AddtoCurrentRenderlist = "Current" 
)
AnimationScript * EpeeEngine::CreateAnimationScript ( const std::string &  _Name,
EEWidget _AnimationSprocket,
PlayScrtipFuntionPointer _ScrtipFuntionPointer,
int  _z,
int  _TotalNumberOfFrames,
int  _fps = 30,
int  _StartFrame = 0,
int  _Loop = 1,
bool  _StartNow = true,
const std::string &  _AddtoCurrentRenderlist = "Current" 
)
Button * EpeeEngine::CreateButton ( const std::string &  _localfileName,
const std::string &  _localName,
int  _localx,
int  _localy,
int  _localz,
bool  _Transparency = false,
bool  _localactive = true,
const std::string &  _AddtoCurrentRenderlist = "Current" 
)
Button * EpeeEngine::CreateButton ( const std::string &  _localName,
int  _localx,
int  _localy,
int  _localz,
int  _height,
int  _width,
bool  _Transparency = false,
bool  _localactive = true,
const std::string &  _AddtoCurrentRenderlist = "Current" 
)
ButtonTB * EpeeEngine::CreateButtonTB ( const std::string &  _ButtonName,
int  _Buttonx,
int  _Buttony,
int  _Buttonz,
const std::string &  _ButtonText,
bool  _SButtonactive = true,
const std::string &  _AddtoCurrentRenderlist = "Current",
unsigned int  _ButtonTB_height = 30,
unsigned int  _ButtonTB_width = 100,
const std::string &  _ButtonTB_Font = True_Type_Font_Defalut,
int  _ButtonTB_FontPoint = 18,
unsigned int  _ButtonTB_red = 255,
unsigned int  _ButtonTB_blue = 255,
unsigned int  _ButtonTB_green = 255,
const std::string &  _ButtonFontPath = True_Type_Font_Location 
)
image * EpeeEngine::CreateImage ( const std::string &  _fileName,
const std::string &  _Name,
int  _x,
int  _y,
int  _z,
const std::string &  _AddtoCurrentRenderlist = "Current",
bool  _Transparency = false 
)
image * EpeeEngine::CreateImageFromList ( const std::string &  _symbol,
const std::string &  _ImageName,
int  _x,
int  _y,
int  _z 
)
RenderList * EpeeEngine::CreateRenderList ( const std::string &  _name)
Sound * EpeeEngine::CreateSound ( const std::string &  _GroupName,
const std::string &  _FileName,
int  _Channel = 0,
int  _NumberOfTimesToLoop = 0,
int  _Volume = MIX_MAX_VOLUME 
)
textBox * EpeeEngine::CreateTextBox ( const std::string &  _Name,
int  _x,
int  _y,
int  _z,
const std::string &  _TextBoxMessage = " ",
const std::string &  _AddtoCurrentRenderlist = "Current",
unsigned int  _height = -1,
unsigned int  _width = -1,
const std::string &  _Font = True_Type_Font_Defalut,
int  _FontPoint = 18,
unsigned int  _red = 255,
unsigned int  _blue = 255,
unsigned int  _green = 255,
const std::string &  _FontPath = True_Type_Font_Location 
)
bool EpeeEngine::DestroyRenderList ( const std::string &  _name)
bool EpeeEngine::DestroySound ( const std::string &  _name)
bool EpeeEngine::DestroySprocket ( const std::string &  _name)
void EpeeEngine::DrawOutline ( SDL_Surface *  _SurfaceToBeOutLined,
unsigned int  _x,
unsigned int  _y,
Uint8  _red = 255,
Uint8  _blue = 0,
Uint8  _green = 0,
unsigned int  _thickness = 1 
)
void EpeeEngine::DrawOutlineWithRect ( SDL_Surface *  _SurfaceToBeOutLined,
SDL_Rect *  OutLine,
Uint8  _red = 255,
Uint8  _blue = 0,
Uint8  _green = 0,
unsigned int  _thickness = 1 
)
bool EpeeEngine::EventProcessing ( SDL_Event *  _event)
bool EpeeEngine::FadeInSound ( Sound _pSound,
int  _ms 
)
bool EpeeEngine::FadeOutSound ( Sound _pSound,
int  _ms 
)
bool EpeeEngine::FadeOutSound ( int  _Channel,
int  _ms 
)
Animation * EpeeEngine::FindAnimation ( const std::string &  _name)
Button * EpeeEngine::FindButton ( const std::string &  _name)
ButtonTB * EpeeEngine::FindButtonTB ( const std::string &  _name)
EEWidget * EpeeEngine::FindEEWidget ( const std::string &  _name,
const std::string &  _renderlist = "Current" 
)
image * EpeeEngine::FindImage ( const std::string &  _name)
RenderList * EpeeEngine::FindRenderList ( const std::string &  _name)
Sound * EpeeEngine::FindSound ( const std::string &  _name)
textBox * EpeeEngine::FindTextBox ( const std::string &  _name)
ControlCharacters * EpeeEngine::GetControlCharacters ( )
std::string EpeeEngine::GetCurrentRenderList ( )
RenderList * EpeeEngine::GetCurrentRenderListptr ( )
unsigned int EpeeEngine::GetCurrentScreenHeight ( )
unsigned int EpeeEngine::GetCurrentScreenWidth ( )
bool EpeeEngine::GetEvent ( SDL_Event *  _event)
int EpeeEngine::GetFps ( )
EpeeEngineError EpeeEngine::GetLastError ( )
inline
float EpeeEngine::GetTimeSinceSetup ( )
unsigned int EpeeEngine::GetTotalRenderList ( )
unsigned int EpeeEngine::GetTotalSoundsCreated ( )
unsigned int EpeeEngine::GetTotalSprockesCreated ( )
double EpeeEngine::GetVersionNumberCpp ( )
double EpeeEngine::GetVersionNumberH ( )
bool EpeeEngine::InsertRenderList ( RenderList _newRenderList)
bool EpeeEngine::IsBackGoundMusicPlaying ( )
bool EpeeEngine::IsFoucsOnTextBox ( )
inline
bool EpeeEngine::IsKeyDisplayable ( SDLKey  _KeyToCheck)
char EpeeEngine::IsKeyModifiedByOtherKeys ( SDLKey  _KeyToCheck)
bool EpeeEngine::IsSoundPlaying ( Sound _pSound)
bool EpeeEngine::LoadConfigurationFile ( const std::string &  _FileName)
bool EpeeEngine::PlaySoundNow ( Sound _pSound)
bool EpeeEngine::RemoveIteamFromRendableList ( const std::string &  _card)
bool EpeeEngine::RemoveIteamFromRendableList ( const std::string &  _card,
const std::string &  _renderList 
)
bool EpeeEngine::RenderSeen ( bool  _UpdateScreenNow = false)
bool EpeeEngine::SetAndPlayBackGroundMusic ( const std::string &  _NameOfAudio,
int  _NumberOfTimesToLoop,
int  _Volume = MIX_MAX_VOLUME,
int  _ms = 0 
)
bool EpeeEngine::SetCurrentRenderList ( const std::string &  _ListToChangeTo)
bool EpeeEngine::SetFps ( int  _fps)
bool EpeeEngine::SetNumberOfMixingChannels ( int  _NumberOfChannels)
bool EpeeEngine::SetUp ( unsigned int  Screen_Width,
unsigned int  Screen_Heigth,
bool  FullSreenMod = false,
std::string  _WindowName = "Your App Name Here",
bool  _Resize = false,
unsigned int  _fps = 60,
unsigned int  _BitDepthOfScreen = 16,
bool  Anyformat = false 
)
bool EpeeEngine::SetUp ( std::vector< FileLookUp filetable,
unsigned int  Screen_Width,
unsigned int  Screen_Heigth,
bool  FullSreenMode = false,
const std::string &  _WindowName = "Your App Name Here",
bool  _Resize = false,
unsigned int  _fps = 60,
unsigned int  _BitDepthOfScreen = 16,
bool  Anyformat = false 
)
void EpeeEngine::SleepDelay ( Uint32  _millisecounds)
bool EpeeEngine::StopBackGroundMusic ( int  _ms = 0)
bool EpeeEngine::StopSoundNow ( int  _Channel)
bool EpeeEngine::StopSoundNow ( Sound _pSound)
template<typename datatype >
const std::string EpeeEngine::StringFromNumericData ( datatype  _value)
inline
template<typename datatype >
datatype EpeeEngine::StringToNumericData ( const std::string &  _stringtoconvert,
datatype  temp 
)
inline
void EpeeEngine::ToggleFullScreen ( bool  _FullScreen)
void EpeeEngine::TransferSprocketToNewRenderList ( RenderList _sorceRenderList,
RenderList _destinationRenderList,
EEWidget _sprocketToTransfer 
)
void EpeeEngine::TurnOffFPS ( )
void EpeeEngine::TurnOnFPS ( )
bool EpeeEngine::UpdateScreen ( )

if(m_bFullScreen)

bool EpeeEngine::ValideVersionNumberOfCppWithHeader ( )
EEWidget * EpeeEngine::WasAButtonClicked ( int  _x,
int  _y 
)
void EpeeEngine::WriteRenderListToFile ( )
void EpeeEngine::WriteSoundListToFile ( )

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