Text.h

Go to the documentation of this file.

//    Copyright 2004-2019, SenseGraphics AB
//
//    This file is part of H3D API.
//
//    H3D API is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    H3D API is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with H3D API; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//    A commercial license is also available. Please contact us at 
//    www.sensegraphics.com for more information.
//
//
//
#ifndef __TEXT_H__
#define __TEXT_H__
 
#include <H3D/X3DGeometryNode.h>
#include <H3D/X3DFontStyleNode.h>
#include <H3D/MFFloat.h>
#include <H3D/SFFloat.h>
#include <H3D/MFString.h>
#include <H3D/MFVec2f.h>
#include <H3D/SFVec2f.h>
#include <H3D/SFVec3f.h>
#include <H3D/FontStyle.h>
#include <H3D/PeriodicUpdate.h>
 
namespace H3D {
 
  class H3DAPI_API Text : public X3DGeometryNode {
  protected:
    typedef TypedSFNode< X3DFontStyleNode > SFFontStyleNode;
 
    class H3DAPI_API SFBound: 
      public TypedField< X3DGeometryNode::SFBound,
      Types< SFFontStyleNode, MFFloat, SFFloat, MFString > >{
  protected:
      virtual void update();
    }; 
 
    class H3DAPI_API DisplayList : public X3DGeometryNode::DisplayList {
      virtual void callList( bool build_list );
    };
 
    class H3DAPI_API OutputUpdater : 
      public PeriodicUpdate< TypedField< Field, 
                             Types<SFFontStyleNode, MFString> > > {
    protected:
      virtual void update();
    };
 
  public:
    
    Text( Inst< SFNode         > _metadata    = 0,
          Inst< SFBound         > _bound       = 0,
          Inst< DisplayList     > _displayList = 0,
          Inst< SFFontStyleNode > _fontStyle   = 0,
          Inst< MFFloat         > _length      = 0,
          Inst< SFFloat         > _maxExtent   = 0,
          Inst< MFString        > _string      = 0,
          Inst< MFVec2f         > _lineBounds  = 0,
          Inst< SFVec3f         > _origin      = 0,
          Inst< SFVec2f         > _textBounds  = 0, 
          Inst< SFBool          > _solid       = 0,
          Inst< OutputUpdater   > _outputUpdater = 0 );
 
    virtual void render();
 
    // Traverse the scenegraph. See X3DGeometryNode::traverseSG
    // for more info.
    virtual void traverseSG( TraverseInfo& ti ); 
 
    virtual int nrTriangles() {
      return -1;
    }
 
    virtual bool lineIntersect( 
      const Vec3f& from,
      const Vec3f& to,    
      LineIntersectResult& result );
 
    H3DUniquePtr< SFFontStyleNode >  fontStyle;
    
    H3DUniquePtr< MFFloat >  length;
 
    H3DUniquePtr< SFFloat >  maxExtent;
 
    H3DUniquePtr< MFString >  stringF;
 
    H3DUniquePtr< MFVec2f > lineBounds;
 
    H3DUniquePtr< SFVec3f > origin;
 
    H3DUniquePtr< SFVec2f > textBounds;
 
    H3DUniquePtr< SFBool >  solid;
 
    static H3DNodeDatabase database;
 
  protected:
    H3DUniquePtr< OutputUpdater > outputUpdater;
 
    void updateLineBounds();
 
    static AutoRef< FontStyle > default_font_style;
 
    virtual void scaleToMaxExtent( const std::vector< std::string >& text, 
                                   X3DFontStyleNode* font );
    
    virtual void justifyMinor( const std::vector< std::string >& text,
                               X3DFontStyleNode* font );
 
    virtual void moveToNewLine( const std::string& text, X3DFontStyleNode* font );
 
    virtual void renderTextLine( const std::string& text,
                                 X3DFontStyleNode* font );
    
    virtual void justifyLine( const std::string& text,
                              X3DFontStyleNode* font );
  };
}
 
#endif