Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
osg::TextGlyph

osg::TextGlyph Class Reference

#include <OSGTextGlyph.h>

Inheritance diagram for osg::TextGlyph:

osg::TextPixmapGlyph osg::TextTXFGlyph osg::TextVectorGlyph List of all members.

Public Types

typedef Int32 Index
enum  { INVALID_INDEX = -1 }

Public Member Functions

virtual ~TextGlyph ()
Index getGlyphIndex () const
Real32 getHoriAdvance () const
Real32 getVertAdvance () const
virtual Real32 getWidth () const =0
virtual Real32 getHeight () const =0
virtual Real32 getHoriBearingX () const =0
virtual Real32 getHoriBearingY () const =0
virtual Real32 getVertBearingX () const =0
virtual Real32 getVertBearingY () const =0

Protected Member Functions

 TextGlyph ()

Protected Attributes

Index _glyphIndex
Real32 _horiAdvance
Real32 _vertAdvance

Private Member Functions

 TextGlyph (const TextGlyph &other)
const TextGlyph & operator= (const TextGlyph &other)

Detailed Description

Abstract base class of all glyphes.
Author:
Patrick Dähne

Definition at line 59 of file OSGTextGlyph.h.

Member Typedef Documentation

typedef Int32 osg::TextGlyph::Index
 

Defines the glyph index

Definition at line 65 of file OSGTextGlyph.h.

Member Enumeration Documentation

anonymous enum
 

Defines the invalid glyph index

Enumerator:
INVALID_INDEX 

Definition at line 68 of file OSGTextGlyph.h.

00068 { INVALID_INDEX = -1 };

Constructor & Destructor Documentation

osg::TextGlyph::~TextGlyph (   )  [virtual]
 

Destroys the Glyph object.

Definition at line 49 of file OSGTextGlyph.cpp.

00049 {}

osg::TextGlyph::TextGlyph (   )  [inline, protected]
 

Creates a new Glyph object.

Definition at line 52 of file OSGTextGlyph.inl.

00053 : _glyphIndex(INVALID_INDEX), _horiAdvance(0.f), _vertAdvance(0.f)
00054 {}

osg::TextGlyph::TextGlyph (  const TextGlyph &  other  )  [private]
 

Copy constructor (not implemented!)

Member Function Documentation

TextGlyph::Index osg::TextGlyph::getGlyphIndex (   )  const [inline]
 

Returns the index of the glyph.

Returns:
The index of the glyph

Definition at line 43 of file OSGTextGlyph.inl.

References _glyphIndex.

00043 { return _glyphIndex; }

Real32 osg::TextGlyph::getHoriAdvance (   )  const [inline]
 

Returns the advance of the glyph for horizontal layout. The advance is the distance to the next character on the base line.

Returns:
The advance for horizontal layout

Definition at line 46 of file OSGTextGlyph.inl.

References _horiAdvance.

00046 { return _horiAdvance; }

Real32 osg::TextGlyph::getVertAdvance (   )  const [inline]
 

Returns the advance of the glyph for vertical layout. The advance is the distance to the next character on the base line. This value is usually negative!

Returns:
The advance for vertical layout

Definition at line 49 of file OSGTextGlyph.inl.

References _vertAdvance.

00049 { return _vertAdvance; }

virtual Real32 osg::TextGlyph::getWidth (   )  const [pure virtual]
 

Returns the width of the glyph.

Returns:
The width of the glyph

Implemented in osg::TextPixmapGlyph, osg::TextTXFGlyph, and osg::TextVectorGlyph.

Referenced by osg::TextFace::calculateBoundingBox().

virtual Real32 osg::TextGlyph::getHeight (   )  const [pure virtual]
 

Returns the height of the glyph.

Returns:
The height of the glyph

Implemented in osg::TextPixmapGlyph, osg::TextTXFGlyph, and osg::TextVectorGlyph.

Referenced by osg::TextFace::calculateBoundingBox().

virtual Real32 osg::TextGlyph::getHoriBearingX (   )  const [pure virtual]
 

Returns the x bearing of the glyph for horizontal layout. The x bearing is the distance from the origin to the left border of the glyph.

Returns:
The x bearing of the glyph for horizontal layout

Implemented in osg::TextPixmapGlyph, osg::TextTXFGlyph, and osg::TextVectorGlyph.

virtual Real32 osg::TextGlyph::getHoriBearingY (   )  const [pure virtual]
 

Returns the y bearing of the glyph for horizontal layout. The y bearing is the distance from the origin to the top border of the glyph.

Returns:
The y bearing of the glyph for horizontal layout

Implemented in osg::TextPixmapGlyph, osg::TextTXFGlyph, and osg::TextVectorGlyph.

virtual Real32 osg::TextGlyph::getVertBearingX (   )  const [pure virtual]
 

Returns the x bearing of the glyph for vertical layout. The x bearing is the distance from the origin to the left border of the glyph.

Returns:
The x bearing of the glyph for vertical layout

Implemented in osg::TextPixmapGlyph, osg::TextTXFGlyph, and osg::TextVectorGlyph.

virtual Real32 osg::TextGlyph::getVertBearingY (   )  const [pure virtual]
 

Returns the y bearing of the glyph for vertical layout. The y bearing is the distance from the origin to the top border of the glyph.

Returns:
The y bearing of the glyph for vertical layout

Implemented in osg::TextPixmapGlyph, osg::TextTXFGlyph, and osg::TextVectorGlyph.

const TextGlyph& osg::TextGlyph::operator= (  const TextGlyph &  other  )  [private]
 

Copy operator (not implemented!)

Member Data Documentation

Index osg::TextGlyph::_glyphIndex [protected]
 

The index of the glyph

Definition at line 145 of file OSGTextGlyph.h.

Referenced by getGlyphIndex().

Real32 osg::TextGlyph::_horiAdvance [protected]
 

The advance of the glyph for horizontal layout

Definition at line 148 of file OSGTextGlyph.h.

Referenced by getHoriAdvance().

Real32 osg::TextGlyph::_vertAdvance [protected]
 

The advance of the glyph for vertical layout

Definition at line 151 of file OSGTextGlyph.h.

Referenced by getVertAdvance().

The documentation for this class was generated from the following files:
Generated on Thu Aug 25 04:23:03 2005 for OpenSG by  doxygen 1.4.3