Inventor/nodes/SoTextProperty.h

Go to the documentation of this file.

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Nicolas DAGUISE (Nov 2004)
**=======================================================================*/



#ifndef  _SO_TEXT_PROPERTY_
#define  _SO_TEXT_PROPERTY_

#include <Inventor/nodes/SoNode.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFVec2i32.h>
#include <Inventor/fields/SoSFBitMask.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoMFColorRGBA.h>
#include <Inventor/fields/SoMFBool.h>
#include <Inventor/elements/SoTextStyleElement.h>

class  SoTextProperty : public SoNode {

 SO_NODE_HEADER(SoTextProperty) ;
  
 public:
  SoTextProperty();

  inline virtual void setOverride(const SbBool state)
  { override.setValue(state); }

  inline virtual SbBool isOverride() const
  { return override.getValue(); }

  SoSFFloat aliasingFactor;

  enum AlignmentH {
    LEFT = 0x01,

    CENTER = 0x03,

    RIGHT = 0x02
  };

  SoSFEnum alignmentH;

  enum AlignmentV {
    TOP = 0x01,

    HALF = 0x03,

    BASE = 0x04,

    BOTTOM = 0x05
  };

  SoSFEnum alignmentV;

  SoSFFloat backFrameLineWidth;

  SoSFBool kerning ;

  enum Orientation {
    LEFT_TO_RIGHT = 0x01,

    RIGHT_TO_LEFT = 0x02,

    TOP_TO_BOTTOM = 0x03,

    BOTTOM_TO_TOP = 0x04
  };

  SoSFEnum orientation;

  SoSFVec2i32 textureQualityRange;

  enum Style
  {
    NONE = SoTextStyleElement::NONE,
    UNDERLINE = SoTextStyleElement::UNDERLINE,
    STRIKETHROUGH = SoTextStyleElement::STRIKETHROUGH,
    DOUBLE_STRIKETHROUGH = SoTextStyleElement::DOUBLE_STRIKETHROUGH,
    BACK_FRAME = SoTextStyleElement::BACK_FRAME,
    BACK_FRAME_LINE = SoTextStyleElement::BACK_FRAME_LINE,
    OVERLINE = SoTextStyleElement::OVERLINE
  };

  SoSFBitMask style;

  enum StyleColor
  {
    UNDERLINE_COLOR,
    STRIKETHROUGH_COLOR,
    DOUBLE_STRIKETHROUGH_COLOR,
    BACK_FRAME_COLOR,
    BACK_FRAME_LINE_COLOR,
    OVERLINE_COLOR,
    NUM_EFFECTS_COLORS
  };

  SoMFColorRGBA styleColors;

  SoSFFloat margin;

  SoMFBool styleColorsUseCurrentMaterial;

  SoSFFloat characterSpacing;

  SoSFBool enableTextAccumulation;

private:
  virtual void  doAction(SoAction *action);
  virtual void  GLRender(SoGLRenderAction *action);
  virtual void  callback(SoCallbackAction *action);
  virtual void  pick(SoPickAction *action);
  virtual void  getBoundingBox(SoGetBoundingBoxAction *action);
  virtual void  getPrimitiveCount(SoGetPrimitiveCountAction *action);

private:
  // Init the class
  static void initClass();
  static void exitClass();

  SoSFBool override;

private:
  virtual ~SoTextProperty();
} ;

/*----------------------------------------------------------------------------*/

#endif // _SO_TEXT_PROPERTY_

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/