ECore.h File Reference

---

Detailed Description

Single include for the ECore API.

Date:

06/04/2006

Author:

Paul Chana

Version:

1.0.0 Initial version

Note:

All contents of this source code are copyright 2005 Exp Digital Uk.
This source file is covered by the licence conditions of the Infinity API. You should have recieved a copy
with the source code. If you didnt, please refer to http://www.expdigital.co.uk All content is the Intellectual property of Exp Digital Uk.
Certain sections of this code may come from other sources. They are credited where applicable.
If you have comments, suggestions or bug reports please visit http://support.expdigital.co.uk

Todo:

Remove CBounds

Todo:

Sort out CMathTools

Id

ECore.h,v 1.14 2007/02/11 02:15:54 paul Exp

Definition in file ECore.h.

Go to the source code of this file.

Namespaces

• namespace Exponent

Defines

• #define START_EXPONENT_API(AppDeveloper, AppName, AppDescription, AppVersion, AppRegistry, AppCopyright)
• #define START_EXPONENT_API(hInstance, AppDeveloper, AppName, AppDescription, AppVersion, AppRegistry, AppCopyright)
• #define START_EXPONENT_API_CLI(AppDeveloper, AppName, AppDescription, AppVersion, AppCopyright)
• #define STOP_EXPONENT_API(ClassLogPath)
• #define STOP_EXPONENT_API_ECORE_ONLY(ClassLogPath)   CClass::deleteClassManager(ClassLogPath);
• #define STOP_EXPONENT_API_NO_LOG
• #define STOP_EXPONENT_API_NO_LOG_ECORE_ONLY   CClass::deleteClassManager(NULL);

---

Define Documentation

#define START_EXPONENT_API	(	AppDeveloper,
		AppName,
		AppDescription,
		AppVersion,
		AppRegistry,
		AppCopyright		)

Value:

CApplication::setApplicationModuleHandle(AppRegistry);\
            CApplication::setApplicationDeveloper(AppDeveloper);\
            CApplication::setApplicationName(AppName);\
            CApplication::setApplicationDescription(AppDescription);\
            CApplication::setApplicationVersion(AppVersion);\
            CApplication::setApplicationRegistry(AppRegistry);\
            CApplication::setApplicationCopyrightInformation(AppCopyright);\
            CApplication::setApplicationInstallPathFromApplicationHandle();\
            CFPUInformation::initialiseCPUInformation();\
            CFont::createDefaultFont();

Call this to correctly start up a dll or other application that requires application information
hInstance Is the application instance
AppDeveloper A string representing the application developer (eg ExpDigital)
AppName A string representing the name of the application (eg GFlux)
AppDescription A string description (in freeform text) describing the application
AppVersion The application version as a string in form Major.Minor.Revision (eg 1.0.2)
AppRegistry The registry location, usually spomething like Software\Exponent\GFlux refering to HKLM AppCopyright A string representing the application copyright information
This is a Win32 Version of the startup routine

Note:

All of these defines have the name Exponent in them. This is for historical reasons, and they have not been changed to avoid breaking code!

Definition at line 238 of file ECore.h.

#define START_EXPONENT_API	(	hInstance,
		AppDeveloper,
		AppName,
		AppDescription,
		AppVersion,
		AppRegistry,
		AppCopyright		)

Value:

CApplication::setApplicationInstance(hInstance);\
            CApplication::setApplicationModuleHandle(hInstance);\
            CApplication::setApplicationDeveloper(AppDeveloper);\
            CApplication::setApplicationName(AppName);\
            CApplication::setApplicationDescription(AppDescription);\
            CApplication::setApplicationVersion(AppVersion);\
            CApplication::setApplicationRegistry(AppRegistry);\
            CApplication::setApplicationCopyrightInformation(AppCopyright);\
            CApplication::setApplicationInstallPathFromApplicationHandle();\
            CFPUInformation::initialiseCPUInformation();\
            CFont::createDefaultFont();

Call this to correctly start up a dll or other application that requires application information
hInstance Is the application instance
AppDeveloper A string representing the application developer (eg ExpDigital)
AppName A string representing the name of the application (eg GFlux)
AppDescription A string description (in freeform text) describing the application
AppVersion The application version as a string in form Major.Minor.Revision (eg 1.0.2)
AppRegistry The registry location, usually spomething like Software\Exponent\GFlux refering to HKLM AppCopyright A string representing the application copyright information
This is a Win32 Version of the startup routine

Note:

All of these defines have the name Exponent in them. This is for historical reasons, and they have not been changed to avoid breaking code!

Definition at line 238 of file ECore.h.

#define START_EXPONENT_API_CLI	(	AppDeveloper,
		AppName,
		AppDescription,
		AppVersion,
		AppCopyright		)

Value:

CApplication::setApplicationDeveloper(AppDeveloper);\
        CApplication::setApplicationName(AppName);\
        CApplication::setApplicationDescription(AppDescription);\
        CApplication::setApplicationVersion(AppVersion);\
        CApplication::setApplicationCopyrightInformation(AppCopyright);

Class this if you want to use the Exponent API from a command line program
AppDeveloper A string representing the application developer (eg ExpDigital)
AppName A string representing the name of the application (eg GFlux)
AppDescription A string description (in freeform text) describing the application
AppVersion The application version as a string in form Major.Minor.Revision (eg 1.0.2)
AppCopyright A string representing the application copyright information

Definition at line 262 of file ECore.h.

#define STOP_EXPONENT_API

(

ClassLogPath

)

Value:

CFont::destroyDefaultFont();\
        CImageManager::clearImageLibrary();\
        CClass::deleteClassManager(ClassLogPath);

Call this to correctly stop your application from using the Exponent API (destructor on mac, dll release on windows). Note that this is intended for use in graphical applications
ie - Those using EGUI. You will recieve an error if EGUI based objects arent available
ClassLogPath is a string path that is the location to save the class log files

See also:

STOP_EXPONENT_API_NO_LOG_ECORE_ONLY

Definition at line 275 of file ECore.h.

#define STOP_EXPONENT_API_ECORE_ONLY

(

ClassLogPath

)

CClass::deleteClassManager(ClassLogPath);

Call this to correctly stop your application from using the Exponent API (destructor on mac, dll release on windows), if you are only using ECORE.

Definition at line 293 of file ECore.h.

#define STOP_EXPONENT_API_NO_LOG

Value:

CFont::destroyDefaultFont();\
        CImageManager::clearImageLibrary();\
        CClass::deleteClassManager(NULL);

Call this to correctly stop your application from using the Exponent API (destructor on mac, dll release on windows. This version odesnt wrtite the class log list. Note that this is intended for use in graphical applications
ie - Those using EGUI. You will recieve an error if EGUI based objects arent available

See also:

STOP_EXPONENT_API_NO_LOG_ECORE_ONLY

Definition at line 285 of file ECore.h.

#define STOP_EXPONENT_API_NO_LOG_ECORE_ONLY   CClass::deleteClassManager(NULL);

Call this to correctly stop your application from using the Exponent API (destructor on mac, dll release on windows), if you are only using ECORE. This version odesnt wrtite the class log list

Definition at line 298 of file ECore.h.

---