NAME

       SoFontStyle -

       The SoFontStyle class changes the appearance of fonts for text rendering nodes.

       Successive text rendering nodes will use fonts with the style settings of this node, if a
       font with the given settings can be found and loaded from the system.

SYNOPSIS

       #include <Inventor/nodes/SoFontStyle.h>

       Inherits SoFont.

   Public Types
       enum Family { SERIF, SANS, TYPEWRITER }
       enum Style { NONE, BOLD, ITALIC }

   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.
       SoFontStyle (void)
       SbString getFontName (void) const
       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
       SoSFEnum family
       SoSFBitMask style

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoFontStyle ()

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)

   Additional Inherited Members

Detailed Description

       The SoFontStyle class changes the appearance of fonts for text rendering nodes.

       Successive text rendering nodes will use fonts with the style settings of this node, if a
       font with the given settings can be found and loaded from the system.

       If the specified font style cannot be found on the client system, a default fallback will
       be used. So the application programmer must consider SoFontStyle nodes as nodes giving
       hints about font settings, as you are not guaranteed to get exactly what you want.

       Currently the SERIF family is mapped to 'Times New Roman', SANS is mapped to 'Arial' and
       TYPEWRITER is mapped to 'Courier New'.

       Please note that this node is inheriting SoFont. Previous font settings in a branch will
       therefore be overwritten with the default values of SoFont if an empty SoFontStyle node is
       inserted in the branch.

       NB! This node is provided for reasons of compatibility with Open Inventor 2.1 but will in
       most cases result in the default font being rendered. It is highly recommended to use the
       SoFont node instead.

       FILE FORMAT/DEFAULTS:

       FontStyle {
           name "defaultFont"
           size 10
           family SERIF
           style ()
       }

       Since:
           Inventor 2.1

       See Also:
           SoFont, SoText2, SoText3, SoAsciiText

Member Enumeration Documentation

   enum SoFontStyle::Family
       Enumeration of the font family to use.

   enum SoFontStyle::Style
       Enumeration of font style characteristics.

Constructor & Destructor Documentation

   SoFontStyle::SoFontStyle (void)
       Constructor.

   SoFontStyle::~SoFontStyle () [protected],  [virtual]
       Destructor.

Member Function Documentation

   SoType SoFontStyle::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.

       Reimplemented from SoFont.

   const SoFieldData * SoFontStyle::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 SoFont.

   SbString SoFontStyle::getFontName (void) const
       Returns a system-specific text string to use for font loading, based on the style settings
       of this node.

   void SoFontStyle::doAction (SoAction *action) [virtual]
       This function performs the typical operation of a node for any action.

       Reimplemented from SoFont.

   void SoFontStyle::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 SoFont.

   void SoFontStyle::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 SoFont.

   void SoFontStyle::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 SoFont.

   void SoFontStyle::pick (SoPickAction *action) [virtual]
       Action method for SoPickAction.

       Does common processing for SoPickAction action instances.

       Reimplemented from SoFont.

   void SoFontStyle::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 SoFont.

Member Data Documentation

   SoSFEnum SoFontStyle::family
       Font family hint.

   SoSFBitMask SoFontStyle::style
       Font style hint.

Author

       Generated automatically by Doxygen for Coin from the source code.