Blanking

Functions
Boolean_t	TecUtilBlankingIsActive (void)
	Determine if blanking is active.
Boolean_t	TecUtilBlankingCheckDataPoint (EntIndex_t Zone, LgIndex_t PointIndex)
	Determine if the specified data point in the specified zone is visible or if it is not drawn due to value-blanking or IJK-blanking.
Boolean_t	TecUtilBlankingCheckFECell (EntIndex_t Zone, LgIndex_t CellIndex)
	Determine if the specified element in the specified finite-element zone is visible or if it is not drawn due to value-blanking.
Boolean_t	TecUtilBlankingCheckIJKCell (EntIndex_t Zone, IJKPlanes_e ZonePlane, LgIndex_t CellIndex)
	Determine if the specified cell in the specified IJK-ordered zone is visible or if it is not drawn due to value-blanking or IJK-blanking.

---

Function Documentation

Boolean_t TecUtilBlankingCheckDataPoint	(	EntIndex_t	Zone,
		LgIndex_t	PointIndex
	)

Determine if the specified data point in the specified zone is visible or if it is not drawn due to value-blanking or IJK-blanking.

This function is Thread Safe.

Parameters:

	Zone	The number of the zone in which the PointIndex is located.
	PointIndex	The index of the point of interest.

Returns:

TRUE if the data point is visible, FALSE if it is blanked.

Precondition:

Must have one or more frames.

Current frame must have a data set with at least one zone.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilBlankingCheckDataPoint(
   &                   Zone,
   &                   PointIndex)
    INTEGER*4       Zone
    INTEGER*4       PointIndex

Python Syntax:

  Results = TecUtil.BlankingCheckDataPoint(Zone, PointIndex)

  Input:
                  Zone                 int
                  PointIndex           int
  Output:
    Results[0]    ReturnVal            boolean

Zone 4 is IJ-ordered and has IMax = 12, JMax = 8. Determine if the point (I=3, J=2) of zone 4 is visible:

   Boolean_t IsVisible = TecUtilBlankingCheckDataPoint(4,(2-1)*8+3);

Zone 5 is finite-element. Determine if the point (N=17) of zone 5 is visible:

   Boolean_t IsVisible = TecUtilBlankingCheckDataPoint(5, 17);

Boolean_t TecUtilBlankingCheckFECell	(	EntIndex_t	Zone,
		LgIndex_t	CellIndex
	)

Determine if the specified element in the specified finite-element zone is visible or if it is not drawn due to value-blanking.

This function is Thread Safe.

Parameters:

	Zone	The number of the zone in which the element is located. The zone must be finite-element.
	CellIndex	The index of the element of interest.

Returns:

TRUE if the element is visible, FALSE if it is blanked.

Precondition:

Must have one or more frames.

Current frame must have a data set with at least one zone.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilBlankingCheckFECell(
   &                   Zone,
   &                   CellIndex)
    INTEGER*4       Zone
    INTEGER*4       CellIndex

Python Syntax:

  Results = TecUtil.BlankingCheckFECell(Zone, CellIndex)

  Input:
                  Zone                 int
                  CellIndex            int
  Output:
    Results[0]    ReturnVal            boolean

Zone 5 is finite-element. Determine if element number 13 of zone 5 is visible:

   Boolean_t IsVisible =
    TecUtilBlankingCheckFECell(5, 13);

Boolean_t TecUtilBlankingCheckIJKCell	(	EntIndex_t	Zone,
		IJKPlanes_e	ZonePlane,
		LgIndex_t	CellIndex
	)

Determine if the specified cell in the specified IJK-ordered zone is visible or if it is not drawn due to value-blanking or IJK-blanking.

This function is Thread Safe.

Parameters:

	Zone	The number of the zone in which the cell is located. The zone must be IJK-ordered.
	ZonePlane	The plane in which the cell resides. For I or IJ-ordered data, use IJKPlanes_K. For IJK-ordered data, this determines what to use to determine the cell. The possible values are: IJKPlanes_I, IJKPlanes_J, IJKPlanes_K, or IJKPlanes_Volume.
	CellIndex	The index of the cell of interest.

Returns:

TRUE if the cell is visible, FALSE if it is blanked.

Precondition:

Must have one or more frames.

Current frame must have a data set with at least one zone.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilBlankingCheckIJKCell(
   &                   Zone,
   &                   ZonePlane,
   &                   CellIndex)
    INTEGER*4       Zone
    INTEGER*4       ZonePlane
    INTEGER*4       CellIndex

Python Syntax:

  Results = TecUtil.BlankingCheckIJKCell(Zone, ZonePlane, CellIndex)

  Input:
                  Zone                 int
                  ZonePlane            IJKPlanes_e  (defined in TecVals.py)
                  CellIndex            int
  Output:
    Results[0]    ReturnVal            boolean

Zone 4 is IJ-ordered. Determine if cell 13 of zone 4 is visible:

    Boolean_t IsVisible =
      TecUtilBlankingCheckIJKCell(4, IJKPlanes_K, 13);

Boolean_t TecUtilBlankingIsActive

(

void

)

Determine if blanking is active.

Returns:

TRUE if blanking is acrtive.

Precondition:

Must have one or more frames.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilBlankingIsActive()

Python Syntax:

  Results = TecUtil.BlankingIsActive()

  Output:
    Results[0]    ReturnVal            boolean

   Boolean_t BlankingIsActive = TecUtilBlankingIsActive();

Since:

11.3-17-015