Differences between revisions 1 and 26 (spanning 25 versions)
Revision 1 as of 2008-04-21 09:06:25
Size: 21
Editor: hih-kn-2301-01
Comment:
Revision 26 as of 2014-04-09 09:02:05
Size: 2256
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#acl FriedemannBunjes:read,write,delete,revert All:read
#format wiki
#language en
#pragma section-numbers 2
Line 2: Line 7:
<<TableOfContents(2)>>

== doxygen generated API reference ==

The automatically generated class reference can be read at [[https://134.2.114.126/nrec-doku/annotated.html|this location]]. It has been generated with the nice [[http://www.stack.nl/~dimitri/doxygen/|doxygen]] tool.

== Object Model ==

With the tool [[http://freemind.sourceforge.net/wiki/index.php/Main_Page|freemind]] we have created a [[attachment:objektmodell.mm|diagram]] showing [[https://134.2.114.126/nrec-doku/objektmodell.html|some of the nrec objects]] and their relationships:

[[https://134.2.114.126/nrec-doku/objektmodell.html|{{https://134.2.114.126/nrec-doku/objektmodell.html_files/image.png|height="300"|width="200"}}]]

== Using Font Primitives ==

nrec uses a special bitmap file format (.bmf) for fonts. There is a command line tool called {{{ttf2bmf}}} that can be used to convert ttf font files into bmf files.
The font size specified defines the file size and the resolution of the font
bitmaps and defaults to 12.
The program, its source code and some example files are located in the folder {{{run/Fonts}}}.

Usage:
{{{
./ttf2bmf fontfile outputfile [fontsize]
}}}

Examples:
{{{
$ ./ttf2bmf LucidaTypewriterRegular.ttf default.bmf 24
./ttf2bmf: Wrote default.bmf, 256 by 256 pixels.
$ ./ttf2bmf LucidaTypewriterRegular.ttf default.bmf 10
./ttf2bmf: Wrote default.bmf, 256 by 64 pixels.
$ ./ttf2bmf LucidaTypewriterRegular.ttf default.bmf 48
./ttf2bmf: Wrote default.bmf, 256 by 1024 pixels.
$ ./ttf2bmf LucidaTypewriterRegular.ttf default.bmf
./ttf2bmf: Wrote default.bmf, 256 by 128 pixels.
}}}

== Understanding the logger mechanism ==

The Logger is used to transfer messages between different threads running at different priority.
[[UnderstandingTheLogger|Here is an illustration on how it works and an example of a LogReader implementation.]]

== FlowCondFixation and all it's actions ==

{{attachment:FlowCondFixation.png}}

== PrimitiveControllerColorChangeOnStatus and it's timing ==

{{attachment:CPrimitiveControllerColorChangeOnStatus.jpeg|height="20"|width="300"}}}}

Design Concepts

1. doxygen generated API reference

The automatically generated class reference can be read at this location. It has been generated with the nice doxygen tool.

2. Object Model

With the tool freemind we have created a diagram showing some of the nrec objects and their relationships:

height="300"

3. Using Font Primitives

nrec uses a special bitmap file format (.bmf) for fonts. There is a command line tool called ttf2bmf that can be used to convert ttf font files into bmf files. The font size specified defines the file size and the resolution of the font bitmaps and defaults to 12. The program, its source code and some example files are located in the folder run/Fonts.

Usage:

./ttf2bmf fontfile outputfile [fontsize]

Examples:

$ ./ttf2bmf LucidaTypewriterRegular.ttf default.bmf 24
./ttf2bmf: Wrote default.bmf, 256 by 256 pixels.
$ ./ttf2bmf LucidaTypewriterRegular.ttf default.bmf 10
./ttf2bmf: Wrote default.bmf, 256 by 64 pixels.
$ ./ttf2bmf LucidaTypewriterRegular.ttf default.bmf 48
./ttf2bmf: Wrote default.bmf, 256 by 1024 pixels.
$ ./ttf2bmf LucidaTypewriterRegular.ttf default.bmf
./ttf2bmf: Wrote default.bmf, 256 by 128 pixels.

4. Understanding the logger mechanism

The Logger is used to transfer messages between different threads running at different priority. Here is an illustration on how it works and an example of a LogReader implementation.

5. FlowCondFixation and all it's actions

FlowCondFixation.png

6. PrimitiveControllerColorChangeOnStatus and it's timing

height="20"}}

nrec: DesignInformation (last edited 2017-05-19 08:53:00 by FriedemannBunjes)