Global namespace - Contains all namespaces, classes and functions. More...
Namespaces | |
namespace | audio |
Container for all audio related classes and functions. | |
namespace | input |
Container for all input related classes and functions. | |
namespace | ui |
Container for all user interface classes anf functions. | |
namespace | utility |
Container for all utility classes and functions. | |
Classes | |
class | AABB |
An Axis Aligned Bounding Box (AABB) More... | |
class | AccessViolationException |
Exception thrown when a data access condition is not satisfied. More... | |
class | AdjacencyList |
Construct a list of neighbours for each accessible node/cell in a grid. More... | |
class | Animation |
A SpriteSheet/frame based animation. More... | |
class | AnimationFrame |
An Animation frame. More... | |
class | Animator |
An animator for ime::Sprite. More... | |
class | BFS |
Finds a path in a Grid2D using the Breadth First Search algorithm. More... | |
struct | Borders |
Widget borders. More... | |
class | BoxCollider |
A box collider. More... | |
class | Camera |
A 2D camera that defines what region is shown on screen in a Scene. More... | |
class | CameraContainer |
Container for additional scene cameras. More... | |
class | CircleCollider |
A circle circle. More... | |
class | CircleShape |
A closed 2D curved shape. More... | |
class | Clock |
Class that measures time. More... | |
class | Collider |
Abstract Base class for colliders. More... | |
struct | CollisionFilterData |
Holds collision filtering data for a collider. More... | |
class | Colour |
RGBA colour. More... | |
class | ConvexShape |
A convex shape. More... | |
class | CyclicGridMover |
Moves a game object in the grid along a cyclic path. More... | |
struct | DebugDrawerFilter |
Controls the filter flags of the debug drawer. More... | |
class | DFS |
Finds a path in a Grid2D using the Depth First Search algorithm. More... | |
class | DistanceJoint |
Constrains two points on two rigid bodies to remain at a fixed distance from each other. More... | |
struct | DistanceJointDefinition |
class | Drawable |
Interface for drawable objects. More... | |
class | DrawableContainer |
A container for Drawable objects. More... | |
class | EdgeCollider |
An edge collider is a line segment. More... | |
class | Engine |
Runs the main game loop. More... | |
class | Event |
Defines a system event and its parameters. More... | |
class | EventDispatcher |
A singleton class that creates a communication interface between separate parts of a program through event dispatching. More... | |
class | EventEmitter |
Create and publish events. More... | |
class | ExcludeList |
A GameObject collision exclusion list. More... | |
class | FileNotFoundException |
Exception thrown when a file cannot be found. More... | |
class | GameObject |
Class for modelling game objects (players, enemies etc...) More... | |
class | GameObjectContainer |
A container for GameObject instances. More... | |
class | Grid2D |
A 2D visual grid. More... | |
class | Grid2DRenderer |
Defines the render properties of a Grid2D. More... | |
class | GridMover |
Class for performing grid based movement on an entity in a grid. More... | |
class | GridMoverContainer |
A container for GridMover objects. More... | |
class | GridObject |
An object that can be placed in a Grid2D. More... | |
struct | Index |
Represents a position Grid2D Tile. More... | |
class | InvalidArgumentException |
Exception thrown when an argument is invalid. More... | |
class | InvalidParseException |
Exception thrown when parsed data read from the disk is invalid. More... | |
class | IPathFinderStrategy |
Interface for grid path finder algorithms. More... | |
class | ITransformable |
Interface for transformable entities. More... | |
class | Joint |
Interface for Joint classes. More... | |
struct | JointDefinition |
Define the properties of a Joint. More... | |
class | KeyboardGridMover |
Moves a GridObject in the grid using the keyboard as a movement trigger. More... | |
class | Object |
An abstract top-level base class for IME objects. More... | |
class | ObjectContainer |
A container for ime::Object instances. More... | |
struct | Padding |
Represents the spacing between the text and the border of a widget. More... | |
class | PhysicsEngine |
The physics world is responsible for creating, managing, colliding and updating all of the bodies within it. More... | |
struct | PhysIterations |
Controls the reaction of ime::RigidBody objects when they collide. More... | |
class | PolygonCollider |
Solid convex polygon collider. More... | |
class | PrefContainer |
Container for Preference instances. More... | |
class | Preference |
A key-value pair that can be saved to a file on the disk. More... | |
class | Property |
Class that can store a value of any type. More... | |
class | PropertyContainer |
A container for ime::Property instances. More... | |
class | RandomGridMover |
Moves a GridObject randomly in a Grid2D. More... | |
class | Rect |
Class for manipulating 2D axis aligned rectangles. More... | |
class | RectangleShape |
A 2D shape having four sides and four corners (90 degree angles) More... | |
class | RenderLayer |
A layer for drawable entities. More... | |
class | RenderLayerContainer |
Stores and manages a scene's render layers. More... | |
class | ResourceLoader |
Load resources from the disk into the program. More... | |
class | RigidBody |
A rigid body. More... | |
class | Scene |
A base class for game scenes. More... | |
class | Shape |
Abstract base class for geometric figures. More... | |
class | Sprite |
Drawable representation of a texture. More... | |
class | SpriteImage |
Abstract base class for image containers. More... | |
class | SpriteSheet |
An ImageSprite which contains images of the same size arranged in a grid. More... | |
class | TargetGridMover |
Moves a GridObject to a specific position in the Grid2D. More... | |
class | Texture |
Image living on the graphics card that can be used for drawing. More... | |
class | Tile |
A Grid2D tile. More... | |
class | Time |
Represents a time value. More... | |
class | Timer |
Execute a callback after an interval/delay. More... | |
class | TimerManager |
Manages multiple Timer instances. More... | |
class | Transform |
Transform defined by a position, a rotation and a scale. More... | |
struct | TriggerKeys |
Keys that triggers the targets direction change. More... | |
class | Vector2 |
2D vector More... | |
class | Window |
Game window. More... | |
Typedefs | |
using | PrefType = Preference::Type |
ime::Preference::Type alias More... | |
using | UIntRect = Rect< unsigned int > |
Unsigned int rect. More... | |
using | IntRect = Rect< int > |
Int rect. More... | |
using | FloatRect = Rect< float > |
Float rect. More... | |
using | Vector2i = Vector2< int > |
2D int vector More... | |
using | Vector2u = Vector2< unsigned int > |
2D unsigned int vector More... | |
using | Vector2f = Vector2< float > |
2D float vector More... | |
typedef signed char | Int8 |
typedef unsigned char | Uint8 |
typedef signed short | Int16 |
typedef unsigned short | Uint16 |
typedef signed int | Int32 |
typedef unsigned int | Uint32 |
typedef signed long long | Int64 |
typedef unsigned long long | Uint64 |
template<typename... Args> | |
using | Callback = std::function< void(Args...)> |
Event listener. More... | |
using | Map = std::vector< std::vector< char > > |
Alias for 2D vector of chars. More... | |
using | Keyboard = input::Keyboard |
ime::input::Keyboard alias More... | |
using | Key = input::Keyboard::Key |
ime::input::Keyboard::Key alias More... | |
using | Mouse = input::Mouse |
ime::input::Mouse alias More... | |
using | Direction = Vector2i |
Direction of a game object. More... | |
using | AABBCallback = std::function< bool(Collider *const)> |
Callback function passed to queryAABB function. More... | |
using | RayCastCallback = std::function< float(Collider *const, Vector2f, Vector2f, float)> |
Callback function passed to rayCast Function. More... | |
using | SpriteContainer = DrawableContainer< Sprite > |
Shape object container. More... | |
using | ShapeContainer = DrawableContainer< Shape > |
Sprite object container. More... | |
Enumerations | |
enum class | FrameArrangement { Horizontal , Vertical } |
Defines how the Animation frames are arranged on a spritesheet. More... | |
enum class | KeyboardEvent { KeyUp , KeyDown , KeyHeld } |
Keyboard events. More... | |
enum class | MouseEvent { MouseDown , MouseUp , MouseMove , MouseWheelScroll } |
Mouse events. More... | |
enum class | MovementTrigger { None , OnKeyDown , OnKeyUp , OnKeyHeld , OnKeyDownHeld } |
Defines how the movement is triggered based on the state of a key. More... | |
enum class | JointType { Distance } |
The types of joints. More... | |
enum class | ResourceType { Texture , Font , Image , SoundEffect , Music } |
Resource identifiers (Types of resources that can be handled by resource manager) More... | |
enum | WindowStyle { None = 0 , None , Titlebar = 1 << 0 , Resize = 1 << 1 , Close = 1 << 2 , Fullscreen = 1 << 3 , Default = Titlebar | Resize | Close } |
Window styles. More... | |
enum class | TextStyle { Regular = 0 , Bold = 1 << 0 , Italic = 1 << 1 , Underlined = 1 << 2 , StrikeThrough = 1 << 3 } |
Text styles. More... | |
enum class | CursorType { Arrow , Text , Hand , SizeLeft , SizeRight , SizeTop , SizeBottom , SizeTopLeft , SizeBottomRight , SizeBottomLeft , SizeTopRight , Crosshair , Help , NotAllowed } |
Mouse cursor types. More... | |
Functions | |
IME_API void | savePref (const Preference &pref, const std::string &filename) |
Save a Preference to the disk. More... | |
template<typename T > | |
Vector2< T > | operator* (T left, const Vector2< T > &right) |
relates Vector2 More... | |
template<typename T > | |
Vector2< T > & | operator*= (Vector2< T > &left, T right) |
Overload of binary operator *=. More... | |
IME_API bool | operator== (const Index &lhs, const Index &rhs) |
Overload of binary operator ==. More... | |
IME_API bool | operator!= (const Index &lhs, const Index &rhs) |
Overload of binary operator !=. More... | |
IME_API bool | operator== (const TriggerKeys &lhs, const TriggerKeys &rhs) |
Overload of binary operator ==. More... | |
IME_API bool | operator!= (const TriggerKeys &lhs, const TriggerKeys &rhs) |
Overload of binary operator !=. More... | |
IME_API std::string | bindLeft (ui::Widget *widget) |
Bind to the x position of a widget. More... | |
IME_API std::string | bindTop (ui::Widget *widget) |
Bind to the y position of the widget. More... | |
IME_API std::string | bindWidth (ui::Widget *widget) |
Bind to the width of a widget. More... | |
IME_API std::string | bindHeight (ui::Widget *widget) |
Bind to the height of a widget. More... | |
IME_API std::string | bindRight (ui::Widget *widget) |
Bind to the right position of a widget. More... | |
IME_API std::string | bindBottom (ui::Widget *widget) |
Bind to the bottom position of a widget. More... | |
IME_API std::string | bindPosition (ui::Widget *widget) |
Bind to the position of the widget. More... | |
IME_API std::string | bindSize (ui::Widget *widget) |
Bind to the size of the widget. More... | |
IME_API std::string | bindMin (const std::string &value1, const std::string &value2) |
Bind to the minimum value of two values. More... | |
IME_API std::string | bindMax (const std::string &value1, const std::string &value2) |
Bind to the maximum of two values. More... | |
Variables | |
static const Direction | Left = {-1, 0} |
West direction. More... | |
static const Direction | UpLeft = {-1, -1} |
North-West direction. More... | |
static const Direction | Up = {0, -1} |
North direction. More... | |
static const Direction | UpRight = {1, -1} |
North-East direction. More... | |
static const Direction | Right = {1, 0} |
East direction. More... | |
static const Direction | DownRight = {1, 1} |
South-East direction. More... | |
static const Direction | Down = {0, 1} |
South direction. More... | |
static const Direction | DownLeft = {-1, 1} |
South-West direction. More... | |
static const Direction | Unknown = {0, 0} |
Unknown direction. More... | |
Global namespace - Contains all namespaces, classes and functions.
using ime::AABBCallback = typedef std::function<bool(Collider* const)> |
Callback function passed to queryAABB function.
The callback is called for every collider that overlaps the query AABB. The callback must return false to terminate the query early or true to continue with the query until all colliders have been processed
Definition at line 58 of file PhysicsEngine.h.
using ime::Callback = typedef std::function<void(Args...)> |
Event listener.
Definition at line 38 of file EventEmitter.h.
using ime::Direction = typedef Vector2i |
Direction of a game object.
Definition at line 37 of file GridMover.h.
using ime::FloatRect = typedef Rect<float> |
using ime::IntRect = typedef Rect<int> |
using ime::Key = typedef input::Keyboard::Key |
ime::input::Keyboard::Key alias
Definition at line 302 of file Keyboard.h.
using ime::Keyboard = typedef input::Keyboard |
ime::input::Keyboard alias
Definition at line 301 of file Keyboard.h.
using ime::Map = typedef std::vector<std::vector<char> > |
using ime::Mouse = typedef input::Mouse |
ime::input::Mouse alias
using ime::PrefType = typedef Preference::Type |
ime::Preference::Type alias
Definition at line 159 of file Preference.h.
using ime::RayCastCallback = typedef std::function<float(Collider* const, Vector2f, Vector2f, float)> |
Callback function passed to rayCast Function.
The callback is called for every collider that the ray collides with. The callback controls how the ray proceeds by the value it returns:
i) -1: Ignore the current collider and continue with the ray casting. The collider will be filtered. That is, the ray cast will proceed as if the collider does not exist
ii) 0: Terminate the ray cast immediately
iii) 1: Don't clip the ray and continue. By default the ray is clipped if it collides with a collider. When 1 is returned the ray will continue as if it did not hit anything
iv) fraction : The fraction is provided to the callback when it is called. If it is returned, then the ray will be clipped to the current point of intersection.
The value returned by the callback function allow you to ray cast any collider, ray cast all colliders, or ray cast the closest collider.
The argument list of the callback is as follows:
first arg: The collider that is currently colliding with the ray second arg: The point of initial intersection (There may be more than one intersection depending on the value returned by the callback) third arg: The normal vector (rotation) at the point of intersection forth arg: The distance from the rays starting point to the current point of intersection (fraction)
Definition at line 94 of file PhysicsEngine.h.
using ime::ShapeContainer = typedef DrawableContainer<Shape> |
Sprite object container.
Definition at line 74 of file DrawableContainer.h.
using ime::SpriteContainer = typedef DrawableContainer<Sprite> |
Shape object container.
Definition at line 73 of file DrawableContainer.h.
using ime::UIntRect = typedef Rect<unsigned int> |
using ime::Vector2f = typedef Vector2<float> |
using ime::Vector2i = typedef Vector2<int> |
using ime::Vector2u = typedef Vector2<unsigned int> |
|
strong |
Mouse cursor types.
|
strong |
Defines how the Animation frames are arranged on a spritesheet.
Enumerator | |
---|---|
Horizontal | Horizontal frame alignment. |
Vertical | Vertical frame alignment. |
Definition at line 43 of file Animation.h.
|
strong |
The types of joints.
Enumerator | |
---|---|
Distance | Distance joint. |
Definition at line 38 of file JointDefinition.h.
|
strong |
Keyboard events.
Enumerator | |
---|---|
KeyUp | Fired when depressed/held key is released. |
KeyDown | Fired when key is depressed for the first time. |
KeyHeld | Fired when a depressed key remains held. |
Definition at line 38 of file Keyboard.h.
|
strong |
|
strong |
Defines how the movement is triggered based on the state of a key.
Definition at line 35 of file KeyboardGridMover.h.
|
strong |
Resource identifiers (Types of resources that can be handled by resource manager)
Enumerator | |
---|---|
Texture | |
Font | ime::Font |
Image | ime::Image |
SoundEffect | ime::SoundEffect |
Music | ime::Music |
Definition at line 33 of file ResourceType.h.
|
strong |
Text styles.
Enumerator | |
---|---|
Regular | Regular characters, no style. |
Bold | Bold characters. |
Italic | Italic characters. |
Underlined | Underlined characters. |
StrikeThrough | Strike through characters. |
Definition at line 61 of file IWidgetRenderer.h.
enum ime::WindowStyle |
Window styles.
Definition at line 32 of file WindowStyles.h.
IME_API std::string ime::bindBottom | ( | ui::Widget * | widget | ) |
Bind to the bottom position of a widget.
widget | Widget to bind to |
IME_API std::string ime::bindHeight | ( | ui::Widget * | widget | ) |
Bind to the height of a widget.
widget | The widget to bind to |
IME_API std::string ime::bindLeft | ( | ui::Widget * | widget | ) |
Bind to the x position of a widget.
widget | Widget to bind to |
IME_API std::string ime::bindMax | ( | const std::string & | value1, |
const std::string & | value2 | ||
) |
Bind to the maximum of two values.
value1 | The first value |
value2 | The second value |
The values can be relative or absolute. For relative values insert the percentage (%) at the end
IME_API std::string ime::bindMin | ( | const std::string & | value1, |
const std::string & | value2 | ||
) |
Bind to the minimum value of two values.
value1 | The first value |
value2 | The second value |
The values can be relative or absolute. For relative values insert the percentage (%) at the end
IME_API std::string ime::bindPosition | ( | ui::Widget * | widget | ) |
Bind to the position of the widget.
widget | Widget to bind to |
IME_API std::string ime::bindRight | ( | ui::Widget * | widget | ) |
Bind to the right position of a widget.
widget | Widget to bind to |
IME_API std::string ime::bindSize | ( | ui::Widget * | widget | ) |
Bind to the size of the widget.
widget | The widget to bind to |
IME_API std::string ime::bindTop | ( | ui::Widget * | widget | ) |
Bind to the y position of the widget.
widget | Widget to bind to |
IME_API std::string ime::bindWidth | ( | ui::Widget * | widget | ) |
Bind to the width of a widget.
widget | The widget to bind to |
Overload of binary operator !=.
lhs | Left operand |
rhs | Right operand |
IME_API bool ime::operator!= | ( | const TriggerKeys & | lhs, |
const TriggerKeys & | rhs | ||
) |
Overload of binary operator !=.
lhs | Left operand (a vector) |
rhs | Right operand (a vector) |
relates Vector2
Overload of binary operator *
left | Left operand (a scalar value) |
right | Right operand (a vector) |
Overload of binary operator *=.
left | Left operand (a vector) |
right | Right operand (a scalar value) |
This operator performs a memberwise multiplication by right, and assigns the result to left.
Overload of binary operator ==.
lhs | Left operand |
rhs | Right operand |
IME_API bool ime::operator== | ( | const TriggerKeys & | lhs, |
const TriggerKeys & | rhs | ||
) |
Overload of binary operator ==.
lhs | Left operand |
rhs | Right operand |
IME_API void ime::savePref | ( | const Preference & | pref, |
const std::string & | filename | ||
) |
Save a Preference to the disk.
pref | The preference to be saved |
filename | The name of the file to save the preference to |
FileNotFoundException | if the specified file cannot be opened for writing |
The preference will be saved using the following format:
Note that the preference will be appended at the end of the file. In addition, the file to append data to is searched relative to the game executable
|
static |
South direction.
Definition at line 44 of file GridMover.h.
|
static |
South-West direction.
Definition at line 45 of file GridMover.h.
|
static |
South-East direction.
Definition at line 43 of file GridMover.h.
|
static |
West direction.
Definition at line 38 of file GridMover.h.
|
static |
East direction.
Definition at line 42 of file GridMover.h.
|
static |
Unknown direction.
Definition at line 46 of file GridMover.h.
|
static |
North direction.
Definition at line 40 of file GridMover.h.
|
static |
North-West direction.
Definition at line 39 of file GridMover.h.
|
static |
North-East direction.
Definition at line 41 of file GridMover.h.