Home

nevrax.com

Nevrax.org News Mailing-list Documentation CVS Bugs License

Documentation                       Search   NL3D::UTextContext Class Reference A game interface to render string. More... #include <u_text_context.h> Inheritance diagram for NL3D::UTextContext: List of all members. Public Types enum   THotSpot {   BottomLeft = 0, MiddleLeft, TopLeft, MiddleBottom,   MiddleMiddle, MiddleTop, BottomRight, MiddleRight,   TopRight, HotSpotCount } Public Methods virtual void  dumpCacheTexture (const char *filename)=0   Used for debug. More... Text look. virtual void  setColor (NLMISC::CRGBA color)=0   set the font color. More... virtual void  setFontSize (uint32 fontSize)=0   set the font size. More... virtual uint32  getFontSize () const=0   get the font size. More... virtual void  setHotSpot (THotSpot hotSpot)=0   set the hot spot. More... virtual THotSpot  getHotSpot () const=0   get the hot spot. More... virtual void  setScaleX (float scaleX)=0   set the X scale. More... virtual void  setScaleY (float scaleY)=0   set the Y scale. More... virtual float  getScaleX () const=0 virtual float  getScaleY () const=0 virtual void  setShaded (bool b)=0   set the shade states. More... virtual bool  getShaded () const=0 virtual void  setShadeExtent (float shext)=0   set the shadow's size. More... virtual void  setKeep800x600Ratio (bool keep)=0   set to true if you want that the font manager look at Driver window size, and resize fontSize so it keeps same size than if it was in 800x600... More... virtual bool  getKeep800x600Ratio () const=0   return keep800x600Ratio state. More... Rendering. virtual uint32  textPush (const char *format,...)=0   compute and add a string to the stack. More... virtual uint32  textPush (const ucstring &str)=0   computes an ucstring and adds the result to the stack. More... virtual void  erase (uint32 i)=0   remove a string from the list. More... virtual CStringInfo  getStringInfo (uint32 i)=0   Get a string information from the list. More... virtual CStringInfo  getStringInfo (const ucstring &ucstr)=0   Get a string information from the ucstring The returned string info is in pixel size per default. More... virtual void  clear ()=0   empty the map. More... virtual void  printAt (float x, float y, uint32 i)=0   print a string of the list (2D method). More... virtual void  printClipAt (float x, float y, uint32 i, float xmin, float ymin, float xmax, float ymax)=0 virtual void  printAt (float x, float y, ucstring ucstr)=0   compute and print a ucstring at the location (2D method) x/y E [0,1]. More... virtual void  printfAt (float x, float y, const char *format,...)=0   compute and print a string at the location (2D method) x/y E [0,1]. More... virtual void  render3D (const NLMISC::CMatrix &mat, ucstring ucstr)=0   compute and render a ucstring at the location (3D method) render3D() use UDriver Matrix context for Frustum/ViewMatrix, but use its own modelmatrix (mat). More... virtual void  render3D (const NLMISC::CMatrix &mat, const char *format,...)=0   compute and render a string at the location (3D method) render3D() use UDriver Matrix context for Frustum/ViewMatrix, but use its own modelmatrix (mat). More... virtual float  getLastXBound () const=0   Return max x coordinate of last string printed. More... Protected Methods Object   UTextContext () virtual  ~UTextContext () Detailed Description A game interface to render string. Author: Lionel Berenguier , Nevrax France Date: 2001 Definition at line 46 of file u_text_context.h. Member Enumeration Documentation enum NL3D::UTextContext::THotSpot   Enumeration values: BottomLeft  MiddleLeft  TopLeft  MiddleBottom  MiddleMiddle  MiddleTop  BottomRight  MiddleRight  TopRight  HotSpotCount  Definition at line 57 of file u_text_context.h. Constructor & Destructor Documentation NL3D::UTextContext::UTextContext (    )  [inline, protected]   Definition at line 51 of file u_text_context.h. virtual NL3D::UTextContext::~UTextContext (    )  [inline, protected, virtual]   Definition at line 52 of file u_text_context.h. Member Function Documentation virtual void NL3D::UTextContext::clear (    )  [pure virtual]   empty the map. Implemented in NL3D::CTextContextUser. virtual void NL3D::UTextContext::dumpCacheTexture (  const char *    filename )  [pure virtual]   Used for debug. Implemented in NL3D::CTextContextUser. virtual void NL3D::UTextContext::erase (  uint32    i )  [pure virtual]   remove a string from the list. Implemented in NL3D::CTextContextUser. virtual uint32 NL3D::UTextContext::getFontSize (    )  const [pure virtual]   get the font size. Returns: the font size Implemented in NL3D::CTextContextUser. virtual THotSpot NL3D::UTextContext::getHotSpot (    )  const [pure virtual]   get the hot spot. Returns: the hot spot Implemented in NL3D::CTextContextUser. virtual bool NL3D::UTextContext::getKeep800x600Ratio (    )  const [pure virtual]   return keep800x600Ratio state. Implemented in NL3D::CTextContextUser. virtual float NL3D::UTextContext::getLastXBound (    )  const [pure virtual]   Return max x coordinate of last string printed. Useful to know if a string goes out of the screen (screen limit is supposed at x==4/3, should actually depend on driver's frustum). Returns: x coordinate Implemented in NL3D::CTextContextUser. virtual float NL3D::UTextContext::getScaleX (    )  const [pure virtual]   Returns: the X scale Implemented in NL3D::CTextContextUser. virtual float NL3D::UTextContext::getScaleY (    )  const [pure virtual]   Returns: the Y scale Implemented in NL3D::CTextContextUser. virtual bool NL3D::UTextContext::getShaded (    )  const [pure virtual]   Returns: the shade state Implemented in NL3D::CTextContextUser. virtual CStringInfo NL3D::UTextContext::getStringInfo (  const ucstring &    ucstr )  [pure virtual]   Get a string information from the ucstring The returned string info is in pixel size per default. Implemented in NL3D::CTextContextUser. virtual CStringInfo NL3D::UTextContext::getStringInfo (  uint32    i )  [pure virtual]   Get a string information from the list. return CStringInfo(0,0) if not found. The returned string info is in pixel size per default. Implemented in NL3D::CTextContextUser. virtual void NL3D::UTextContext::printAt (  float    x, float    y, ucstring    ucstr )  [pure virtual]   compute and print a ucstring at the location (2D method) x/y E [0,1]. Implemented in NL3D::CTextContextUser. virtual void NL3D::UTextContext::printAt (  float    x, float    y, uint32    i )  [pure virtual]   print a string of the list (2D method). x/y E [0,1] (rq : it leaves the string in the stack) Implemented in NL3D::CTextContextUser. virtual void NL3D::UTextContext::printClipAt (  float    x, float    y, uint32    i, float    xmin, float    ymin, float    xmax, float    ymax )  [pure virtual]   Implemented in NL3D::CTextContextUser. virtual void NL3D::UTextContext::printfAt (  float    x, float    y, const char *    format, ...    )  [pure virtual]   compute and print a string at the location (2D method) x/y E [0,1]. Implemented in NL3D::CTextContextUser. virtual void NL3D::UTextContext::render3D (  const NLMISC::CMatrix &    mat, const char *    format, ...    )  [pure virtual]   compute and render a string at the location (3D method) render3D() use UDriver Matrix context for Frustum/ViewMatrix, but use its own modelmatrix (mat). virtual void NL3D::UTextContext::render3D (  const NLMISC::CMatrix &    mat, ucstring    ucstr )  [pure virtual]   compute and render a ucstring at the location (3D method) render3D() use UDriver Matrix context for Frustum/ViewMatrix, but use its own modelmatrix (mat). virtual void NL3D::UTextContext::setColor (  NLMISC::CRGBA    color )  [pure virtual]   set the font color. Parameters: color  the font color Implemented in NL3D::CTextContextUser. virtual void NL3D::UTextContext::setFontSize (  uint32    fontSize )  [pure virtual]   set the font size. Should be called before the first print Parameters: fonSize  the font size Implemented in NL3D::CTextContextUser. virtual void NL3D::UTextContext::setHotSpot (  THotSpot    hotSpot )  [pure virtual]   set the hot spot. Parameters: fonSize  the font size Implemented in NL3D::CTextContextUser. virtual void NL3D::UTextContext::setKeep800x600Ratio (  bool    keep )  [pure virtual]   set to true if you want that the font manager look at Driver window size, and resize fontSize so it keeps same size than if it was in 800x600... Implemented in NL3D::CTextContextUser. virtual void NL3D::UTextContext::setScaleX (  float    scaleX )  [pure virtual]   set the X scale. Parameters: scaleX  the X scale Implemented in NL3D::CTextContextUser. virtual void NL3D::UTextContext::setScaleY (  float    scaleY )  [pure virtual]   set the Y scale. Parameters: scaleY  the Y scale Implemented in NL3D::CTextContextUser. virtual void NL3D::UTextContext::setShaded (  bool    b )  [pure virtual]   set the shade states. Parameters: the  shade state Implemented in NL3D::CTextContextUser. virtual void NL3D::UTextContext::setShadeExtent (  float    shext )  [pure virtual]   set the shadow's size. Parameters: the  shade extent Implemented in NL3D::CTextContextUser. virtual uint32 NL3D::UTextContext::textPush (  const ucstring &    str )  [pure virtual]   computes an ucstring and adds the result to the stack. Parameters: an  ucstring Returns: the index where computed string has been inserted Implemented in NL3D::CTextContextUser. virtual uint32 NL3D::UTextContext::textPush (  const char *    format, ...    )  [pure virtual]   compute and add a string to the stack. Parameters: a  string Returns: the index where string has been inserted Implemented in NL3D::CTextContextUser. The documentation for this class was generated from the following file: u_text_context.h