diff options
Diffstat (limited to 'docs/doxygen/nel/a03946.html')
| -rw-r--r-- | docs/doxygen/nel/a03946.html | 333 |
1 files changed, 333 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03946.html b/docs/doxygen/nel/a03946.html new file mode 100644 index 00000000..85f6630a --- /dev/null +++ b/docs/doxygen/nel/a03946.html @@ -0,0 +1,333 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>NeL: NL3D::UTextContext::CStringInfo struct Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.6 --> +<div class="qindex"> <form class="search" action="search.php" method="get"> +<a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NL3D::UTextContext::CStringInfo Struct Reference</h1><code>#include <<a class="el" href="a06631.html">u_text_context.h</a>></code> +<p> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The render size of a string. +<p> + +<p> +Definition at line <a class="el" href="a06631.html#l00087">87</a> of file <a class="el" href="a06631.html">u_text_context.h</a>.<table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoa0">convertTo01Size</a> (<a class="el" href="a02438.html">UDriver</a> *drv)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">convert size in pixels to size in 0-1 relative coordinates, according to Driver current size <a href="#NL3D_1_1UTextContext_1_1CStringInfoa0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoa1">convertToPixelSize</a> (<a class="el" href="a02438.html">UDriver</a> *drv)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">convert back to pixels size, according to Driver current size <a href="#NL3D_1_1UTextContext_1_1CStringInfoa1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoa2">CStringInfo</a> (float <a class="el" href="a04223.html#a575">w</a>, float h, float l)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoa3">CStringInfo</a> ()</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a03128.html">NLMISC::CVector</a> </td><td class="memItemRight" valign=bottom><a class="el" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoa4">getHotSpotVector</a> (<a class="el" href="a03485.html#NL3D_1_1UTextContextw8">THotSpot</a> hotspot)</td></tr> + +<tr><td colspan=2><br><h2>Data Fields</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo0">StringHeight</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The height of the string, in pixels (eg: 10). <a href="#NL3D_1_1UTextContext_1_1CStringInfoo0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo1">StringLine</a></td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>float </td><td class="memItemRight" valign=bottom><a class="el" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo2">StringWidth</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The width of the string, in pixels (eg: 30). <a href="#NL3D_1_1UTextContext_1_1CStringInfoo2"></a><br><br></td></tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NL3D_1_1UTextContext_1_1CStringInfoa3" doxytag="NL3D::UTextContext::CStringInfo::CStringInfo" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NL3D::UTextContext::CStringInfo::CStringInfo </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06631.html#l00100">100</a> of file <a class="el" href="a06631.html">u_text_context.h</a>. +<p> +<div class="fragment"><pre>00100 {<a class="code" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo2">StringWidth</a>= <a class="code" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo0">StringHeight</a>= <a class="code" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo1">StringLine</a>= 0;} +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1UTextContext_1_1CStringInfoa2" doxytag="NL3D::UTextContext::CStringInfo::CStringInfo" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NL3D::UTextContext::CStringInfo::CStringInfo </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname" nowrap> <em>w</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>h</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>l</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [inline]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a06631.html#l00101">101</a> of file <a class="el" href="a06631.html">u_text_context.h</a>. +<p> +References <a class="el" href="a05646.html#l00236">w</a>. +<p> +<div class="fragment"><pre>00101 {<a class="code" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo2">StringWidth</a>= <a class="code" href="a04223.html#a575">w</a>; <a class="code" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo0">StringHeight</a>= h; <a class="code" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo1">StringLine</a> = <a class="code" href="a05373.html#a2">l</a>;} +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NL3D_1_1UTextContext_1_1CStringInfoa0" doxytag="NL3D::UTextContext::CStringInfo::convertTo01Size" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NL3D::UTextContext::CStringInfo::convertTo01Size </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02438.html">UDriver</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>drv</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +convert size in pixels to size in 0-1 relative coordinates, according to Driver current size +<p> + +<p> +Definition at line <a class="el" href="a06503.html#l00081">81</a> of file <a class="el" href="a06503.html">text_context_user.cpp</a>. +<p> +References <a class="el" href="a02438.html#NL3D_1_1UDriverz1414_11">NL3D::UDriver::getWindowSize()</a>, <a class="el" href="a05981.html#l00100">uint32</a>, and <a class="el" href="a05646.html#l00236">w</a>. +<p> +<div class="fragment"><pre>00082 { +00083 <a class="code" href="a04558.html#a11">uint32</a> <a class="code" href="a04223.html#a575">w</a>,h; +00084 drv->getWindowSize(w,h); +00085 <a class="code" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo2">StringWidth</a>/= <a class="code" href="a04223.html#a575">w</a>; +00086 <a class="code" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo0">StringHeight</a>/= h; +00087 <a class="code" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo1">StringLine</a>/= h; +00088 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1UTextContext_1_1CStringInfoa1" doxytag="NL3D::UTextContext::CStringInfo::convertToPixelSize" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NL3D::UTextContext::CStringInfo::convertToPixelSize </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02438.html">UDriver</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>drv</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +convert back to pixels size, according to Driver current size +<p> + +<p> +Definition at line <a class="el" href="a06503.html#l00089">89</a> of file <a class="el" href="a06503.html">text_context_user.cpp</a>. +<p> +References <a class="el" href="a02438.html#NL3D_1_1UDriverz1414_11">NL3D::UDriver::getWindowSize()</a>, <a class="el" href="a05981.html#l00100">uint32</a>, and <a class="el" href="a05646.html#l00236">w</a>. +<p> +<div class="fragment"><pre>00090 { +00091 <a class="code" href="a04558.html#a11">uint32</a> <a class="code" href="a04223.html#a575">w</a>,h; +00092 drv->getWindowSize(w,h); +00093 <a class="code" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo2">StringWidth</a>*= <a class="code" href="a04223.html#a575">w</a>; +00094 <a class="code" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo0">StringHeight</a>*= h; +00095 <a class="code" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo1">StringLine</a>*= h; +00096 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1UTextContext_1_1CStringInfoa4" doxytag="NL3D::UTextContext::CStringInfo::getHotSpotVector" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a03128.html">NLMISC::CVector</a> NL3D::UTextContext::CStringInfo::getHotSpotVector </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03485.html#NL3D_1_1UTextContextw8">THotSpot</a> </td> + <td class="mdname1" valign="top" nowrap> <em>hotspot</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the string's origin <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign=top><em>hotspot</em> </td><td>the origin of the string</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NL3D_1_1UTextContext_1_1CStringInfoo0" doxytag="NL3D::UTextContext::CStringInfo::StringHeight" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float <a class="el" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo0">NL3D::UTextContext::CStringInfo::StringHeight</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The height of the string, in pixels (eg: 10). +<p> + +<p> +Definition at line <a class="el" href="a06631.html#l00092">92</a> of file <a class="el" href="a06631.html">u_text_context.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1UTextContext_1_1CStringInfoo1" doxytag="NL3D::UTextContext::CStringInfo::StringLine" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float <a class="el" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo1">NL3D::UTextContext::CStringInfo::StringLine</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +StringLine is the size from bottom of the whole string image to the hotspot in pixels. for instance if the hotspot is bottomLeft the imaginary line of the string "bpc" is under the b, under the loop of the p but over the leg of the p. So StringLine is a positive value in this case. It may be a negative value for the string "^" for example. +<p> +Definition at line <a class="el" href="a06631.html#l00098">98</a> of file <a class="el" href="a06631.html">u_text_context.h</a>. </td> + </tr> +</table> +<a class="anchor" name="NL3D_1_1UTextContext_1_1CStringInfoo2" doxytag="NL3D::UTextContext::CStringInfo::StringWidth" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float <a class="el" href="a03946.html#NL3D_1_1UTextContext_1_1CStringInfoo2">NL3D::UTextContext::CStringInfo::StringWidth</a> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The width of the string, in pixels (eg: 30). +<p> + +<p> +Definition at line <a class="el" href="a06631.html#l00090">90</a> of file <a class="el" href="a06631.html">u_text_context.h</a>. </td> + </tr> +</table> +<hr>The documentation for this struct was generated from the following files:<ul> +<li><a class="el" href="a06631.html">u_text_context.h</a><li><a class="el" href="a06503.html">text_context_user.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 08:51:15 2004 for NeL by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.6 </small></address> +</body> +</html> |