Classes | Enumerations | Functions

FIFE Namespace Reference

credit to phoku for his NodeDisplay example which the visitor code is adapted from ( he coded the quadtree after all ) More...

Classes

class  SoundClip
class  SoundClipManager
class  SoundEmitter
class  Engine
class  EngineSettings
class  Event
class  InputEvent
class  Command
class  ICommandController
class  ICommandListener
class  EventManager
class  IKeyController
class  IKeyFilter
class  IKeyListener
class  Key
class  KeyEvent
class  IMouseController
class  IMouseListener
class  MouseEvent
class  ISdlEventController
class  ISdlEventListener
class  IEventSource
class  OpenGLGuiGraphics
class  OpenGLeGuiGraphics
class  SdlGuiGraphics
class  CommandLine
class  ConsoleExecuter
class  Console
class  IMapLoader
class  IObjectLoader
class  ImageLoader
class  Object
class  TimeProvider
class  Model
class  Instance
class  LayerChangeListener
class  Layer
class  MapChangeListener
class  Map
class  RoutePatherSearch
class  IMapSaver
class  IObjectSaver
class  Exception
class  FifeClass
class  SharedPtr
class  StaticSingleton
class  DynamicSingleton
class  LMsg
class  LogManager
class  Logger
struct  pprint
class  Matrix
class  IResourceManager
class  PointType2D
class  PointType3D
class  PriorityQueue
class  QuadNode
class  QuadTree
class  RectType
class  TimeEvent
class  TimeManager
class  DAT1
class  DAT2
class  LZSSDecoder
class  RawDataDAT1
class  RawDataDAT2
class  DirectoryProvider
class  RawData
class  RawDataFile
class  RawDataMemSource
class  RawDataSource
class  VFS
class  VFSDirectory
class  VFSSource
class  VFSSourceProvider
class  ZipProvider
class  ZipSource
class  Animation
class  Cursor
class  FontBase
class  IFont
class  ImageFontBase
class  SubImageFont
class  TextRenderPool
class  TrueTypeFont
class  Image
class  ImageManager
class  GLImage
class  RenderBackendOpenGL
class  GLeImage
class  RenderBackendOpenGLe
class  RenderBackend
class  RenderBackendSDL
class  SDLImage
class  Camera
class  IRendererListener
class  IRendererContainer
class  RendererBase
class  CellSelectionRenderer
class  Visual2DGfx
class  ObjectVisual
class  InstanceVisual
class  ActionVisual

Enumerations

enum  SoundPositionType
enum  CommandType
enum  EventSourceType
enum  PathingStrategy
enum  MouseCursorType
enum  NativeCursor

Functions

AtlasLoader * createDefaultAtlasLoader (Model *model, VFS *vfs, ImageManager *imageManager)
MapLoader * createDefaultMapLoader (Model *model, VFS *vfs, ImageManager *imageManager, RenderBackend *renderBackend)
uint32_t scaleTime (float multiplier, uint32_t ticks)
std::ostream & operator<< (std::ostream &os, const Location &l)
 FIFE_EXCEPTION_DECL (OutOfMemory,"Buy more ram ;)")
template<typename T , typename U >
bool operator== (const SharedPtr< T > &lhs, const SharedPtr< U > &rhs)
template<typename T , typename U >
bool operator!= (const SharedPtr< T > &lhs, const SharedPtr< U > &rhs)
template<class T , class U >
bool operator< (SharedPtr< T > const &lhs, SharedPtr< U > const &rhs)
template<typename T >
SharedPtr< T > make_shared (T *ptr)
int32_t getIndexByAngle (int32_t angle, const type_angle2id &angle2id, int32_t &closestMatchingAngle)
int32_t getAngleBetween (const Location &loc1, const Location &loc2)
unsigned nextPow2 (unsigned x)
template<typename T >
std::ostream & operator<< (std::ostream &os, const Matrix< T > &m)
template<typename T >
std::ostream & operator<< (std::ostream &os, const PointType2D< T > &p)
template<typename T >
std::ostream & operator<< (std::ostream &os, const PointType3D< T > &p)
Point doublePt2intPt (DoublePoint pt)
Point3D doublePt2intPt (DoublePoint3D pt)
DoublePoint intPt2doublePt (Point pt)
DoublePoint3D intPt2doublePt (Point3D pt)
template<typename T >
std::ostream & operator<< (std::ostream &os, const RectType< T > &r)
bool HasParentPath (const bfs::path &path)
bfs::path GetParentPath (const bfs::path &path)
std::string GetFilenameFromDirectoryIterator (const bfs::directory_iterator &iter)
void SDL_BlendRow_RGBA8_to_RGBA8 (const uint8_t *src, uint8_t *dst, uint32_t alpha, int32_t n)
void SDL_BlendRow_RGBA8_to_RGB8 (const uint8_t *src, uint8_t *dst, uint32_t alpha, int32_t n)
void SDL_BlendRow_RGBA8_to_RGB565 (const uint8_t *src, uint8_t *dst, uint32_t alpha, int32_t n)
void SDL_BlendRow_RGBA4_to_RGB565 (const uint8_t *src, uint8_t *dst, uint32_t alpha, int32_t n)

Detailed Description

credit to phoku for his NodeDisplay example which the visitor code is adapted from ( he coded the quadtree after all )

Enumeration Type Documentation

enum FIFE::CommandType

Types for different commands

Definition at line 40 of file ec_commandids.h.

enum FIFE::EventSourceType

Types for different event sources

Definition at line 41 of file ec_eventsourcetypes.h.

enum FIFE::MouseCursorType

Defines the type of shown cursor native -> default cursor image -> cursor from image pool animation -> cursor from animation pool

Definition at line 48 of file cursor.h.

enum FIFE::NativeCursor

Defines some common native cursors between platforms. In addition to these, you can use the values in: Windows: http://msdn.microsoft.com/en-us/library/ms648391(VS.85).aspx X11: http://fife.pastebin.com/f5b89dd6b

Definition at line 60 of file cursor.h.

enum FIFE::PathingStrategy

Defines how pathing can be performed on this layer

CELL_EDGES_ONLY allows pather to use only cell edges when moving instances from cell to cell on map CELL_EDGES_AND_DIAGONALS allows pather to use both cell edges and diagonals when moving instances from cell to cell on map FREEFORM allows pather to find shortest route regardless of cellgrid used on the layer

Definition at line 58 of file layer.h.

enum FIFE::SoundPositionType

Different types of audio-file positions

Definition at line 44 of file soundclip.h.

Function Documentation

AtlasLoader * FIFE::createDefaultAtlasLoader ( Model *  model,
VFS *  vfs,
ImageManager *  imageManager 
)

convenience function for creating the default fife atlas loader deleting the object returned from this function is the responsibility of the caller

MapLoader * FIFE::createDefaultMapLoader ( Model *  model,
VFS *  vfs,
ImageManager *  imageManager,
RenderBackend *  renderBackend 
)

convenience function for creating the default fife map loader deleting the object returned from this function is the responsibility of the caller

Point FIFE::doublePt2intPt ( DoublePoint  pt  )  [inline]

Convert from 2D double point to 2D int32_t point

Definition at line 329 of file point.h.

Point3D FIFE::doublePt2intPt ( DoublePoint3D  pt  )  [inline]

Convert from 3D double point to 3D int32_t point

Definition at line 336 of file point.h.

FIFE::FIFE_EXCEPTION_DECL ( OutOfMemory  ,
"Buy more ram ;   
)
Bug:
The memory allocation in std::string might fail, resulting in terminate.
int32_t FIFE::getAngleBetween ( const Location &  loc1,
const Location &  loc2 
) [inline]

Gets angle of vector defined by given locations

Returns:
angle in polar coordinates between the line defined by the two locations and the horizontal axis (East <-> West)

Definition at line 48 of file angles.h.

std::string FIFE::GetFilenameFromDirectoryIterator ( const bfs::directory_iterator &  iter  ) 

Helper function to retrieve a filename string from a directory iterator

Parameters:
boost filesystem directory_iterator object
Returns:
a filename string
int32_t FIFE::getIndexByAngle ( int32_t  angle,
const type_angle2id &  angle2id,
int32_t &  closestMatchingAngle 
)

Returns id for given angle from angle2id map in case there are no elements in the map, negative value is returned

Referenced by FIFE::ActionVisual::getAnimationByAngle(), FIFE::ObjectVisual::getClosestMatchingAngle(), and FIFE::ObjectVisual::getStaticImageIndexByAngle().

Here is the caller graph for this function:

bfs::path FIFE::GetParentPath ( const bfs::path &  path  ) 

Helper function to retrieve a parent path object from a path object

Parameters:
boost filesystem path object
Returns:
a path object with parent of passed in parameter
bool FIFE::HasParentPath ( const bfs::path &  path  ) 

Helper function to determine if a path object has a parent path

Parameters:
boost filesystem path object
Returns:
true - does have parent path false - does not have parent path
DoublePoint FIFE::intPt2doublePt ( Point  pt  )  [inline]

Convert from 2D int32_t point to 2D double point

Definition at line 343 of file point.h.

DoublePoint3D FIFE::intPt2doublePt ( Point3D  pt  )  [inline]

Convert from 3D int32_t point to 3D double point

Definition at line 350 of file point.h.

template<typename T >
SharedPtr<T> FIFE::make_shared ( T *  ptr  ) 

convenience function for making a shared pointer can be used anytime a shared pointer should be created

Definition at line 274 of file sharedptr.h.

unsigned FIFE::nextPow2 ( unsigned  x  )  [inline]

Returns the next higher power of 2 based on the passed argument

Definition at line 292 of file fife_math.h.

References nextPow2().

Referenced by nextPow2().

Here is the caller graph for this function:

template<typename T , typename U >
bool FIFE::operator!= ( const SharedPtr< T > &  lhs,
const SharedPtr< U > &  rhs 
) [inline]

provides inequality operator for shared pointers

Definition at line 259 of file sharedptr.h.

References FIFE::SharedPtr< T >::get().

template<class T , class U >
bool FIFE::operator< ( SharedPtr< T > const &  lhs,
SharedPtr< U > const &  rhs 
) [inline]

provides less than operator for shared pointers

Definition at line 266 of file sharedptr.h.

template<typename T >
std::ostream& FIFE::operator<< ( std::ostream &  os,
const Matrix< T > &  m 
)

Print coords of the Matrix to a stream

Definition at line 380 of file matrix.h.

template<typename T >
std::ostream& FIFE::operator<< ( std::ostream &  os,
const PointType3D< T > &  p 
)

Print coords of the Point to a stream

Definition at line 320 of file point.h.

template<typename T >
std::ostream& FIFE::operator<< ( std::ostream &  os,
const RectType< T > &  r 
)

Stream output operator.

Useful for debugging purposes, this will output the coordinates of the rectangle to the stream.

Definition at line 160 of file rect.h.

std::ostream & FIFE::operator<< ( std::ostream &  ,
const Location &   
)

Stream output operator.

Useful for debugging purposes

template<typename T >
std::ostream& FIFE::operator<< ( std::ostream &  os,
const PointType2D< T > &  p 
)

Print coords of the Point to a stream

Definition at line 190 of file point.h.

template<typename T , typename U >
bool FIFE::operator== ( const SharedPtr< T > &  lhs,
const SharedPtr< U > &  rhs 
) [inline]

provides equality operator for shared pointers

Definition at line 252 of file sharedptr.h.

References FIFE::SharedPtr< T >::get().

uint32_t FIFE::scaleTime ( float  multiplier,
uint32_t  ticks 
)

Utility function to calculate time scaling. Mostly done to avoid littering other code with related casting

Returns:
multiplier * ticks
void FIFE::SDL_BlendRow_RGBA4_to_RGB565 ( const uint8_t *  src,
uint8_t *  dst,
uint32_t  alpha,
int32_t  n 
)

Blends one row of n pixels from src with n pixels of dst.

Parameters:
src Source.
dst Destiny.
alpha Level of alphablending.
n Number of pixels.

< upgrade to range 0-255

multiplying by alpha resulted in shift.

void FIFE::SDL_BlendRow_RGBA8_to_RGB565 ( const uint8_t *  src,
uint8_t *  dst,
uint32_t  alpha,
int32_t  n 
)

Blends one row of n pixels from src with n pixels of dst.

Parameters:
src Source.
dst Destiny.
alpha Level of alphablending.
n Number of pixels.
void FIFE::SDL_BlendRow_RGBA8_to_RGB8 ( const uint8_t *  src,
uint8_t *  dst,
uint32_t  alpha,
int32_t  n 
)

Blends one row of n pixels from src with n pixels of dst.

Parameters:
src Source.
dst Destiny.
alpha Level of alphablending.
n Number of pixels.
void FIFE::SDL_BlendRow_RGBA8_to_RGBA8 ( const uint8_t *  src,
uint8_t *  dst,
uint32_t  alpha,
int32_t  n 
)

Blends one row of n pixels from src with n pixels of dst.

Parameters:
src Source.
dst Destiny.
alpha Level of alphablending.
n Number of pixels.
Generated on Wed Feb 22 2012 00:00:23 for FIFE by  doxygen 1.7.1