Drawing Commands

Functions
Boolean_t	TecUtilFrameNeedsRedraw (UniqueID_t FrameID)
	Check to see if the supplied frame needs to be redrawn
Boolean_t	TecUtilRedraw (Boolean_t DoFullDrawing)
	Redraw the current frame.
Boolean_t	TecUtilRedrawAll (Boolean_t DoFullDrawing)
	Redraw all frames.
Boolean_t	TecUtilDrawGraphics (Boolean_t DoDrawing)
	Turn on or off all graphics drawing.
Boolean_t	TecUtilEventAddPreDrawCallback (DrawEventCallback_pf DrawEventCallback, ArbParam_t ClientData)
	Adds the callback and its client data to the list of pre-draw event callbacks.
Boolean_t	TecUtilEventAddPostDrawCallback (DrawEventCallback_pf DrawEventCallback, ArbParam_t ClientData)
	Adds the callback and its client data to the list of post-draw event callbacks.
Boolean_t	TecUtilAutoRedrawIsActive (void)
	Queries the auto redraw state.

---

Function Documentation

Boolean_t TecUtilAutoRedrawIsActive

(

void

)

Queries the auto redraw state.

Returns:

Returns TRUE if Auto Redraw is active, FALSE otherwise.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilAutoRedrawIsActive()

Python Syntax:

  Results = TecUtil.AutoRedrawIsActive()

  Output:
    Results[0]    ReturnVal            boolean

Query the auto redraw state.

   {
   Boolean_t AutoRedrawIsActive;
   TecUtilLockStart(AddOnID);
   AutoRedrawIsActive = TecUtilAutoRedrawIsActive();
   TecUtilLockFinish(AddOnID);
   }

Boolean_t TecUtilDrawGraphics

(

Boolean_t

DoDrawing

)

Turn on or off all graphics drawing.

Updates to the work area, sidebar, menu, and status line are suspended unless un-suspended via a call to TecUtilWorkAreaSuspend(), TecUtilInterfaceSuspend() or TecUtilStatusSuspend().

Parameters:

DoDrawing

TRUE to turn graphics drawing on, FALSE to turn off

Returns:

TRUE if successful, FALSE if not.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilDrawGraphics(DoDrawing)
    INTEGER*4 DoDrawing

Python Syntax:

  Results = TecUtil.DrawGraphics(DoDrawing)

  Input:
                  DoDrawing            boolean
  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilEventAddPostDrawCallback	(	DrawEventCallback_pf	DrawEventCallback,
		ArbParam_t	ClientData
	)

Adds the callback and its client data to the list of post-draw event callbacks.

Tecplot calls all post-draw event callbacks with their associated client data immediately after performing a redraw.

Since:

11.0-0-363

Parameters:

	DrawEventCallback	Callback to call immediately after a Tecplot performs a redraw.
	ClientData	Client data that Tecplot passes along to the callback as a parameter.

Returns:

TRUE if the callback and its client data were successfully added, FALSE otherwise.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilEventAddPostDrawCallback(
   &                   DrawEventCallback,
   &                   ClientDataPtr)
    EXTERNAL           DrawEventCallback
    POINTER            (ClientDataPtr, ClientData)

Python Syntax:

    This function is not supported in Python.

See also:

TecUtilEventAddPreDrawCallback()

Boolean_t TecUtilEventAddPreDrawCallback	(	DrawEventCallback_pf	DrawEventCallback,
		ArbParam_t	ClientData
	)

Adds the callback and its client data to the list of pre-draw event callbacks.

Tecplot calls all pre-draw event callbacks with their associated client data immediately before performing a redraw.

Since:

11.0-0-363

Parameters:

	DrawEventCallback	Callback to call immediately before a Tecplot performs a redraw.
	ClientData	Client data that Tecplot passes along to the callback as a parameter.

Returns:

TRUE if the callback and its client data were successfully added, FALSE otherwise.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilEventAddPreDrawCallback(
   &                   DrawEventCallback,
   &                   ClientDataPtr)
    EXTERNAL           DrawEventCallback
    POINTER            (ClientDataPtr, ClientData)

Python Syntax:

    This function is not supported in Python.

See also:

TecUtilEventAddPostDrawCallback()

Boolean_t TecUtilFrameNeedsRedraw

(

UniqueID_t

FrameID

)

Check to see if the supplied frame needs to be redrawn

Parameters:

FrameID

The UniqueID of the frame you're interested in.

Precondition:

There must be at least one page and one frame.

Returns:

TRUE if the frame associated with the supplied FrameID exists and the frame needs to be redrawn, FALSE otherwise.

Precondition:

Must have one or more pages.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilFrameNeedsRedraw()

Python Syntax:

  Results = TecUtil.FrameNeedsRedraw(FrameID)

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

Boolean_t TecUtilRedraw

(

Boolean_t

DoFullDrawing

)

Redraw the current frame.

Parameters:

DoFullDrawing

Set to FALSE to only draw a trace of the data in the current frame. Set to TRUE to do a full redraw.

Returns:

TRUE if successful, FALSE otherwise.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilRedraw(DoFullDrawing)
    INTEGER*4 DoFullDrawing

Python Syntax:

  Results = TecUtil.Redraw(DoFullDrawing)

  Input:
                  DoFullDrawing        boolean
  Output:
    Results[0]    ReturnVal            boolean

Do a complete redraw of the current frame:

   TecUtilRedraw(TRUE);

Boolean_t TecUtilRedrawAll

(

Boolean_t

DoFullDrawing

)

Redraw all frames.

Parameters:

DoFullDrawing

Set to FALSE to only draw a trace of the data in all frames. Set to TRUE to do a full redraw.

Returns:

TRUE if successful, FALSE otherwise.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilRedrawAll(DoFullDrawing)
    INTEGER*4 DoFullDrawing

Python Syntax:

  Results = TecUtil.RedrawAll(DoFullDrawing)

  Input:
                  DoFullDrawing        boolean
  Output:
    Results[0]    ReturnVal            boolean

Do a complete redraw of all frames:

   TecUtilRedrawAll(TRUE);