Provided by: libcoin80-doc_3.1.4~abc9f50-4ubuntu2_all 
NAME
SoFont -
The SoFont class is an appearance node for setting fonts.
Successive text rendering nodes (like SoText2, SoText3, SoAsciiText, etc) will use the
font specified from an SoFont node when visualizing text.
SYNOPSIS
#include <Inventor/nodes/SoFont.h>
Inherits SoNode.
Inherited by SoFontStyle.
Public Member Functions
virtual SoType getTypeId (void) const
Returns the type identification of an object derived from a class inheriting SoBase.
This is used for run-time type checking and 'downward' casting.
SoFont (void)
virtual void doAction (SoAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void pick (SoPickAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
Static Public Member Functions
static SoType getClassTypeId (void)
static void initClass (void)
Public Attributes
SoSFName name
SoSFFloat size
Protected Member Functions
virtual const SoFieldData * getFieldData (void) const
virtual ~SoFont ()
Static Protected Member Functions
static const SoFieldData ** getFieldDataPtr (void)
Additional Inherited Members
Detailed Description
The SoFont class is an appearance node for setting fonts.
Successive text rendering nodes (like SoText2, SoText3, SoAsciiText, etc) will use the
font specified from an SoFont node when visualizing text.
The font name is recognized with the form 'family:style'. The range of supported font
families depends on which fonts are installed on the system. A typical font family might
be 'Arial' or 'Times New Roman'.
Style is either 'Bold', 'Italic' or 'Bold Italic'.
Spaces before or after the ':' will be ignored.
If a good match for the chosen font cannot be found, the default font will be loaded
instead. The default 2D font is a builtin 8x12 points font. The 3D font is a serif font
ala Times New Roman. It is not possible to apply styles to any of the builtin fonts. It is
not possible to specify a size for the default 2D font.
One can explicitly select the default font by setting 'defaultFont' as the font name, or
by just leaving the SoFont::name field alone, as it has that value by default. In that
regard, note that SoFont does not inherit / accumulate any parts from earlier SoFont-
nodes, even when one or both of its fields are left blank in e.g. an iv-file, like this:
#Inventor V2.1 ascii
Font { name "Helvetica" size 50 }
Text2 { string "hepp" }
Translation { translation 5 80 0 }
BaseColor { rgb 1 1 0 }
Font { size 30 }
Text2 { string "svupp" }
(The second string in the above example will be rendered with the default built-in font,
not in Helvetica.)
The default fonts are always accessible by Coin as they are embedded into the run-time
library. If one needs to guarantee that the text will have the same appearance under all
circumstances, the default font will be a safe choice. Another solution might be to use
the FreeType font engine and explicitly name a font-file. This is described in more detail
below.
Here is a simple example on how to print a string using a bold and italic Arial font:
#Inventor V2.1 ascii
Separator {
Font {
name "Arial:Bold Italic"
size 14
}
Text2 {
string ["This is a", "Coin font test"]
justification CENTER
}
}
Coin has support for two different font APIs. On non-Windows platforms, the FreeType
library together with the optional Fontconfig library is used.
If the Fontconfig library is installed the font file on the sytem for a given font name
will be located through it. For more information on Fontconfig see
http://freedesktop.org/software/fontconfig . Additionally Fontconfig allows to match
specific fonts through its own pattern matching format (see
http://pdx.freedesktop.org/~fontconfig/fontconfig-user.html). Please note that the point
size value in the textual representation of the Fontconfig pattern is currently overriden
by the size field of the SoFont node and if no size field is specified the default value
of the size field is in effect. In case you intend to use your application on systems
where the Fontconfig library is expected to be not installed you should not make use of
Fontconfig's font pattern syntax. Fontconfig usage can be prevented by setting the
'COIN_FORCE_FONTCONFIG_OFF' environment variable to 1.
Here is an example on how to print a string using the Fontconfig pattern matching syntax
using a bold & italic font where Times New Roman is the preferred font family.
#Inventor V2.1 ascii
Separator {
Font {
name "Times New Roman,Arial,Helvetica:italic:bold"
size 24
}
Text2 {
string ["This is a", "Coin font test"]
justification CENTER
}
}
On Windows the Win32 GDI library is used. FreeType and Fontconfig are dynamically loaded
on demand by Coin if font support are requested by a node. When fontsupport is loaded on
Windows, FreeType will have precedence over Win32 if located. This can be prevented by
setting the 'COIN_FORCE_FREETYPE_OFF' environment variable to 1. When using FreeType, you
need FreeType version 2.1 or later. On Mac OS X, version 2.1.7 or later is required.
If Coin cannot load the FreeType library, and is not running on Microsoft Windows, only
the default fonts will be accessible.
It is possible to specify the TrueType font file directly if FreeType is used as the font
engine. This is done by including the '.ttf' in the filename, i.e. 'Comic_Sans_MS.ttf'.
Coin will then search the local path for the running program and then the path specified
by the 'COIN_FONT_PATH' environment variable. If the program is using FreeType on a
Windows platform, the '$WINDIR/Fonts' directory will also be searched.
It is not possible to directly specify a TrueType font file if Windows is handling the
fonts. This is due to the way Windows is accessing the fonts through the system registry.
All fonts must therefore be properly installed and given a system name. Open the 'Control
Panel' and double click on the 'Fonts' icon for an overview of installed fonts and their
names.
Beware that some non-English versions of Windows are using different name for the styles
(i.e. 'Italique' instead of 'Italic'). These names are supported in Coin, but it is
recommended for portability purposes to only use the English terms. Please note that there
is still a possibility that there are no fonts installed using the terms 'Bold' or
'Italic' on the Windows platform. To guarantee that a font is accessible you must either
use the FreeType library and include a TrueType font in your distribution, or you must
avoid using styles and stick to the standard Windows fonts.
If the 'COIN_DEBUG_FONTSUPPORT' environment variable is set to 1, an extensive amount of
information about loading, initializing and using fonts will be output. Issues like
missing fonts and other related problems will then be reported, so we advice you to first
try to use that debugging option when something does not work quite as expected.
FILE FORMAT/DEFAULTS:
Font {
name "defaultFont"
size 10
}
See Also:
SoFontStyle, SoText2, SoText3, SoAsciiText
Constructor & Destructor Documentation
SoFont::SoFont (void)
Constructor.
SoFont::~SoFont () [protected], [virtual]
Destructor.
Member Function Documentation
SoType SoFont::getTypeId (void) const [virtual]
Returns the type identification of an object derived from a class inheriting SoBase. This
is used for run-time type checking and 'downward' casting. Usage example:
void foo(SoNode * node)
{
if (node->getTypeId() == SoFile::getClassTypeId()) {
SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type
}
}
For application programmers wanting to extend the library with new nodes, engines,
nodekits, draggers or others: this method needs to be overridden in all subclasses. This
is typically done as part of setting up the full type system for extension classes, which
is usually accomplished by using the pre-defined macros available through for instance
Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes),
Inventor/engines/SoSubEngine.h (for engine classes) and so on.
For more information on writing Coin extensions, see the class documentation of the
toplevel superclasses for the various class groups.
Implements SoBase.
Reimplemented in SoFontStyle.
const SoFieldData * SoFont::getFieldData (void) const [protected], [virtual]
Returns a pointer to the class-wide field data storage object for this instance. If no
fields are present, returns NULL.
Reimplemented from SoFieldContainer.
Reimplemented in SoFontStyle.
void SoFont::doAction (SoAction *action) [virtual]
This function performs the typical operation of a node for any action.
Reimplemented from SoNode.
Reimplemented in SoFontStyle.
void SoFont::getBoundingBox (SoGetBoundingBoxAction *action) [virtual]
Action method for the SoGetBoundingBoxAction.
Calculates bounding box and center coordinates for node and modifies the values of the
action to encompass the bounding box for this node and to shift the center point for the
scene more towards the one for this node.
Nodes influencing how geometry nodes calculates their bounding box also overrides this
method to change the relevant state variables.
Reimplemented from SoNode.
Reimplemented in SoFontStyle.
void SoFont::GLRender (SoGLRenderAction *action) [virtual]
Action method for the SoGLRenderAction.
This is called during rendering traversals. Nodes influencing the rendering state in any
way or who wants to throw geometry primitives at OpenGL overrides this method.
Reimplemented from SoNode.
Reimplemented in SoFontStyle.
void SoFont::callback (SoCallbackAction *action) [virtual]
Action method for SoCallbackAction.
Simply updates the state according to how the node behaves for the render action, so the
application programmer can use the SoCallbackAction for extracting information about the
scene graph.
Reimplemented from SoNode.
Reimplemented in SoFontStyle.
void SoFont::pick (SoPickAction *action) [virtual]
Action method for SoPickAction.
Does common processing for SoPickAction action instances.
Reimplemented from SoNode.
Reimplemented in SoFontStyle.
void SoFont::getPrimitiveCount (SoGetPrimitiveCountAction *action) [virtual]
Action method for the SoGetPrimitiveCountAction.
Calculates the number of triangle, line segment and point primitives for the node and adds
these to the counters of the action.
Nodes influencing how geometry nodes calculates their primitive count also overrides this
method to change the relevant state variables.
Reimplemented from SoNode.
Reimplemented in SoFontStyle.
Member Data Documentation
SoSFName SoFont::name
Name of font.
Which fontnames are available is rather system dependent, not only on whether or not you
are running on a UNIX/Linux system, Microsoft Windows or whatever, but also on which fonts
and font types (like TrueType) are installed on a particular user's system.
All font rendering nodes have a built-in fallback font to use, though, so even though Coin
can not find a font on the system of the specified type, the text should be rendered
somehow.
In summation, consider this node type and this particular field as a hint to the font
rendering engines of Coin, and do not base your models on a particular font being
available.
SoSFFloat SoFont::size
Size of font. Defaults to 10.0.
For 2D rendered bitmap fonts (like for SoText2), this value is the height of a character
in screen pixels. For 3D text, this value is the world-space coordinates height of a
character in the current units setting (see documentation for SoUnits node).
Author
Generated automatically by Doxygen for Coin from the source code.