WorkArea

Functions
void	TecUtilWorkAreaSuspend (Boolean_t DoSuspend)
	Suspends or un-suspends updates to the work area only.
Boolean_t	TecUtilWorkViewFitSelectFrames (void)
	Change the view in the workspace so the currently selected frames (that is, the frames with picked handles) are fit just inside the edges of the workspace.
Boolean_t	TecUtilWorkViewFitAllFrames (void)
	Change the view in the workspace so all frames are fit just inside the edges of the workspace.
Boolean_t	TecUtilWorkViewFitPaper (void)
	Change the view in the workspace so the entire paper is fit just inside the edges of the workspace.
Boolean_t	TecUtilWorkViewMaximize (void)
	Temporarily expand the workspace as large as possible.
Boolean_t	TecUtilWorkViewLastView (void)
	Return to the previous workspace view.
Boolean_t	TecUtilWorkViewZoom (double X1, double Y1, double X2, double Y2)
	Change the view into the workspace.
Boolean_t	TecUtilWorkViewTranslate (double X, double Y)
	Shift the view of the workspace.
void	TecUtilWorkAreaGetDimensions (LgIndex_t *Width, LgIndex_t *Height)
	Get the dimensions of the Tecplot workspace.

---

Function Documentation

void TecUtilWorkAreaGetDimensions	(	LgIndex_t *	Width,
		LgIndex_t *	Height
	)

Get the dimensions of the Tecplot workspace.

Parameters:

	Width	Width of the workspace (in pixels).
	Height	Height of the workspace (in pixels).

Precondition:

Must have one or more pages.

Width Pointer must be a valid address and non-NULL.

Height Pointer must be a valid address and non-NULL.

Fortran Syntax:

    SUBROUTINE TecUtilWorkAreaGetDimensions(
   &           Width,
   &           Height)
    INTEGER*4       Width
    INTEGER*4       Height

Python Syntax:

  Results = TecUtil.WorkAreaGetDimensions()

  Output:
    Results[0]    Width                int
    Results[1]    Height               int

Get the workspace size in paper coordinates:

   LgIndex_t width_pixels, height_pixels;
   TecUtilWorkAreaGetDimensions(&width_pixels, &height_pixels);
   double XPos   = TecUtilConvertXPosition(CoordSys_Screen, CoordSys_Paper, 0.0);
   double YPos   = TecUtilConvertYPosition(CoordSys_Screen, CoordSys_Paper, 0.0);
   double Width  = TecUtilConvertXDimension(CoordSys_Screen, CoordSys_Paper, width_pixels);
   double Height = TecUtilConvertYDimension(CoordSys_Screen, CoordSys_Paper, height_pixels);

void TecUtilWorkAreaSuspend

(

Boolean_t

DoSuspend

)

Suspends or un-suspends updates to the work area only.

Updates to the sidebar, menu, and status line are still preformed unless suspended via a call to TecUtilDrawGraphics(), TecUtilInterfaceSuspend() or TecUtilStatusSuspend().

Since:

11.0-3-010

Parameters:

DoSuspend

Indicates if Tecplot should suspend or un-suspend making updates to the work area.

See also:

TecUtilDrawGraphics, TecUtilInterfaceSuspend, TecUtilStatusSuspend

Python Syntax:

  Results = TecUtil.WorkAreaSuspend(DoSuspend)

  Input:
                  DoSuspend            boolean
  Output:
    Results[0]    ReturnVal            NONE

Boolean_t TecUtilWorkViewFitAllFrames

(

void

)

Change the view in the workspace so all frames are fit just inside the edges of the workspace.

Returns:

TRUE if successful, FALSE if not.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilWorkViewFitAllFrames()

Python Syntax:

  Results = TecUtil.WorkViewFitAllFrames()

  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilWorkViewFitPaper

(

void

)

Change the view in the workspace so the entire paper is fit just inside the edges of the workspace.

Returns:

TRUE if successful, FALSE if not.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilWorkViewFitPaper()

Python Syntax:

  Results = TecUtil.WorkViewFitPaper()

  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilWorkViewFitSelectFrames

(

void

)

Change the view in the workspace so the currently selected frames (that is, the frames with picked handles) are fit just inside the edges of the workspace.

Returns:

TRUE if successful, FALSE if not.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilWorkViewFitSelectFrames()

Python Syntax:

  Results = TecUtil.WorkViewFitSelectFrames()

  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilWorkViewLastView

(

void

)

Return to the previous workspace view.

Returns:

TRUE if successful, FALSE if not.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilWorkViewLastView()

Python Syntax:

  Results = TecUtil.WorkViewLastView()

  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilWorkViewMaximize

(

void

)

Temporarily expand the workspace as large as possible.

In the Motif version of Tecplot, the maximized workspace occupies the entire Tecplot process window. In the Windows version, the maximized workspace expands to fill the entire screen.

Returns:

TRUE if successful, FALSE if not.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilWorkViewMaximize()

Python Syntax:

  Results = TecUtil.WorkViewMaximize()

  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilWorkViewTranslate	(	double	X,
		double	Y
	)

Shift the view of the workspace.

This has no effect on the local view within any frame in your layout.

Parameters:

	X	Amount to translate in the X-Direction. Value is in inches.
	Y	Amount to translate in the Y-Direction. Value is in inches.

Returns:

TRUE if successful, FALSE if not.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilWorkViewTranslate(
   &                   X,
   &                   Y)
    REAL*8          X
    REAL*8          Y

Python Syntax:

  Results = TecUtil.WorkViewTranslate(X, Y)

  Input:
                  X                    double
                  Y                    double
  Output:
    Results[0]    ReturnVal            boolean

Shift the workspace view to the left by two inches (as measured by the workspace ruler):

   TecUtilWorkViewTranslate(-2.0,0.0);

Boolean_t TecUtilWorkViewZoom	(	double	X1,
		double	Y1,
		double	X2,
		double	Y2
	)

Change the view into the workspace.

This has no effect on the local view within any frame in your layout.

Parameters:

	X1	X min Corner of the rectangle on the paper to be viewed.
	Y1	Y min Corner of the rectangle on the paper to be viewed.
	X2	X max Corner of the rectangle on the paper to be viewed.
	Y2	Y max Corner of the rectangle on the paper to be viewed.

Returns:

TRUE if successful, FALSE if not.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilWorkViewZoom(
   &                   X1,
   &                   Y1,
   &                   X2,
   &                   Y2)
    REAL*8          X1
    REAL*8          Y1
    REAL*8          X2
    REAL*8          Y2

Python Syntax:

  Results = TecUtil.WorkViewZoom(X1, Y1, X2, Y2)

  Input:
                  X1                   double
                  Y1                   double
                  X2                   double
                  Y2                   double
  Output:
    Results[0]    ReturnVal            boolean

Make the region in the lower left corner of an 8.5 by 11 paper viewable in the work area. The paper is in portrait orientation:

   TecUtilWorkViewZoom(0.0,5.5,4.25,9.75);