h o m e d o c u m e n t a t i o n c l a s s h i e r a r c h y

ContextFunctions Namespace Reference

Detailed Description

namespace containing all the Context related functions


Functions

LIB_STROKE_EXPORT unsigned GetTimeStampCF ()
LIB_STROKE_EXPORT unsigned GetCanvasWidthCF ()
LIB_STROKE_EXPORT unsigned GetCanvasHeightCF ()
LIB_STROKE_EXPORT void LoadMapCF (const char *iFileName, const char *iMapName, unsigned iNbLevels=4, float iSigma=1.f)
LIB_STROKE_EXPORT float ReadMapPixelCF (const char *iMapName, int level, unsigned x, unsigned y)
LIB_STROKE_EXPORT float ReadCompleteViewMapPixelCF (int level, unsigned x, unsigned y)
LIB_STROKE_EXPORT float ReadDirectionalViewMapPixelCF (int iOrientation, int level, unsigned x, unsigned y)

Function Documentation

LIB_STROKE_EXPORT unsigned GetCanvasHeightCF (   ) 
 

Returns the canvas width

LIB_STROKE_EXPORT unsigned GetCanvasWidthCF (   ) 
 

Returns the canvas width

LIB_STROKE_EXPORT unsigned GetTimeStampCF (   ) 
 

Returns the system time stamp

LIB_STROKE_EXPORT void LoadMapCF (  const char *  iFileName,
const char *  iMapName,
unsigned  iNbLevels = 4,
float  iSigma = 1.f
) 
 

Loads an image map for further reading

LIB_STROKE_EXPORT float ReadCompleteViewMapPixelCF (  int  level,
unsigned  x,
unsigned  y
) 
 

Reads a pixel in the complete view map

Returns:
the floating value stored for that pixel
Parameters:
level The level of the pyramid in which we wish to read the pixel
x The x-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
y The y-coordinate of the pixel we wish to read. The origin is in the lower-left corner.

LIB_STROKE_EXPORT float ReadDirectionalViewMapPixelCF (  int  iOrientation,
int  level,
unsigned  x,
unsigned  y
) 
 

Reads a pixel in one of the oriented view map images

Returns:
the floating value stored for that pixel
Parameters:
iOrientation The number telling which orientation we want to check
level The level of the pyramid in which we wish to read the pixel
x The x-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
y The y-coordinate of the pixel we wish to read. The origin is in the lower-left corner.

LIB_STROKE_EXPORT float ReadMapPixelCF (  const char *  iMapName,
int  level,
unsigned  x,
unsigned  y
) 
 

Reads a pixel in a user-defined map

Returns:
the floating value stored for that pixel
Parameters:
iMapName The name of the map
level The level of the pyramid in which we wish to read the pixel
x The x-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
y The y-coordinate of the pixel we wish to read. The origin is in the lower-left corner.