Text


Functions
void	TecUtilTextDelete (Text_ID TID)
	Deletes the specified text object.
Boolean_t	TecUtilTextIsValid (Text_ID TID)
	Determine if the text object is valid in the current frame context.
Clipping_e	TecUtilTextGetClipping (Text_ID TID)
	Get the clipping properties of a text object.
void	TecUtilTextGetAnchorPos (Text_ID TID, double XOrThetaPos, double YOrRPos, double *ZPos)
	Get the anchor coordinate position of the text object in the current coordinate system.
void	TecUtilTextGetXYPos (Text_ID TID, double XPos, double YPos)

CoordSys_e	TecUtilTextGetPositionCoordSys (Text_ID TID)
	Get the coordinate system to which the text is associated.
EntIndex_t	TecUtilTextGetZoneOrMap (Text_ID TID)
	Get the zone or map with which the text object is associated (if it is attached).
Boolean_t	TecUtilTextIsAttached (Text_ID TID)
	Determine if the text object is attached to a zone or map.
ColorIndex_t	TecUtilTextGetColor (Text_ID TID)
	Get the color of the text object.
Font_e	TecUtilTextGetFont (Text_ID TID)
	Get the font used for the text object.
double	TecUtilTextGetHeight (Text_ID TID)
	Get the text height in the currently defined text size units.
Units_e	TecUtilTextGetSizeUnits (Text_ID TID)
	Get the size units for the text object.
TextBox_e	TecUtilTextBoxGetType (Text_ID TID)
	Get the type of the box surrounding the text object.
double	TecUtilTextBoxGetMargin (Text_ID TID)
	Get the margin between the text and the box surrounding the text object.
double	TecUtilTextBoxGetLineThickness (Text_ID TID)
	Get the line thickness of the text box border.
ColorIndex_t	TecUtilTextBoxGetColor (Text_ID TID)
	Get the line color of the box surrounding the text object.
ColorIndex_t	TecUtilTextBoxGetFillColor (Text_ID TID)
	Get the fill color of the box surrounding the text object.
double	TecUtilTextGetAngle (Text_ID TID)
	Get the text angle.
TextAnchor_e	TecUtilTextGetAnchor (Text_ID TID)
	Get the text anchor style.
double	TecUtilTextGetLineSpacing (Text_ID TID)
	Get the spacing between lines of text.
Scope_e	TecUtilTextGetScope (Text_ID TID)
	Get the scope of the text object.
Boolean_t	TecUtilTextGetMacroFunctionCmd (Text_ID TID, char **MacroFunctionCommand)
	Get the macro function command string associated with the text object.
Boolean_t	TecUtilTextGetString (Text_ID TID, char **TextString)
	Get the string associated with the text object.
Text_ID	TecUtilTextGetNext (Text_ID TID)
	Get the next text object, relative to the specified text object, from the list of text objects maintained by the current frame.
Text_ID	TecUtilTextGetPrev (Text_ID TID)
	Get the previous text object, relative to the specified text object, from the list of text objects maintained by the current frame.
void	TecUtilTextSetClipping (Text_ID TID, Clipping_e Clipping)
	Set the clipping properties of a text object.
void	TecUtilTextSetAnchorPos (Text_ID TID, double XOrThetaPos, double YOrRPos, double ZPos)
	Set the XY-position for the text object.
void	TecUtilTextSetXYPos (Text_ID TID, double XPos, double YPos)

void	TecUtilTextSetCoordSysAndUnits (Text_ID TID, CoordSys_e PositionCoordSys, Units_e HeightUnits)
	Set the coordinate system for the position and the units for the character height of a text object.
void	TecUtilTextSetZoneOrMap (Text_ID TID, EntIndex_t ZoneOrMap)
	Set the zone or map to which the text object is associated (if it is attached).
void	TecUtilTextSetAttached (Text_ID TID, Boolean_t Attached)
	Indicate if the text object should be attached to a zone or map.
void	TecUtilTextSetColor (Text_ID TID, ColorIndex_t Color)
	Set the color of a text object.
void	TecUtilTextSetFont (Text_ID TID, Font_e Font)
	Set the font for a text object.
void	TecUtilTextSetHeight (Text_ID TID, double Height)
	Set the character height for a text object.
void	TecUtilTextBoxSetType (Text_ID TID, TextBox_e TextBoxType)
	Set the type of the box surrounding the text object.
void	TecUtilTextBoxSetMargin (Text_ID TID, double Margin)
	Set the margin between the text and the box surrounding the text object.
void	TecUtilTextBoxSetLineThickness (Text_ID TID, double LineThickness)
	Set the line thickness of the box surrounding the text object.
void	TecUtilTextBoxSetColor (Text_ID TID, ColorIndex_t BoxColor)
	Set the line color for the box surrounding a text object.
void	TecUtilTextBoxSetFillColor (Text_ID TID, ColorIndex_t BoxFillColor)
	Set the fill color of the box surrounding a text object.
void	TecUtilTextSetAngle (Text_ID TID, double Angle)
	Set the angle in degrees for a text object.
void	TecUtilTextSetAnchor (Text_ID TID, TextAnchor_e Anchor)
	Set the anchor style for a text object.
void	TecUtilTextSetLineSpacing (Text_ID TID, double LineSpacing)
	Set the line spacing for a text object.
void	TecUtilTextSetScope (Text_ID TID, Scope_e Scope)
	Set the scope of the text object.
Boolean_t	TecUtilTextSetMacroFunctionCmd (Text_ID TID, const char *Command)
	Set the macro function command associated with a text object.
Boolean_t	TecUtilTextSetString (Text_ID TID, const char *TextString)
	Set the text string for a text object.
Text_ID	TecUtilTextCreate (CoordSys_e PositionCoordSys, double PosX, double PosY, Units_e HeightUnits, double Height, const char *Text)
	Creates a text object.
Text_ID	TecUtilText3DCreate (double PosX, double PosY, double PosZ, Units_e HeightUnits, double Height, const char *Text)
	Create a 3D text label in Tecplot.
Text_ID	TecUtilTextGetBase (void)
	Get the first text object from the list of text objects maintained by the current frame.
void	TecUtilTextBoxGetPosition (Text_ID T, double X1, double Y1, double X2, double Y2, double X3, double Y3, double X4, double Y4)
	Get the position of the four corners of the box surrounding the text object.

Function Documentation

Text_ID TecUtilText3DCreate	(	double	PosX,
		double	PosY,
		double	PosZ,
		Units_e	HeightUnits,
		double	Height,
		const char *	Text
	)

Create a 3D text label in Tecplot.

Parameters:

	PosX	The X-position of the text label.
	PosY	The Y-position of the text label.
	PosZ	The Z-position of the text label.
	HeightUnits	The units to use for the text height.
	Height	The height of the text.
	Text	The text character string.

Returns:: Returns the ID for the created text.

Fortran Syntax:

    SUBROUTINE TecUtilText3DCreate(
   &           PosX,
   &           PosY,
   &           PosZ,
   &           HeightUnits,
   &           Height,
   &           Text,
   &           ResultPtr)
    REAL*8         PosX
    REAL*8         PosY
    REAL*8         PosZ
    INTEGER*4      HeightUnits
    REAL*8         Height
    CHARACTER*(*)  Text
    POINTER        (ResultPtr, Result)

Python Syntax:

  Results = TecUtil.Text3DCreate(PosX, PosY, PosZ, HeightUnits, Height, Text)

  Input:
                  PosX                 double
                  PosY                 double
                  PosZ                 double
                  HeightUnits          Units_e  (defined in TecVals.py)
                  Height               double
                  Text                 string
  Output:
    Results[0]    ReturnVal            long

ColorIndex_t TecUtilTextBoxGetColor ( Text_ID TID )

Get the line color of the box surrounding the text object.

Parameters:

TID

Handle to a text object.

Returns:: The text box color.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextBoxGetColor(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextBoxGetColor(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            TecVals color constant

ColorIndex_t TecUtilTextBoxGetFillColor ( Text_ID TID )

Get the fill color of the box surrounding the text object.

Parameters:

TID

Handle to a text object.

Returns:: The text box fill color.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextBoxGetFillColor(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextBoxGetFillColor(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            TecVals color constant

double TecUtilTextBoxGetLineThickness ( Text_ID TID )

Get the line thickness of the text box border.

Parameters:

TID

Handle to a text object.

Returns:: The text box line thickness in frame units.

Fortran Syntax:

    REAL*8 FUNCTION TecUtilTextBoxGetLineThickness(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextBoxGetLineThickness(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            double

double TecUtilTextBoxGetMargin ( Text_ID TID )

Get the margin between the text and the box surrounding the text object.

Parameters:

TID

Handle to a text object.

Returns:: The text box margin in frame units.

Fortran Syntax:

    REAL*8 FUNCTION TecUtilTextBoxGetMargin(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextBoxGetMargin(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            double

void TecUtilTextBoxGetPosition	(	Text_ID	T,
		double *	X1,
		double *	Y1,
		double *	X2,
		double *	Y2,
		double *	X3,
		double *	Y3,
		double *	X4,
		double *	Y4
	)

Get the position of the four corners of the box surrounding the text object.

Parameters:

	T	Handle to a text object.
	X1	Returned X-Coordinate for bottom left corner of the text box.
	Y1	Returned Y-Coordinate for bottom left corner of the text box.
	X2	Returned X-Coordinate for bottom right corner of the text box.
	Y2	Returned Y-Coordinate for bottom right corner of the text box.
	X3	Returned X-Coordinate for upper right corner of the text box.
	Y3	Returned Y-Coordinate for upper right corner of the text box.
	X4	Returned X-Coordinate for upper left corner of the text box.
	Y4	Returned Y-Coordinate for upper left corner of the text box.

Fortran Syntax:

    SUBROUTINE TecUtilTextBoxGetPosition(
   &           T,
   &           X1,
   &           Y1,
   &           X2,
   &           Y2,
   &           X3,
   &           Y3,
   &           X4,
   &           Y4)
    INTEGER*4       T
    REAL*8          X1
    REAL*8          Y1
    REAL*8          X2
    REAL*8          Y2
    REAL*8          X3
    REAL*8          Y3
    REAL*8          X4
    REAL*8          Y4

Python Syntax:

  Results = TecUtil.TextBoxGetPosition(T)

  Input:
                  T                    long
  Output:
    Results[0]    X1                   double
    Results[1]    Y1                   double
    Results[2]    X2                   double
    Results[3]    Y2                   double
    Results[4]    X3                   double
    Results[5]    Y3                   double
    Results[6]    X4                   double
    Results[7]    Y4                   double

Obtain the four corners of the text referenced by T.

   // variable T of type Text_ID already obtained at this point.
   double X1,Y1,X2,Y2,X3,Y3,X4,Y4;
   TecUtilTextBoxGetPosition(T,&X1,&Y1,&X2,&Y2,&X3,&Y3,&X4,&Y4);

TextBox_e TecUtilTextBoxGetType ( Text_ID TID )

Get the type of the box surrounding the text object.

Parameters:

TID

Handle to a text object.

Returns:: The possible values are: TextBox_None, TextBox_Filled, TextBox_Hollow.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextBoxGetType(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextBoxGetType(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            TextBox_e  (defined in TecVals.py)

void TecUtilTextBoxSetColor	(	Text_ID	TID,
		ColorIndex_t	BoxColor
	)

Set the line color for the box surrounding a text object.

Parameters:

	TID	Handle to a text object.
	BoxColor	Line color of the box. The possible values are: Black_C, Blue_C, Red_C, Green_C, Cyan_C, Purple_C, Yellow_C, White_C, CustomXX_C where XX is in the range 1-64.

Fortran Syntax:

    SUBROUTINE TecUtilTextBoxSetColor(
   &           TIDPtr,
   &           BoxColor)
    POINTER         (TIDPtr, TID)
    INTEGER*4       BoxColor

Python Syntax:

  Results = TecUtil.TextBoxSetColor(TID, BoxColor)

  Input:
                  TID                  long
                  BoxColor             TecVals color constant
  Output:
    Results[0]    ReturnVal            NONE

Create a boxed text label with the box color set to red.

   Text_ID Text;
   Text = TecUtilTextCreate(CoordSys_Frame,50.0,50.0,Units_Point,
                            30.0,"Hi Mom");
   TecUtilTextBoxSetType(Text, TextBox_Hollow);
   TecUtilTextBoxSetColor(Text, Red_C);

void TecUtilTextBoxSetFillColor	(	Text_ID	TID,
		ColorIndex_t	BoxFillColor
	)

Set the fill color of the box surrounding a text object.

Parameters:

	TID	Handle to a text object.
	BoxFillColor	Fill color of the box. The possible values are: Black_C, Blue_C, Red_C, Green_C, Cyan_C, Purple_C, Yellow_C, White_C, CustomXX_C where XX is in the range 1-64.

Fortran Syntax:

    SUBROUTINE TecUtilTextBoxSetFillColor(
   &           TIDPtr,
   &           BoxFillColor)
    POINTER         (TIDPtr, TID)
    INTEGER*4       BoxFillColor

Python Syntax:

  Results = TecUtil.TextBoxSetFillColor(TID, BoxFillColor)

  Input:
                  TID                  long
                  BoxFillColor         TecVals color constant
  Output:
    Results[0]    ReturnVal            NONE

Create a filled boxed text label with a fill color of blue.

   Text_ID Text;
   Text = TecUtilTextCreate(CoordSys_Frame,50.0,50.0,Units_Point,30.0,
                            "Hi Mom");
   TecUtilTextBoxSetType(Text, TextBox_Filled);
   TecUtilTextBoxSetColor(Text, Blue_C);

void TecUtilTextBoxSetLineThickness	(	Text_ID	TID,
		double	LineThickness
	)

Set the line thickness of the box surrounding the text object.

Parameters:

	TID	Handle to a text object.
	LineThickness	Line thickness of the box, in frame units

Fortran Syntax:

    SUBROUTINE TecUtilTextBoxSetLineThickness(
   &           TIDPtr,
   &           LineThickness)
    POINTER         (TIDPtr, TID)
    REAL*8          LineThickness

Python Syntax:

  Results = TecUtil.TextBoxSetLineThickness(TID, LineThickness)

  Input:
                  TID                  long
                  LineThickness        double
  Output:
    Results[0]    ReturnVal            NONE

void TecUtilTextBoxSetMargin	(	Text_ID	TID,
		double	Margin
	)

Set the margin between the text and the box surrounding the text object.

Parameters:

	TID	Handle to a text object.
	Margin	Margin between the text and the box in percentage of the text height

Fortran Syntax:

    SUBROUTINE TecUtilTextBoxSetMargin(
   &           TIDPtr,
   &           Margin)
    POINTER         (TIDPtr, TID)
    REAL*8          Margin

Python Syntax:

  Results = TecUtil.TextBoxSetMargin(TID, Margin)

  Input:
                  TID                  long
                  Margin               double
  Output:
    Results[0]    ReturnVal            NONE

Create a boxed text label with a box margin of 60 percent of the height of the text:

   Text_ID Text;
   Text = TecUtilTextCreate(CoordSys_Frame,50.0,50.0,Units_Points,30.0,
                            "Hi Mom");
   TecUtilTextBoxSetType(Text, TextBox_Hollow);
   TecUtilTextBoxSetMargin(Text, 60.0);

void TecUtilTextBoxSetType	(	Text_ID	TID,
		TextBox_e	TextBoxType
	)

Set the type of the box surrounding the text object.

Parameters:

	TID	Handle to a text object.
	TextBoxType	Text box type. The possible values are: TextBox_None, TextBox_Filled, TextBox_Hollow

Fortran Syntax:

    SUBROUTINE TecUtilTextBoxSetType(
   &           TIDPtr,
   &           TextBoxType)
    POINTER         (TIDPtr, TID)
    INTEGER*4       TextBoxType

Python Syntax:

  Results = TecUtil.TextBoxSetType(TID, TextBoxType)

  Input:
                  TID                  long
                  TextBoxType          TextBox_e  (defined in TecVals.py)
  Output:
    Results[0]    ReturnVal            NONE

Create a hollow boxed text label.

   Text_ID Text;
   Text = TecUtilTextCreate(CoordSys_Frame,50.0,50.0,Units_Points,
                              30.0,"Hi Mom");
   TecUtilTextBoxSetType(Text, TextBox_Hollow);

Text_ID TecUtilTextCreate	(	CoordSys_e	PositionCoordSys,
		double	PosX,
		double	PosY,
		Units_e	HeightUnits,
		double	Height,
		const char *	Text
	)

Creates a text object.

Use the handle obtained from this function to set text attributes using the TecUtilTextSetXxx functions. Units are in frame coordinates by default.

Parameters:

	PositionCoordSys	Coordinate system used to position the text object. The possible values are: CoordSys_Grid or CoordSys_Frame
	PosX	X-Coordinate for anchor position of the text in the specified PositionCoordSys coordinate system.
	PosY	Y-Coordinate for anchor position of the text in the specified PositionCoordSys coordinate system.
	HeightUnits	Units for the character height of the text. If PositionCoordSys is CoordSys_Frame, units must be Units_Frame or Units_Point. If PositionCoordSys is CoordSys_Grid, units must be Units_Frame or Units_Grid.
	Height	Character height of the text in the specified HeightUnits units
	Text	String to use to create the text object. Cannot be NULL

Returns:: If successfully created then the return value is a valid ID that you may use to further set attributes for this text object. Otherwise, TECUTILBADID is returned.

Fortran Syntax:

    SUBROUTINE TecUtilTextCreate(
   &           PositionCoordSys,
   &           PosX,
   &           PosY,
   &           HeightUnits,
   &           Height,
   &           Text,
   &           ResultPtr)
    INTEGER*4      PositionCoordSys
    REAL*8         PosX
    REAL*8         PosY
    INTEGER*4      HeightUnits
    REAL*8         Height
    CHARACTER*(*)  Text
    POINTER        (ResultPtr, Result)

Python Syntax:

  Results = TecUtil.TextCreate(PositionCoordSys, PosX, PosY, HeightUnits, Height, Text)

  Input:
                  PositionCoordSys     CoordSys_e  (defined in TecVals.py)
                  PosX                 double
                  PosY                 double
                  HeightUnits          Units_e  (defined in TecVals.py)
                  Height               double
                  Text                 string
  Output:
    Results[0]    ReturnVal            long

Create a simple text label:

   Text_ID Text;
   Text = TecUtilTextCreate(CoordSys_Frame, 50.0, 50.0,
                            Units_Point, 30.0, "Hello");

void TecUtilTextDelete ( Text_ID TID )

Deletes the specified text object.

Parameters:

TID

Handle to a text object

Fortran Syntax:

    SUBROUTINE TecUtilTextDelete(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextDelete(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            NONE

Delete the first text object from the list of text objects maintained by the current frame.

   Text_ID Text;
   
   Text = TecUtilTextGetBase();
   if (Text != TECUTILBADID)
     {
       TecUtilTextDelete(Text);
     }

TextAnchor_e TecUtilTextGetAnchor ( Text_ID TID )

Get the text anchor style.

Parameters:

TID

Handle to a text object

Returns:: The text anchor style. The possible values are: TextAnchor_Left, TextAnchor_Center, TextAnchor_Right, TextAnchor_MidLeft, TextAnchor_MidCenter, TextAnchor_MidRight, TextAnchor_HeadLeft, TextAnchor_HeadCenter, TextAnchor_HeadRight, TextAnchor_OnSide.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextGetAnchor(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextGetAnchor(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            TextAnchor_e  (defined in TecVals.py)

void TecUtilTextGetAnchorPos	(	Text_ID	TID,
		double *	XOrThetaPos,
		double *	YOrRPos,
		double *	ZPos
	)

Get the anchor coordinate position of the text object in the current coordinate system.

Parameters:

	TID	Handle to a text object
	XOrThetaPos	Pointer to the text object's X or Theta anchor position.
	YOrRPos	Pointer to the text object's Y or R (radius) anchor position
	ZPos	Pointer to the text object's anchor Z position.

Fortran Syntax:

    SUBROUTINE TecUtilTextGetAnchorPos(
   &           TIDPtr,
   &           XOrThetaPos,
   &           YOrRPos,
   &           ZPos)
    POINTER         (TIDPtr, TID)
    REAL*8          XOrThetaPos
    REAL*8          YOrRPos
    REAL*8          ZPos

Python Syntax:

  Results = TecUtil.TextGetAnchorPos(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    XOrThetaPos          double
    Results[1]    YOrRPos              double
    Results[2]    ZPos                 double

Text_ID Text;

   double  XOrThetaPos;
   double  YOrRPos;
   double  ZPos;
   
   // use TecUtilTextDelete() when 'Text' is no longer needed 
   Text = TecUtilTextCreate(CoordSys_Frame, 50.0, 50.0,
                            Units_Point,30.0, "Hello");
   if (Text != TECUTILBADID)
     {
       // do all sorts of things 
         .
         .
         .
   
       // get the current anchor position of the text 
       TecUtilTextGetAnchorPos(Text, &XOrThetaPos, &YOrRPos,
    &ZPos);
     }

See also:: TecUtilTextSetCoordSysAndUnits()

double TecUtilTextGetAngle ( Text_ID TID )

Get the text angle.

Parameters:

TID

Handle to a text object

Returns:: The text angle in degrees.

Fortran Syntax:

    REAL*8 FUNCTION TecUtilTextGetAngle(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextGetAngle(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            double

Text_ID TecUtilTextGetBase ( void )

Get the first text object from the list of text objects maintained by the current frame.

See also:: TecUtilTextGetNext() and TecUtilTextGetPrev()

Returns:: First text object of the list maintained by the current frame. If no text objects are maintained by the current frame then TECUTILBADID is returned.

Fortran Syntax:

    SUBROUTINE TecUtilTextGetBase(ResultPtr)
    POINTER        (ResultPtr, Result)

Python Syntax:

  Results = TecUtil.TextGetBase()

  Output:
    Results[0]    ReturnVal            long

Examine all text labels in the current frame and see if any of them are red.

   TextID Text;
   for (Text = TecUtilTextGetBase();
        Text != TECUTILBADID;
        Text = TecUtilTextGetNext(Text))
     {
       if (TecUtilTextGetColor(Text) == Red_C)
         {
           // do something with the red text
         }
     }

Clipping_e TecUtilTextGetClipping ( Text_ID TID )

Get the clipping properties of a text object.

Parameters:

TID

ID of the text object

Returns:: Returns the clipping type. Can be one of Clipping_ClipToViewport or Clipping_ClipToFrame.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextGetClipping(TID)
    INTEGER*4 TID

Python Syntax:

  Results = TecUtil.TextGetClipping(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            Clipping_e  (defined in TecVals.py)

ColorIndex_t TecUtilTextGetColor ( Text_ID TID )

Get the color of the text object.

Parameters:

TID

Handle to a text object

Returns:: Text color. The possible values are: Black_C, Blue_C, Red_C, Green_C, Cyan_C, Purple_C, Yellow_C, White_C, CustomXX_C where XX is in the range 1-64.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextGetColor(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextGetColor(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            TecVals color constant

Font_e TecUtilTextGetFont ( Text_ID TID )

Get the font used for the text object.

Parameters:

TID

Handle to a text object.

Returns:: Text font. The possible values are: Font_Helvetica, Font_HelveticaBold, Font_Greek, Font_Math, Font_UserDefined, Font_Times, Font_TimesItalic, Font_TimesItalicBold, Font_TimesBold, Font_Courier, Font_CourierBold.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextGetFont(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextGetFont(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            Font_e  (defined in TecVals.py)

double TecUtilTextGetHeight ( Text_ID TID )

Get the text height in the currently defined text size units.

Parameters:

TID

Handle to a text object.

Returns:: Text height measured in the currently defined text size units.

Fortran Syntax:

    REAL*8 FUNCTION TecUtilTextGetHeight(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextGetHeight(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            double

double TecUtilTextGetLineSpacing ( Text_ID TID )

Get the spacing between lines of text.

Note:: A newline (\n) character within a string causes the line to wrap at that point.

Parameters:

TID

Handle to a text object.

Returns:: Vertical line spacing between multiple lines of a ext object.

Fortran Syntax:

    REAL*8 FUNCTION TecUtilTextGetLineSpacing(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextGetLineSpacing(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            double

Boolean_t TecUtilTextGetMacroFunctionCmd	(	Text_ID	TID,
		char **	MacroFunctionCommand
	)

Get the macro function command string associated with the text object.

Parameters:

	TID	Handle to a text object.
	MacroFunctionCommand	Handle to a macro function command string. The result must be deallocated with TecUtilStringDealloc() when it is no longer needed

Returns:: TRUE if sufficient memory is available for the string, otherwise FALSE.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextGetMacroFunctionCmd(
   &                   TIDPtr,
   &                   MacroFunctionCommand,
   &                   MacroFunctionCommandLength)
    POINTER         (TIDPtr, TID)
    CHARACTER*(*)   MacroFunctionCommand
    INTEGER*4       MacroFunctionCommandLength

Python Syntax:

  Results = TecUtil.TextGetMacroFunctionCmd(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            boolean
    Results[1]    MacroFunctionCommand string

Boolean_t IsOk;

   Text_ID   Text;
   char      *MacroCommand = NULL;
     .
     .
     .
   
   // get the text's associated macro command 
   IsOk = TecUtilTextGetMacroFunctionCmd(Text, &MacroCommand);
   if (IsOk)
     {
       // do something with command 
         .
         .
         .
   
       // cleanup; macro command no longer needed 
       TecUtilStringDealloc(&MacroCommand);
     }

Text_ID TecUtilTextGetNext ( Text_ID TID )

Get the next text object, relative to the specified text object, from the list of text objects maintained by the current frame.

Parameters:

TID

Handle to a text object.

Returns:: Text object following the specified text object. If the specified text object is the last in the list then TECUTILBADID is returned.

Fortran Syntax:

   SUBROUTINE TecUtilTextGetNext(
  &           TIDPtr,
  &           ResultPtr)
   POINTER        (TIDPtr, TID)
   POINTER        (ResultPtr, Result)

Python Syntax:

  Results = TecUtil.TextGetNext(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            long

CoordSys_e TecUtilTextGetPositionCoordSys ( Text_ID TID )

Get the coordinate system to which the text is associated.

Parameters:

TID

Handle to a text object.

Returns:: Text object's coordinate system. The possible values are: CoordSys_Grid, CoordSys_Frame.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextGetPositionCoordSys(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextGetPositionCoordSys(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            CoordSys_e  (defined in TecVals.py)

Text_ID TecUtilTextGetPrev ( Text_ID TID )

Get the previous text object, relative to the specified text object, from the list of text objects maintained by the current frame.

Parameters:

TID

Handle to a text object defined in the current frame.

Returns:: Text object preceeding the specified text object. If the specified text object is the first in the list then the last text object in the list is returned.

Fortran Syntax:

   SUBROUTINE TecUtilTextGetPrev(
  &           TIDPtr,
  &           ResultPtr)
   POINTER        (TIDPtr, TID)
   POINTER        (ResultPtr, Result)

Python Syntax:

  Results = TecUtil.TextGetPrev(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            long

See also:: TecUtilTextGetBase() and TecUtilTextGetNext().

Scope_e TecUtilTextGetScope ( Text_ID TID )

Get the scope of the text object.

Text with local scope is displayed only in the frame in which it is created. If the text is defined as having global scope it will appear in all "like" frames, that is, those frames using the same data set as the one in which the text was created.

Parameters:

TID

Handle to a text object.

Returns:: Text scope. The possible values are: Scope_Local or Scope_Global.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextGetScope(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextGetScope(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            Scope_e  (defined in TecVals.py)

Units_e TecUtilTextGetSizeUnits ( Text_ID TID )

Get the size units for the text object.

Parameters:

TID

Handle to a text object.

Returns:: Text size units. The possible values are: Units_Grid, Units_Frame or Units_Point.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextGetSizeUnits(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextGetSizeUnits(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            Units_e  (defined in TecVals.py)

See also:: TecUtilTextGetHeight()

Boolean_t TecUtilTextGetString	(	Text_ID	TID,
		char **	TextString
	)

Get the string associated with the text object.

Parameters:

	TID	Handle to a text object.
	TextString	String of the text object. Result must be deallocated with TecUtilStringDealloc() when no longer needed.

Returns:: TRUE if sufficient memory is avialable for the string, otherwise FALSE.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextGetString(
   &                   TIDPtr,
   &                   TextString,
   &                   TextStringLength)
    POINTER         (TIDPtr, TID)
    CHARACTER*(*)   TextString
    INTEGER*4       TextStringLength

Python Syntax:

  Results = TecUtil.TextGetString(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            boolean
    Results[1]    TextString           string

Text_ID Text;

   Boolean_t IsOk = FALSE;
   char      *TextString = NULL;
   
   Text = TecUtilTextCreate(CoordSys_Frame,50.0, 50.0, Units_Point,
                            30.0, "Hello");
   if (Text != TECUTILBADID)
     {
       // do some things with the text 
         .
         .
         .
   
       // change the string of the text object 
       TecUtilTextSetString(Text, "Hello World");
   
       // do some more things 
         .
         .
         .
   
       // print the contents of the text 
       // string to standard output      
       IsOk = TecUtilTextGetString(Text, &TextString);
       if (IsOk)
         {
           printf("%s\n", TextString);
           TecUtilStringDealloc(&TextString);
         }
     }

void TecUtilTextGetXYPos	(	Text_ID	TID,
		double *	XPos,
		double *	YPos
	)

Deprecated:: Please use TecUtilTextGetAnchorPos() instead.

Python Syntax:

  Results = TecUtil.TextGetXYPos(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    XPos                 double
    Results[1]    YPos                 double

EntIndex_t TecUtilTextGetZoneOrMap ( Text_ID TID )

Get the zone or map with which the text object is associated (if it is attached).

Parameters:

TID

Handle to a text object.

Returns:: Zone or map.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextGetZoneOrMap(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextGetZoneOrMap(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            int

See also:: TecUtilTextIsAttached() and TecUtilTextSetAttached().

Boolean_t TecUtilTextIsAttached ( Text_ID TID )

Determine if the text object is attached to a zone or map.

Parameters:

TID

Handle to a text object.

Returns:: TRUE if attached, otherwise FALSE.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextIsAttached(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextIsAttached(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            boolean

See also:: TecUtilTextGetZoneOrMap() and TecUtilGeomSetZoneOrMap().

Boolean_t TecUtilTextIsValid ( Text_ID TID )

Determine if the text object is valid in the current frame context.

Parameters:

TID

Handle to a text object.

Returns:: TRUE if TID is a valid text object, otherwise FALSE.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilTextIsValid(TIDPtr)
    POINTER(TIDPtr, TID)

Python Syntax:

  Results = TecUtil.TextIsValid(TID)

  Input:
                  TID                  long
  Output:
    Results[0]    ReturnVal            boolean

void TecUtilTextSetAnchor	(	Text_ID	TID,
		TextAnchor_e	Anchor
	)

Set the anchor style for a text object.

Parameters:

	TID	Handle to a text object.
	Anchor	Anchor style. The possible values are: TextAnchor_Left, TextAnchor_Center, TextAnchor_Right, TextAnchor_MidLeft, TextAnchor_MidCenter, TextAnchor_MidRight, TextAnchor_HeadLeft, TextAnchor_HeadCenter, TextAnchor_HeadRight, TextAnchor_OnSide

Fortran Syntax:

    SUBROUTINE TecUtilTextSetAnchor(
   &           TIDPtr,
   &           Anchor)
    POINTER         (TIDPtr, TID)
    INTEGER*4       Anchor

Python Syntax:

  Results = TecUtil.TextSetAnchor(TID, Anchor)

  Input:
                  TID                  long
                  Anchor               TextAnchor_e  (defined in TecVals.py)
  Output:
    Results[0]    ReturnVal            NONE

void TecUtilTextSetAnchorPos	(	Text_ID	TID,
		double	XOrThetaPos,
		double	YOrRPos,
		double	ZPos
	)

Set the XY-position for the text object.

The text is always anchored in the coordinate system specified by TecUtilTextSetCoordSysAndUnits() each time the text object is drawn.

Parameters:

	TID	Handle to a text object.
	XOrThetaPos	The text object's X or Theta anchor position.
	YOrRPos	The text object's Y or R (radius) anchor position.
	ZPos	The text object's Z position.

Fortran Syntax:

    SUBROUTINE TecUtilTextSetAnchorPos(
   &           TIDPtr,
   &           XOrThetaPos,
   &           YOrRPos,
   &           ZPos)
    POINTER         (TIDPtr, TID)
    REAL*8          XOrThetaPos
    REAL*8          YOrRPos
    REAL*8          ZPos

Python Syntax:

  Results = TecUtil.TextSetAnchorPos(TID, XOrThetaPos, YOrRPos, ZPos)

  Input:
                  TID                  long
                  XOrThetaPos          double
                  YOrRPos              double
                  ZPos                 double
  Output:
    Results[0]    ReturnVal            NONE

Text

Functions

Function Documentation