Pick

Functions
Boolean_t	TecUtilPickAtPosition (double X, double Y, Boolean_t CollectingObjects, Boolean_t DiggingForObjects)
Boolean_t	TecUtilPickAddAtPosition (double X, double Y, Boolean_t CollectingObjects, Boolean_t DiggingForObjects, Boolean_t ConsiderStyle)
	Pick an object at a specified location.
Boolean_t	TecUtilPickDeselectAll (void)
	Deselect all selected objects.
Boolean_t	TecUtilPickDeselect (int PickListItem)
	Deselect a single pick list item.
Boolean_t	TecUtilPickAddFrameByUniqueID (Boolean_t CollectingObjects, UniqueID_t UniqueID)
	Adds the frame identified by the unique identifier to the pick list.
Boolean_t	TecUtilPickAddZones (Boolean_t CollectingObjects, Set_pa ZoneSet)
	Adds the specified Line-maps to the pick object list.
Boolean_t	TecUtilPickAddXYMaps (Boolean_t CollectingObjects, Set_pa XYMapsSet)
Boolean_t	TecUtilPickAddLineMaps (Boolean_t CollectingObjects, Set_pa LineMapSet)
	Adds the specified Line-maps to the pick object list.
Boolean_t	TecUtilPickAddAll (PickObjects_e ObjectType)
	Add all objects of a certain type to the pick list.
Boolean_t	TecUtilPickAddAllInRect (double X1, double Y1, double X2, double Y2, PickObjects_e ObjectType, const char *Filter)
	Add all objects defined within a specified rectangle to the pick list.
Boolean_t	TecUtilPickEdit (const char *Action)
	Perform a global edit operation on the currently picked objects.
Boolean_t	TecUtilPickCut (void)
	Copy all objects that are currently picked to the paste buffer and then delete them from the plot.
Boolean_t	TecUtilPickCopy (void)
	Copy all objects that are currently picked to the paste buffer.
Boolean_t	TecUtilPickClear (void)
	Clear (that is, delete) all objects that are currently picked.
Boolean_t	TecUtilPickPaste (void)
	Paste the currently picked objects from the paste buffer to the workspace.
Boolean_t	TecUtilPickShift (double DXPaper, double DYPaper, PointerStyle_e PointerStyle)
	Shift the currently picked objects.
Boolean_t	TecUtilPickMagnify (double MagFactor)
	Magnify all picked objects.
Boolean_t	TecUtilPickPush (void)
	Change the order in which objects are drawn by pushing the currently picked objects back.
Boolean_t	TecUtilPickPop (void)
	Change the order in which objects are drawn by popping the currently picked objects to the front.
Boolean_t	TecUtilPickSetMouseMode (MouseButtonMode_e MouseMode)
double	TecUtilProbeXYGetIndValue (void)
Boolean_t	TecUtilProbeXYGetDepValue (EntIndex_t MapNum, double *DepValue)
EntIndex_t	TecUtilProbeXYGetSourceMap (void)
Boolean_t	TecUtilPickGeom (Geom_ID GID)
	Add the specified geometry to the pick list.
Boolean_t	TecUtilPickText (Text_ID TID)
	Add the specified text to the pick list.
int	TecUtilPickListGetCount (void)
	Get the number of items currently in the pick list.
PickObjects_e	TecUtilPickListGetType (int PickListIndex)
	Gets the type of object from the pick list at the specified index.
int	TecUtilPickListGetLabelsContourGroup (int PickListIndex)
	Get the contour group number that owns the label item at index PickListIndex.
int	TecUtilPickListGetLegendContourGroup (int PickListIndex)
	Get the contour group number that owns the legend item at index PickListIndex.
char *	TecUtilPickListGetFrameName (int PickListIndex)
	Get the name of the frame from the pick list at the specified index.
UniqueID_t	TecUtilPickListGetFrameUniqueID (int PickListIndex)
	Get the unique identifier of the frame from the pick list at the specified index.
AxisSubObject_e	TecUtilPickListGetAxisSubObject (int PickListIndex)
	Get the picked subobject type of the picked axis object.
char	TecUtilPickListGetAxisKind (int PickListIndex)
	Get the kind of axis (X, Y, or Z) from the pick list at the specified index.
int	TecUtilPickListGetAxisNumber (int PickListIndex)
	Get the number of the axis from the pick list at the specified index.
EntIndex_t	TecUtilPickListGetZoneNumber (int PickListIndex)
	Get the number of the zone from the pick list at the specified index.
void	TecUtilPickListGetZoneIndices (int PickListIndex, LgIndex_t *IIndex, LgIndex_t *JIndex, LgIndex_t *KIndex)
	Get the specific point that was selected in the zone from the pick list at the specified index.
EntIndex_t	TecUtilPickListGetXYMapNumber (int PickListIndex)
EntIndex_t	TecUtilPickListGetLineMapNumber (int PickListIndex)
	Get the number of the Line-mapping from the pick list at the specified index.
LgIndex_t	TecUtilPickListGetXYMapIndex (int PickListIndex)
LgIndex_t	TecUtilPickListGetLineMapIndex (int PickListIndex)
	Get the index value of the specific point that was selected in the Line-mapping from the pick list at the specified index.
Text_ID	TecUtilPickListGetText (int PickListIndex)
	Get the text from the pick list at the specified index.
Geom_ID	TecUtilPickListGetGeom (int PickListIndex)
	Get the geometry from the pick list at the specified index.
void	TecUtilPickListGetGeomInfo (int PickListIndex, SmInteger_t *PolylineNum, LgIndex_t *PointIndex)
	Get the specific point that was selected in the geometry from the pick list at the specified index.

---

Function Documentation

Boolean_t TecUtilPickAddAll

(

PickObjects_e

ObjectType

)

Add all objects of a certain type to the pick list.

See Section 17.4, "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

ObjectType

The type of object to select. Except for PickObjects_Frame, all objects are selected in the current frame. The possible values are: PickObjects_Text (Text) PickObjects_Geom (Geometries) PickObjects_Frame (Frames) PickObjects_Zone (Zones) PickObjects_LineMapping (X-Y Mappings) PickObjects_StreamtracePosition (Streamtraces starting positions)

Returns:

Returns TRUE if any objects of the specified type were found.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickAddAll(ObjectType)
    INTEGER*4 ObjectType

Python Syntax:

  Results = TecUtil.PickAddAll(ObjectType)

  Input:
                  ObjectType           PickObjects_e  (defined in TecVals.py)
  Output:
    Results[0]    ReturnVal            boolean

Select all text and geometries in the current frame:

   Boolean_t TextsExist, GeomsExist;
   TecUtilPickDeselectAll();
   TextsExist = TecUtilPickAddAll(PickObjects_Text);
   GeomsExist = TecUtilPickAddAll(PickObjects_Geom);

Boolean_t TecUtilPickAddAllInRect	(	double	X1,
		double	Y1,
		double	X2,
		double	Y2,
		PickObjects_e	ObjectType,
		const char *	Filter
	)

Add all objects defined within a specified rectangle to the pick list.

The rectangle is defined by the two corner points (X1, Y1) and (X2, Y2) in inches relative to the top left edge of the paper. An optional filter can be defined which specifies more details about which objects to select. See Section 17.4, "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

	X1	X-Value for Top left corner of the rectangle defining the region in which to select objects. (Specify in inches relative to the top left corner of the paper.)
	Y1	Y-Value for Top left corner.
	X2	X-Value for Lower right corner of the rectangle defining the region in which to select objects. (Specify in inches relative to the top left corner of the paper.)
	Y2	Y-Value for Lower right corner.
	ObjectType	The type of object to select within the specified region. Except for PickObjects_Frame, all objects are selected in the current frame within the specified rectangle. The possible values are: PickObjects_Text,PickObjects_Geom, PickObjects_Frame, PickObjects_Zone, PickObjects_LineMapping PickObjects_StreamtracePosition, PickObjects_Axis, PickObjects_ContourLabel.
	Filter	An optional character string which specifies more details about which objects to select within the specified rectangle. If no filter is desired, NULL can be used. The filter uses the same text which is used in the macro language for the $!PICK ADDALLINRECT macro command. The keywords are COLORFILTER=<color>, LINEPATTERNFILTER=<linepattern>, FONTFILTER=<font>, GEOMFILTER=<geomtype>. The filter string can include one or more of these keywords. You can seperate keywords with spaces or '\n'. See the Tecplot Reference Manual for more information about the filter.

Returns:

Returns TRUE if any objects specified by ObjectType and Filter were found within the defined rectangle.

Precondition:

Filter Pointer must be a valid address or NULL.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickAddAllInRect(
   &                   X1,
   &                   Y1,
   &                   X2,
   &                   Y2,
   &                   ObjectType,
   &                   Filter)
    REAL*8          X1
    REAL*8          Y1
    REAL*8          X2
    REAL*8          Y2
    INTEGER*4       ObjectType
    CHARACTER*(*)   Filter

Python Syntax:

  Results = TecUtil.PickAddAllInRect(X1, Y1, X2, Y2, ObjectType, Filter)

  Input:
                  X1                   double
                  Y1                   double
                  X2                   double
                  Y2                   double
                  ObjectType           PickObjects_e  (defined in TecVals.py)
                  Filter               string
  Output:
    Results[0]    ReturnVal            boolean

In the current frame, within the rectangle bounded by (1.5, 1.5) and (7.5, 8.0), select red text, geometries with a dashed line pattern, and all contour labels:

   Boolean_t RedTextsExist, DashedGeomsExist, ContLabelsExist;
   RedTextsExist =
     TecUtilPickAddAllInRect(1.5, 1.5, 7.5, 8.0,
                             PickObjects_Text,
                             "COLORFILTER = RED");
   DashedGeomsExist =
     TecUtilPickAddAllInRect(1.5, 1.5, 7.5, 8.0,
                             PickObjects_Geom,
                             "LINEPATTERNFILTER = DASHED");
   ContLabelsExist =
     TecUtilPickAddAllInRect(1.5, 1.5, 7.5, 8.0,
                             PickObjects_ContourLabel,
                             NULL);

Boolean_t TecUtilPickAddAtPosition	(	double	X,
		double	Y,
		Boolean_t	CollectingObjects,
		Boolean_t	DiggingForObjects,
		Boolean_t	ConsiderStyle
	)

Pick an object at a specified location.

The location is defined as the (X,Y) location in inches relative to the top-left edge of the paper. See Section 17.4, "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Since:

11.4-1-1120

Parameters:

	X	X-location (in inches) relative to the left edge of the paper
	Y	Y-location (in inches) relative to the top edge of the paper
	CollectingObjects	If FALSE, the list of picked objects is cleared before the attempt is made to add a new object. If TRUE, the new object is added to the list of picked objects. (This is like holding Shift down while selecting objects in the workspace.) If CollectingObjects is TRUE, DiggingForObjects must be FALSE
	DiggingForObjects	If TRUE, attempt to pick objects below any currently picked objects at this location. If FALSE, pick the top object at this location. (This is like holding Ctrl down while selecting objects in the workspace. It allows you to select objects which are beneath other objects.) If DiggingForObjects is TRUE, CollectingObjects must be FALSE
	ConsiderStyle	If TRUE, attempt to pick a visible object, checking for invisible objects only if no visible objects are found at this location. If FALSE, pick the top object (or next object, if DiggingForObjects is TRUE), whether visible or not. Visible objects include flooded or shaded surfaces, slices, isosurfaces and stream rods and ribbons.

Returns:

Currently, TRUE is always returned.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickAddAtPosition(
   &                   X,
   &                   Y,
   &                   CollectingObjects,
   &                   DiggingForObjects,
   &                   ConsiderStyle)
    REAL*8          X
    REAL*8          Y
    INTEGER*4       CollectingObjects
    INTEGER*4       DiggingForObjects
    INTEGER*4       ConsiderStyle

Python Syntax:

  Results = TecUtil.PickAddAtPosition(X, Y, CollectingObjects, DiggingForObjects, ConsiderStyle)

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

Select a visible object at the location (1.5, 3.2). Then select the visible object underneath that object instead, and add the visible object at (5.5, 5.4) to the list of picked objects:

   Boolean_t IsOk;
   IsOk = TecUtilPickAddAtPosition(1.5, 3.2, FALSE, FALSE, TRUE);
   IsOk = TecUtilPickAddAtPosition(1.5, 3.2, FALSE, TRUE,  TRUE);
   IsOk = TecUtilPickAddAtPosition(5.5, 5.4, TRUE,  FALSE, TRUE);

Boolean_t TecUtilPickAddFrameByUniqueID	(	Boolean_t	CollectingObjects,
		UniqueID_t	UniqueID
	)

Adds the frame identified by the unique identifier to the pick list.

Each Tecplot frame is assigned a unique ID that can be obtained for the current frame by calling TecUtilFrameGetUniqueID().

Parameters:

	CollectingObjects	Set to TRUE to add frames identified by the unique ID to the pick list. If FALSE, all objects previously picked are first removed from the pick list.
	UniqueID	Unique ID of the frame.

Returns:

TRUE if the pick was successful, FALSE otherwise.

See also:

TecUtilFrameGetUniqueID()

Precondition:

Must have one or more frames.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickAddFrameByUniqueID(
   &                   CollectingObjects,
   &                   UniqueID)
    INTEGER*4 CollectingObjects
    INTEGER*4 UniqueID

Python Syntax:

  Results = TecUtil.PickAddFrameByUniqueID(CollectingObjects, UniqueID)

  Input:
                  CollectingObjects    boolean
                  UniqueID             long
  Output:
    Results[0]    ReturnVal            boolean

Add the current frame to a new pick list.

   {
     UniqueID_t FrameID;
     Boolean_t Picked;
     TecUtilLockStart(AddOnID);
     FrameID = TecUtilFrameGetUniqueID();
     Picked  = TecUtilPickAddFrameByUniqueID(FALSE, FrameID);
     TecUtilLockFinish(AddOnID);
   }

Boolean_t TecUtilPickAddLineMaps	(	Boolean_t	CollectingObjects,
		Set_pa	LineMapSet
	)

Adds the specified Line-maps to the pick object list.

In addition, you can control whether the Line-maps are added to the list of already picked objects or if the pick object list is cleared prior to adding them.

Parameters:

	CollectingObjects	Set to TRUE to add identified linemaps to the pick list. If FALSE, all objects previously picked are removed from the pick list
	LineMapSet	Set of Line-maps to add to the pick list

Returns:

Returns TRUE if the linemaps could be picked, FALSE otherwise.

Precondition:

Must have one or more frames.

LineMapSet Pointer must be a valid address or NULL.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickAddLineMaps(
   &                   CollectingObjects,
   &                   LineMapSetPtr)
    INTEGER*4       CollectingObjects
    POINTER         (LineMapSetPtr, LineMapSet)

Python Syntax:

  Results = TecUtil.PickAddLineMaps(CollectingObjects, LineMapSet)

  Input:
                  CollectingObjects    boolean
                  LineMapSet           sequence of ints
  Output:
    Results[0]    ReturnVal            boolean

Pick Line-maps 1 and 3

   Set_pa LineMapSet;
   LineMapSet = TecUtilSetAlloc(TRUE);
   TecUtilSetAddMember(LineMapSet,1,TRUE);
   TecUtilSetAddMember(LineMapSet,3,TRUE);
   TecUtilPickAddLineMaps(TRUE,LineMapSet);
   TecUtilSetDealloc(&LineMapSet);

Boolean_t TecUtilPickAddXYMaps	(	Boolean_t	CollectingObjects,
		Set_pa	XYMapsSet
	)

Deprecated:

Please use TecUtilPickAddLineMaps() instead.

Python Syntax:

  Results = TecUtil.PickAddXYMaps(CollectingObjects, XYMapsSet)

  Input:
                  CollectingObjects    boolean
                  XYMapsSet            sequence of ints
  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilPickAddZones	(	Boolean_t	CollectingObjects,
		Set_pa	ZoneSet
	)

Adds the specified Line-maps to the pick object list.

In addition, you can control whether the Line-maps are added to the list of already picked objects or if the pick object list is cleared prior to adding them.

Parameters:

	CollectingObjects	Set to TRUE to add identified linemaps to the pick list. If FALSE, all objects previously picked are first removed from the pick list.
	ZoneSet	Set of zones to add to the pick list.

Returns:

Returns TRUE if the zones could be picked, FALSE otherwise.

Precondition:

Must have one or more frames.

ZoneSet Pointer must be a valid address or NULL.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickAddZones(
   &                   CollectingObjects,
   &                   ZoneSetPtr)
    INTEGER*4       CollectingObjects
    POINTER         (ZoneSetPtr, ZoneSet)

Python Syntax:

  Results = TecUtil.PickAddZones(CollectingObjects, ZoneSet)

  Input:
                  CollectingObjects    boolean
                  ZoneSet              sequence of ints
  Output:
    Results[0]    ReturnVal            boolean

Pick zones 1 and 3

   Set_pa ZoneSet;
   ZoneSet = TecUtilSetAlloc(TRUE);
   TecUtilSetAddMember(ZoneSet,1,TRUE);
   TecUtilSetAddMember(ZoneSet,3,TRUE);
   TecUtilPickAddZones(TRUE,ZoneSet);
   TecUtilSetDealloc(&ZoneSet);

Boolean_t TecUtilPickAtPosition	(	double	X,
		double	Y,
		Boolean_t	CollectingObjects,
		Boolean_t	DiggingForObjects
	)

Deprecated:

Please use TecUtilPickAddAtPosition() instead.

Python Syntax:

  Results = TecUtil.PickAtPosition(X, Y, CollectingObjects, DiggingForObjects)

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

Boolean_t TecUtilPickClear

(

void

)

Clear (that is, delete) all objects that are currently picked.

These objects cannot be retrieved.

Returns:

TRUE if any objects were deleted.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickClear()

Python Syntax:

  Results = TecUtil.PickClear()

  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilPickCopy

(

void

)

Copy all objects that are currently picked to the paste buffer.

Returns:

TRUE if successful, FALSE if not or if no objects are currently picked.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickCopy()

Python Syntax:

  Results = TecUtil.PickCopy()

  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilPickCut

(

void

)

Copy all objects that are currently picked to the paste buffer and then delete them from the plot.

Returns:

TRUE if successful, FALSE if not or if no objects are currently picked.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickCut()

Python Syntax:

  Results = TecUtil.PickCut()

  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilPickDeselect

(

int

PickListItem

)

Deselect a single pick list item.

See Section 17.4, "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

PickListItem

The index in the Pick List of the item to be removed. This value must be >= 1 and <= TecUtilPickListGetCount()

Returns:

Currently TRUE is always returned.

See also:

TecUtilPickListGetCount()

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickDeselect()

Python Syntax:

  Results = TecUtil.PickDeselect(PickListItem)

  Input:
                  PickListItem         int
  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilPickDeselectAll

(

void

)

Deselect all selected objects.

See Section 17.4, "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Returns:

Currently TRUE is always returned.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickDeselectAll()

Python Syntax:

  Results = TecUtil.PickDeselectAll()

  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilPickEdit

(

const char *

Action

)

Perform a global edit operation on the currently picked objects.

Only one edit operation is allowed per call to TecUtilPickEdit(). Objects are edited only if the supplied parameter is relevant. See Section 17.4, "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

Action

The action to perform on the currently picked objects. The action uses the same text which is used in the macro language for the $!PickEdit macro command. See the Tecplot Reference Manual for more information about available keywords

Returns:

TRUE if successful, FALSE otherwise.

Precondition:

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

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickEdit(Action)
    CHARACTER*(*) Action

Python Syntax:

  Results = TecUtil.PickEdit(Action)

  Input:
                  Action               string
  Output:
    Results[0]    ReturnVal            boolean

Set the color for all picked objects to yellow. Set the contour type for all picked zones to be "Flood".

   TecUtilPickEdit("COLOR = YELLOW");
   TecUtilPickEdit("CONTOUR {COUNTOURTYPE = FLOOD}");

Boolean_t TecUtilPickGeom

(

Geom_ID

GID

)

Add the specified geometry to the pick list.

See Section 17.4, "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

GID

Geometry ID to pick

Returns:

TRUE if successful. A return value of FALSE usually indicates that Tecplot's limit on the number of picked objects has been exceeded.

Precondition:

GID must be a valid geometry ID.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickGeom(GIDPtr)
    POINTER(GIDPtr, GID)

Python Syntax:

  Results = TecUtil.PickGeom(GID)

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

Pick the first geometry in the current frame:

   Geom_ID gid;
   gid = TecUtilGeomGetBase();
   if (gid ! = NULL)
      TecUtilPickGeom(gid);

char TecUtilPickListGetAxisKind

(

int

PickListIndex

)

Get the kind of axis (X, Y, or Z) from the pick list at the specified index.

The object in the pick list at the specified index must be of type PickObjects_Axis. See Section "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

PickListIndex

Index into the pick list

Returns:

The kind of axis from the pick list at the specified index.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickListGetAxisKind(PickListIndex)
    INTEGER*4 PickListIndex

Python Syntax:

  Results = TecUtil.PickListGetAxisKind(PickListIndex)

  Input:
                  PickListIndex        int
  Output:
    Results[0]    ReturnVal            int

If an axis object is picked, get its type and number:

   int PickIndex, NumPickedItems = TecUtilPickListGetCount();
   for (PickIndex = 1; PickIndex <= NumPickedItems; PickIndex++)
     {
       if (TecUtilPickListGetType(PickIndex) == PickObjects_Axis)
         {
           char AxisKind = TecUtilPickListGetAxisKind(PickIndex);
           int  AxisNum = TecUtilPickListGetAxisNumber(PickIndex);
           .
           .
         }
     }

int TecUtilPickListGetAxisNumber

(

int

PickListIndex

)

Get the number of the axis from the pick list at the specified index.

The object in the pick list at the specified index must be of type PickObjects_Axis. See Section "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

PickListIndex

Index into the pick list

Returns:

For Sketch, 2-D, and 3-D plots, the return value is one. For XY plots, returns the axis number from the pick list at the specified index.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickListGetAxisNumber(PickListIndex)
    INTEGER*4 PickListIndex

Python Syntax:

  Results = TecUtil.PickListGetAxisNumber(PickListIndex)

  Input:
                  PickListIndex        int
  Output:
    Results[0]    ReturnVal            int

AxisSubObject_e TecUtilPickListGetAxisSubObject

(

int

PickListIndex

)

Get the picked subobject type of the picked axis object.

Parameters:

PickListIndex

Index into the pick list. The object in the pick list at the specified index must be of type PickObjects_Axis. See Section "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Returns:

The kind of the picked axis subobject from the pick list at the specified index.

Since:

14.2

Python Syntax:

  Results = TecUtil.PickListGetAxisSubObject(PickListIndex)

  Input:
                  PickListIndex        int
  Output:
    Results[0]    ReturnVal            AxisSubObject_e  (defined in TecVals.py)

int TecUtilPickListGetCount

(

void

)

Get the number of items currently in the pick list.

See Section "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Returns:

Returns the number of items currently in the pick list.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickListGetCount()

Python Syntax:

  Results = TecUtil.PickListGetCount()

  Output:
    Results[0]    ReturnVal            int

Get the number of items in the pick list and loop through the pick list:

   int PickIndex, NumPickedItems = TecUtilPickListGetCount();
   for (PickIndex = 1; PickIndex <= NumPickedItems; PickIndex++)
     {
        //   Go through each object in the pick list using
        //   TecUtilPickListGetType(PickIndex) to determine
        //   the type of object
     }

char* TecUtilPickListGetFrameName

(

int

PickListIndex

)

Get the name of the frame from the pick list at the specified index.

The object in the pick list at the specified index must be of type PickObjects_Frame. See Section "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

PickListIndex

Index into the pick list.

Returns:

The name of the frame from the pick list at the specified index. You must call TecUtilStringDealloc() on the returned string.

Fortran Syntax:

    SUBROUTINE TecUtilPickListGetFrameName(
   &           PickListIndex,
   &           Result,
   &           ResultLength)
    INTEGER*4       PickListIndex
    CHARACTER*(*)   Result
    INTEGER*4       ResultLength

Python Syntax:

  Results = TecUtil.PickListGetFrameName(PickListIndex)

  Input:
                  PickListIndex        int
  Output:
    Results[0]    ReturnVal            string

If the first object in the pick list is a frame, get its name:

   if (TecUtilPickListGetType(1) == PickObjects_Frame)
     {
       char *FrameName = TecUtilPickListGetFrameName(1);
       .
       .
       TecUtilStringDealloc(&FrameName);
     }

UniqueID_t TecUtilPickListGetFrameUniqueID

(

int

PickListIndex

)

Get the unique identifier of the frame from the pick list at the specified index.

The object in the pick list at the specified index must be of type PickObjects_Frame. See Section "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

PickListIndex

Index into the pick list

Returns:

The unique identifier of the frame from the pick list at the specified index.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickListGetFrameUniqueID(PickListIndex)
    INTEGER*4 PickListIndex

Python Syntax:

  Results = TecUtil.PickListGetFrameUniqueID(PickListIndex)

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

If the first object in the pick list is a frame, get its unique identifier:

   if (TecUtilPickListGetType(1) == PickObjects_Frame)
     {
       UniqueID_t UniqueID = TecUtilPickListGetFrameUniqueID(1);
       .
       .
       .
     }

Geom_ID TecUtilPickListGetGeom

(

int

PickListIndex

)

Get the geometry from the pick list at the specified index.

The object in the pick list at the specified index must be of type PickObjects_Geom. See Section "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

PickListIndex

Index into the pick list

Returns:

The geometry ID from the pick list at the specified index.

Fortran Syntax:

    SUBROUTINE TecUtilPickListGetGeom(
   &           PickListIndex,
   &           ResultPtr)
    INTEGER*4      PickListIndex
    POINTER        (ResultPtr, Result)

Python Syntax:

  Results = TecUtil.PickListGetGeom(PickListIndex)

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

If a specific point of a polyline geometry object is picked, set the coordinates for that point to be X = 4.5, Y = 3.2 :

   int PickIndex, NumPickedItems = TecUtilPickListGetCount();
   for (PickIndex = 1; PickIndex <= NumPickedItems; PickIndex++)
     {
       if (TecUtilPickListGetType(PickIndex) == PickObjects_Geom)
         {
           SmInteger_t PolylineNum;
           LgIndex_t   PointIndex;
           Geom_ID GID = TecUtilPickListGetGeom(PickIndex);
           if (TecUtilGeomGetType(GID) == GeomForm_LineSegs)
             TecUtilPickListGetGeomInfo(PickIndex,
                                        &PolylineNum,
                                        &PointIndex);
           if ((PolylineNum > 0) && (PointIndex > 0))
             TecUtilGeom2DMPolySetPoint(GID, PolylineNum,
                                        PointIndex, 4.5, 3.2);
         }
     }

void TecUtilPickListGetGeomInfo	(	int	PickListIndex,
		SmInteger_t *	PolylineNum,
		LgIndex_t *	PointIndex
	)

Get the specific point that was selected in the geometry from the pick list at the specified index.

The object in the pick list at the specified index must be of type PickObjects_Geom. In order to get useful information from this function, the geometry should be of type GeomForm_LineSegs or GeomForm_LineSegs3D. The mouse mode should be MouseButtonMode_Adjust or MouseButtonMode_AdvancedAdjust. See Section "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

	PickListIndex	Index into the pick list.
	PolylineNum	The number of the polyline that was selected if the geometry is a line segment and the Adjustor mode is being used. Otherwise, zero
	PointIndex	The index of the specific point that was selected in the polyline if the geometry is a line segment and the Adjustor mode is being used. Otherwise, zero.

Precondition:

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

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

Fortran Syntax:

    SUBROUTINE TecUtilPickListGetGeomInfo(
   &           PickListIndex,
   &           PolylineNum,
   &           PointIndex)
    INTEGER*4       PickListIndex
    INTEGER*4       PolylineNum
    INTEGER*4       PointIndex

Python Syntax:

  Results = TecUtil.PickListGetGeomInfo(PickListIndex)

  Input:
                  PickListIndex        int
  Output:
    Results[0]    PolylineNum          int
    Results[1]    PointIndex           int

int TecUtilPickListGetLabelsContourGroup

(

int

PickListIndex

)

Get the contour group number that owns the label item at index PickListIndex.

Since:

14.2

Parameters:

PickListIndex

Index into the pick list

Returns:

Contour group number.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickListGetLabelsContourGroup(PickListIndex)
    INTEGER*4 PickListIndex

Python Syntax:

  Results = TecUtil.PickListGetLabelsContourGroup(PickListIndex)

  Input:
                  PickListIndex        int
  Output:
    Results[0]    ReturnVal            int

int TecUtilPickListGetLegendContourGroup

(

int

PickListIndex

)

Get the contour group number that owns the legend item at index PickListIndex.

Since:

14.2

Parameters:

PickListIndex

Index into the pick list

Returns:

Contour group number.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickListGetLegendContourGroup(PickListIndex)
    INTEGER*4 PickListIndex

Python Syntax:

  Results = TecUtil.PickListGetLegendContourGroup(PickListIndex)

  Input:
                  PickListIndex        int
  Output:
    Results[0]    ReturnVal            int

LgIndex_t TecUtilPickListGetLineMapIndex

(

int

PickListIndex

)

Get the index value of the specific point that was selected in the Line-mapping from the pick list at the specified index.

The object in the pick list at the specified index must be of type PickObjects_LineMapping. In order to get useful information from this function, the mouse mode should be of the type MouseButtonMode_Adjust or MouseButtonMode_AdvancedAdjust. See Section "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

PickListIndex

Index into the pick list.

Returns:

The index value of the specific point that was selected in the Line-mapping from the pick list at the specified index if the Adjustor mode is being used. Otherwise, zero.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickListGetLineMapIndex(PickListIndex)
    INTEGER*4 PickListIndex

Python Syntax:

  Results = TecUtil.PickListGetLineMapIndex(PickListIndex)

  Input:
                  PickListIndex        int
  Output:
    Results[0]    ReturnVal            int

If the first object in the pick list is an Line-mapping, get its number and index:

   if (TecUtilPickListGetType(1) == PickObjects_LineMapping)
     {
       EntIndex_t MapNumber = TecUtilPickListGetLineMapNumber(1);
       LgIndex_t  MapIndex  = TecUtilPickListGetLineMapIndex(1);

       // Do Something here

     }

EntIndex_t TecUtilPickListGetLineMapNumber

(

int

PickListIndex

)

Get the number of the Line-mapping from the pick list at the specified index.

The object in the pick list at the specified index must be of type PickObjects_LineMapping. See Section "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

PickListIndex

Index into the pick list.

Returns:

The number of the Line-mapping from the pick list at the specified index.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickListGetLineMapNumber(PickListIndex)
    INTEGER*4 PickListIndex

Python Syntax:

  Results = TecUtil.PickListGetLineMapNumber(PickListIndex)

  Input:
                  PickListIndex        int
  Output:
    Results[0]    ReturnVal            int

Text_ID TecUtilPickListGetText

(

int

PickListIndex

)

Get the text from the pick list at the specified index.

The object in the pick list at the specified index must be of type PickObjects_Text. See Section "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

PickListIndex

Index into the pick list

Returns:

The text ID from the pick list at the specified index.

Fortran Syntax:

    SUBROUTINE TecUtilPickListGetText(
   &           PickListIndex,
   &           ResultPtr)
    INTEGER*4      PickListIndex
    POINTER        (ResultPtr, Result)

Python Syntax:

  Results = TecUtil.PickListGetText(PickListIndex)

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

For every text object which is picked, set it to have a filled text box:

   int PickIndex, NumPickedItems = TecUtilPickListGetCount();
   for (PickIndex = 1; PickIndex <= NumPickedItems; PickIndex++)
     {
       if (TecUtilPickListGetType(PickIndex) == PickObjects_Text)
         {
           Text_ID TID = TecUtilPickListGetText(PickIndex);
           TecUtilTextBoxSetType(TID, TextBox_Filled);
         }
     }

PickObjects_e TecUtilPickListGetType

(

int

PickListIndex

)

Gets the type of object from the pick list at the specified index.

See Section "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

PickListIndex

Index into the pick list

Returns:

The type of object from the pick list at the specified index.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickListGetType(PickListIndex)
    INTEGER*4 PickListIndex

Python Syntax:

  Results = TecUtil.PickListGetType(PickListIndex)

  Input:
                  PickListIndex        int
  Output:
    Results[0]    ReturnVal            PickObjects_e  (defined in TecVals.py)

Go through the pick list, checking object types:

   int PickIndex, NumPickedItems = TecUtilPickListGetCount();
   for (PickIndex = 1; PickIndex <= NumPickedItems; PickIndex++)
     {
       PickObjects_e ObjectType = TecUtilPickListGetType(PickIndex);
       switch (ObjectType)
        {
        case PickObjects_Geom :
          // Do something with picked geometries
          break;
        case PickObjects_Text :
          // Do something with picked text
          break;
        case PickObjects_Zone :
          // Do something with picked zones
          break;
        case PickObjects_LineMapping :
          // Do something with picked line mappings
          break;
          .
          .
        }
     }

LgIndex_t TecUtilPickListGetXYMapIndex

(

int

PickListIndex

)

Deprecated:

Please use TecUtilPickListGetLineMapIndex() instead.

Python Syntax:

  Results = TecUtil.PickListGetXYMapIndex(PickListIndex)

  Input:
                  PickListIndex        int
  Output:
    Results[0]    ReturnVal            int

EntIndex_t TecUtilPickListGetXYMapNumber

(

int

PickListIndex

)

Deprecated:

Please use TecUtilPickListGetLineMapNumber() instead.

Python Syntax:

  Results = TecUtil.PickListGetXYMapNumber(PickListIndex)

  Input:
                  PickListIndex        int
  Output:
    Results[0]    ReturnVal            int

void TecUtilPickListGetZoneIndices	(	int	PickListIndex,
		LgIndex_t *	IIndex,
		LgIndex_t *	JIndex,
		LgIndex_t *	KIndex
	)

Get the specific point that was selected in the zone from the pick list at the specified index.

The object in the pick list at the specified index must be of type PickObjects_Zone. See Section "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

	PickListIndex	Index into the pick list
	IIndex	The I-index value of the point that was selected in the zone
	JIndex	The J-index value of the point that was selected in the zone
	KIndex	The K-index value of the point that was selected in the zone

Precondition:

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

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

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

Fortran Syntax:

    SUBROUTINE TecUtilPickListGetZoneIndices(
   &           PickListIndex,
   &           IIndex,
   &           JIndex,
   &           KIndex)
    INTEGER*4       PickListIndex
    INTEGER*4       IIndex
    INTEGER*4       JIndex
    INTEGER*4       KIndex

Python Syntax:

  Results = TecUtil.PickListGetZoneIndices(PickListIndex)

  Input:
                  PickListIndex        int
  Output:
    Results[0]    IIndex               int
    Results[1]    JIndex               int
    Results[2]    KIndex               int

If the first object in the pick list is a zone, get its number and indices:

   if (TecUtilPickListGetType(1) == PickObjects_Zone)
     {
      LgIndex_t  IIndex, JIndex, KIndex;
      EntIndex_t ZoneNumber = TecUtilPickListGetZoneNumber(1);
      TecUtilPickListGetZoneIndices(1, &IIndex, &JIndex, &KIndex);
      .
      .
     }

EntIndex_t TecUtilPickListGetZoneNumber

(

int

PickListIndex

)

Get the number of the zone from the pick list at the specified index.

The object in the pick list at the specified index must be of type PickObjects_Zone. See Section "The Pick List," in the ADK User's Manual for a discussion of pick lists.

Parameters:

PickListIndex

Index into the pick list

Returns:

The number of the zone from the pick list at the specified index.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickListGetZoneNumber(PickListIndex)
    INTEGER*4 PickListIndex

Python Syntax:

  Results = TecUtil.PickListGetZoneNumber(PickListIndex)

  Input:
                  PickListIndex        int
  Output:
    Results[0]    ReturnVal            int

Boolean_t TecUtilPickMagnify

(

double

MagFactor

)

Magnify all picked objects.

The first object picked will remain in place; the other picked objects will move proportionally as the image is magnified. Only frames, text, and geometries are allowed to be magnified.

Parameters:

MagFactor

Amount to magnify

Returns:

TRUE if picked objects could be magnified, FALSE if not.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickMagnify(MagFactor)
    REAL*8 MagFactor

Python Syntax:

  Results = TecUtil.PickMagnify(MagFactor)

  Input:
                  MagFactor            double
  Output:
    Results[0]    ReturnVal            boolean

Double the size of all picked objects.

   Boolean_t IsOk = TecUtilPickMagnify(2.0);

Boolean_t TecUtilPickPaste

(

void

)

Paste the currently picked objects from the paste buffer to the workspace.

Returns:

TRUE if successful, FALSE if not.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickPaste()

Python Syntax:

  Results = TecUtil.PickPaste()

  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilPickPop

(

void

)

Change the order in which objects are drawn by popping the currently picked objects to the front.

Only frames, text, geometries, and the grid area for 2-D plots are allowed to be popped.

Returns:

TRUE if all currently picked objects are allowed to be popped, FALSE if not.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickPop()

Python Syntax:

  Results = TecUtil.PickPop()

  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilPickPush

(

void

)

Change the order in which objects are drawn by pushing the currently picked objects back.

Only frames, text, geometries, and the grid area for 2-D plots are allowed to be pushed.

Returns:

TRUE if all currently picked objects are allowed to be pushed, FALSE if not.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickPush()

Python Syntax:

  Results = TecUtil.PickPush()

  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilPickSetMouseMode

(

MouseButtonMode_e

MouseMode

)

Deprecated:

Please use TecUtilMouseSetMode() instead.

Python Syntax:

  Results = TecUtil.PickSetMouseMode(MouseMode)

  Input:
                  MouseMode            MouseButtonMode_e  (defined in TecVals.py)
  Output:
    Results[0]    ReturnVal            boolean

Boolean_t TecUtilPickShift	(	double	DXPaper,
		double	DYPaper,
		PointerStyle_e	PointerStyle
	)

Shift the currently picked objects.

Objects are shifted relative to their starting position. X and Y shift amounts are in paper units (inches). If snapping is in effect then it is applied after shifting in X and Y.

Parameters:

	DXPaper	Shift amount in the X-direction. Units are in inches. Positive numbers will shift objects to the right. Ignored if PointerStyle is PointerStyle_BottomBracket, PointerStyle_TopBracket, or PointerStyle_UpDown
	DYPaper	Shift amount in the Y-direction. Units are in inches. Positive numbers will shift objects down. Ignored if PointerStyle is PointerStyle_LeftBracket, PointerStyle_RightBracket, or PointerStyle_LeftRight.
	PointerStyle	The type of shift to perform on the picked objects. This is ignored if not appropriate for the currently selected objects. PointerStyle_AllDirections is appropriate for all types of objects. Currently, the other options are only available for Axis and Frame objects. See PointerStyle_e.

Returns:

TRUE if successful, FALSE if no items are selected or if a zone or Line-mapping is selected and the current mouse mode is not the Adjustor tool. Objects can only be selected if the current mouse mode is the selector or the Adjustor tool.

Fortran Syntax:

    INTEGER*4 FUNCTION TecUtilPickShift(
   &                   DXPaper,
   &                   DYPaper,
   &                   PointerStyle)
    REAL*8          DXPaper
    REAL*8          DYPaper
    INTEGER*4       PointerStyle

Python Syntax:

  Results = TecUtil.PickShift(DXPaper, DYPaper, PointerStyle)

  Input:
                  DXPaper              double
                  DYPaper              double
                  PointerStyle         int
  Output:
    Results[0]    ReturnVal            boolean

Select all frames and resize their upper-left corners to be 2.5 inches to the right and 3.5 inches down from their previous location. Then, select all text in the current frame and move them 1.5 inches to the left and 0.25 inches up from their previous locations:

   TecUtilPickSetMouseMode(MouseButtonMode_Select);
   if (TecUtilPickAddAll(PickObjects_Frame))
     TecUtilPickShift(2.5, 3.5, PointerStyle_UpperLeftBracket);
   TecUtilPickDeselectAll();
   if (TecUtilPickAddAll(PickObjects_Text))
     TecUtilPickShift(-1.5, -0.25, PointerStyle_AllDirections);

Boolean_t TecUtilPickText

(

Text_ID

TID

)

Add the specified text to the pick list.

See the ADK User's Manual for a discussion of pick lists.

Parameters:

TID

Text ID to pick

Returns:

TRUE if successful. A return value of FALSE usually indicates that Tecplot's limit on the number of picked objects has been exceeded.

Precondition:

TID must be a valid text ID.

Fortran Syntax:

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

Python Syntax:

  Results = TecUtil.PickText(TID)

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

Pick the first text in the current frame.

   Text_ID tid;
   tid = TecUtilTextGetBase();
   if (tid ! = NULL)
      TecUtilPickText(tid);

Boolean_t TecUtilProbeXYGetDepValue	(	EntIndex_t	MapNum,
		double *	DepValue
	)

Deprecated:

Please use TecUtilProbeLinePlotGetDepValue() instead.

Python Syntax:

  Results = TecUtil.ProbeXYGetDepValue(MapNum)

  Input:
                  MapNum               int
  Output:
    Results[0]    ReturnVal            boolean
    Results[1]    DepValue             double

double TecUtilProbeXYGetIndValue

(

void

)

Deprecated:

Please use TecUtilProbeLinePlotGetIndValue() instead.

Python Syntax:

  Results = TecUtil.ProbeXYGetIndValue()

  Output:
    Results[0]    ReturnVal            double

EntIndex_t TecUtilProbeXYGetSourceMap

(

void

)

Deprecated:

Please use TecUtilProbeLinePlotGetSourceMap() instead.

Python Syntax:

  Results = TecUtil.ProbeXYGetSourceMap()

  Output:
    Results[0]    ReturnVal            int