logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SoAsciiText — simple 3D text shape node

Action Behavior

SoGLRenderAction
          Draws  text  based  on the current font, transformation, drawing style, material, texture, complexity,
          and so on.

     SoRayPickAction
          Performs a pick on the  text.  The  string  index  and  character  position  are  available  from  the
          SoTextDetail.

     SoGetBoundingBoxAction
          Computes the bounding box that encloses the text.

     SoCallbackAction
          If  any  triangle  callbacks  are registered with the action, they will be invoked for each successive
          triangle used to approximate the text geometry.

Description

       This  node  defines  one  or  more  strings of 3D text. In contrast with SoText2, 3D text can be rotated,
       scaled, lighted, and textured, just like all other 3D shapes. In constrast with SoText3,  this  3D  ascii
       text cannot be extruded.

       The  text  origin  is  at  (0,0,0)  after  applying  the current transformation. The scale of the text is
       affected by the size field of the current SoFont as well as the current transformation.

       SoAsciiText uses the current material when rendering. Textures are applied to ascii text as  follows.  On
       the  front  face of the text, the texture origin is at the base point of the first string; the base point
       is at the lower left for justification LEFT, at the lower right for RIGHT, and at the  lower  center  for
       CENTER.  The  texture  is  scaled equally in both S and T dimensions, with the font height representing 1
       unit. S increases to the right on the front face.

Fields

SoMFStringstring
          The text string(s) to display. Each string will appear on its own line.

     SoSFFloatspacing
          Defines the distance (in the negative y direction) between the  base  points  of  successive  strings,
          measured  with respect to the current font height. A value of 1 indicates single spacing, a value of 2
          indicates double spacing, and so on.

     SoSFEnumjustification
          Indicates placement and alignment of strings. With LEFT justification, the left edge of the first line
          is at the (transformed) origin, and all left edges are aligned. RIGHT justification is similar. CENTER
          justification places the center of the first string at the (transformed) origin, with the  centers  of
          all remaining strings aligned under it.

     SoMFFloatwidth
          Defines the width of each text string. Each string will be scaled so that it spans this many units.

File Format/Defaults

AsciiText{string""spacing1justificationLEFTwidth0}

Inherits From

       SoBase > SoFieldContainer > SoNode > SoShape > SoAsciiText

Methods

SoAsciiText()
          Creates an ascii text node with default settings.

     staticSoTypegetClassTypeId()
          Returns type identifier for this class.

Name

       SoAsciiText — simple 3D text shape node

See Also

SoFont,SoFontStyle,SoText2,SoText3,SoTextDetailSoAsciiText(3IV)()

Synopsis

#include<Inventor/nodes/SoAsciiText.h>enumJustification{SoAsciiText::LEFT    Left edges of all strings are aligned
          SoAsciiText::RIGHT   Right edges of all strings are aligned
          SoAsciiText::CENTER  Centers of all strings are aligned
     }

          Fields from class SoAsciiText:

     SoMFStringstringSoSFFloatspacingSoSFEnumjustificationSoMFFloatwidth

          Methods from class SoAsciiText:

                         SoAsciiText()staticSoTypegetClassTypeId()

          Methods from class SoNode:

     voidsetOverride(SbBoolstate)SbBoolisOverride()constSoNode*copy(SbBoolcopyConnections=FALSE)constvirtualSbBoolaffectsState()conststaticSoNode*getByName(constSbName&name)staticintgetByName(constSbName&name,SoNodeList&list)

          Methods from class SoFieldContainer:

     voidsetToDefaults()SbBoolhasDefaultValues()constSbBoolfieldsAreEqual(constSoFieldContainer*fc)constvoidcopyFieldValues(constSoFieldContainer*fc,SbBoolcopyConnections=FALSE)SbBoolset(constchar*fieldDataString)voidget(SbString&fieldDataString)virtualintgetFields(SoFieldList&resultList)constvirtualSoField*getField(constSbName&fieldName)constSbBoolgetFieldName(constSoField*field,SbName&fieldName)constSbBoolisNotifyEnabled()constSbBoolenableNotify(SbBoolflag)

          Methods from class SoBase:

     voidref()voidunref()constvoidunrefNoDelete()constvoidtouch()virtualSoTypegetTypeId()constSbBoolisOfType(SoTypetype)constvirtualvoidsetName(constSbName&name)virtualSbNamegetName()const

See Also