SoTextDetail(3IV)

NAME
     SoTextDetail (SoTxtDtl) - stores detail information about a text node

INHERITS FROM
     SoDetail > SoTextDetail

SYNOPSIS
     #include <Inventor_c/details/SoTextDetail.h>

     typedef SoTextDetail  SoTxtDtl

          Functions from class SoTextDetail:

     SoTextDetail *      SoTxtDtlCreate()
     void                SoTxtDtlDelete(SoTxtDtl *this)
     int32_t             SoTxtDtlGetStrInd(const SoTxtDtl *this)
     int32_t             SoTxtDtlGetCharInd(const SoTxtDtl *this)
     SoText3Part         SoTxtDtlGetPart(const SoTxtDtl *this)
     SbBox3f             SoTxtDtlGetBBox(const SoTxtDtl *this)
     SbXfBox3f           SoTxtDtlGetXfBBox(const SoTxtDtl *this)
     SoType              SoTxtDtlGetClassTypeId()

          Functions from class SoDetail:

     SoDetail *          SoTxtDtlVirtual(const SoTxtDtl *this)
     SoType              SoTxtDtlGetTypeId(const SoTxtDtl *this)
     SbBool              SoTxtDtlIsOfType(const SoTxtDtl *this, SoType type)


DESCRIPTION
     This class contains detail information about a point on a text shape
     (SoText2 or SoText3). It contains the part of the text, string, and
     character that were hit or generated.

FUNCTIONS
     SoTextDetail *      SoTxtDtlCreate()
     void                SoTxtDtlDelete(SoTxtDtl *this)
          Constructor and destructor.

     int32_t             SoTxtDtlGetStrInd(const SoTxtDtl *this)
          Returns the index of the relevant string within a multiple-value
          string field of a text node.

     int32_t             SoTxtDtlGetCharInd(const SoTxtDtl *this)
          Returns the index of the relevant character within the string. For
          example, if the character of detail was the "u" within "Splurmph",
          the character index would be 3.

     SoText3Part         SoTxtDtlGetPart(const SoTxtDtl *this)
          For SoText3, this returns which part was picked or generated.
     SbBox3f             SoTxtDtlGetBBox(const SoTxtDtl *this)
     SbXfBox3f           SoTxtDtlGetXfBBox(const SoTxtDtl *this)
          When the detail is returned from picking, these return the object-
          space bounding box of the character that was intersected. Otherwise,
          they return an empty box. The second method returns an SbXfBox3f
          instead of a SbBox3f. These methods are implemented only for 3D
          text.

     SoType              SoTxtDtlGetClassTypeId()
          Returns type identifier for this class.


SEE ALSO
     SoText2, SoText3, SoDetail, SoPickedPoint, SoPrimitiveVertex