Geometry


Functions
void	TecUtilGeomDelete (Geom_ID GID)
	Deletes the specified geometry object.
Boolean_t	TecUtilGeomIsValid (Geom_ID GID)
	Validate a geometry ID.
Clipping_e	TecUtilGeomGetClipping (Geom_ID GID)
	Function will get the clipping properties of a geometry.
void	TecUtilGeomGetAnchorPos (Geom_ID GID, double XOrThetaPos, double YOrRPos, double *ZPos)
	Gets the anchor postion of the specified geometry.
void	TecUtilGeomImageSetUseRatio (Geom_ID GID, Boolean_t MaintainAspectRatio)
	Sets the state of the "preserve aspect ratio" toggle for an image geometry.
void	TecUtilGeomGetXYZAnchorPos (Geom_ID GID, double XPos, double YPos, double *ZPos)

EntIndex_t	TecUtilGeomGetZoneOrMap (Geom_ID GID)
	Get the zone or Line-mapping to which the geometry is attached.
Boolean_t	TecUtilGeomIsAttached (Geom_ID GID)
	Determine whether or not a geometry is attached to a zone or Line-mapping.
ColorIndex_t	TecUtilGeomGetColor (Geom_ID GID)
	Get the geometry line color.
ColorIndex_t	TecUtilGeomGetFillColor (Geom_ID GID)
	Get the geometry fill color.
Boolean_t	TecUtilGeomGetIsFilled (Geom_ID GID)
	Determine if a geometry if filled.
GeomForm_e	TecUtilGeomGetType (Geom_ID GID)
	Get the geometry type.
LinePattern_e	TecUtilGeomGetLinePattern (Geom_ID GID)
	Get the line pattern of a geometry.
double	TecUtilGeomGetPatternLength (Geom_ID GID)
	Get the geometry line pattern length.
double	TecUtilGeomGetLineThickness (Geom_ID GID)
	Get the geometry line thickness.
SmInteger_t	TecUtilGeomEllipseGetNumPoints (Geom_ID GID)
	Get the number of points used to draw a circle or ellipse geometry.
ArrowheadStyle_e	TecUtilGeomArrowheadGetStyle (Geom_ID GID)
	Get the geometry arrowhead style.
ArrowheadAttachment_e	TecUtilGeomArrowheadGetAttach (Geom_ID GID)
	Get the geometry arrowhead attachment.
double	TecUtilGeomArrowheadGetSize (Geom_ID GID)
	Get the geometry arrowhead size.
double	TecUtilGeomArrowheadGetAngle (Geom_ID GID)
	Get the geometry arrowhead angle.
Scope_e	TecUtilGeomGetScope (Geom_ID GID)
	Get the geometry scope.
CoordSys_e	TecUtilGeomGetPositionCoordSys (Geom_ID GID)
	Get the geometry position coordinate system.
ImageResizeFilter_e	TecUtilGeomImageGetResizeFilter (Geom_ID GID)
	Get the resize filter of an image geometry.
void	TecUtilGeomImageSetResizeFilter (Geom_ID GID, ImageResizeFilter_e ResizeFilter)
	Sets the resize filter of an image geometry.
void	TecUtilGeomImageGetFileName (Geom_ID GID, char **FileName)
	Get the name of the file associated with an image geometry.
void	TecUtilGeomImageSetWidth (Geom_ID GID, double Width)
	Sets the width of an image geometry.
void	TecUtilGeomImageSetHeight (Geom_ID GID, double Height)
	Sets the Height of an image geometry.
void	TecUtilGeomImageGetSize (Geom_ID GID, double Width, double Height)
	Get the width and height of an image geometry.
void	TecUtilGeomImageResetAspectRatio (Geom_ID GID)
	Resets the aspect ratio after any changes have been made in the position of an image geometry.
Boolean_t	TecUtilGeomGetMacroFunctionCmd (Geom_ID GID, char **MacroFunctionCmd)
	Get the geometry macro function command.
Geom_ID	TecUtilGeomImageCreate (const char *FName, double CornerX, double CornerY, double Size)
	Create an image geometry.
Geom_ID	TecUtilGeomGetNext (Geom_ID GID)
	Get the next geometry in the list of geometries attached to the current frame.
Geom_ID	TecUtilGeomGetPrev (Geom_ID GID)
	Get the previous geometry in the list of geometries attached to the current frame.
void	TecUtilGeomSetClipping (Geom_ID GID, Clipping_e Clipping)
	Set the clipping properties of a geometry.
void	TecUtilGeomSetAnchorPos (Geom_ID GID, double XPos, double YPos, double ZPos)
	Set the anchor position for a geometry.
void	TecUtilGeomSetXYZAnchorPos (Geom_ID GID, double XPos, double YPos, double ZPos)

void	TecUtilGeomSetZoneOrMap (Geom_ID GID, EntIndex_t ZoneOrMap)
	Set the zone or Line-mapping attachment for a geometry.
void	TecUtilGeomSetAttached (Geom_ID GID, Boolean_t Attached)
	Set whether or not a geometry is attached to a zone or Line-mapping.
void	TecUtilGeomSetColor (Geom_ID GID, ColorIndex_t Color)
	Set the line color of a geometry.
void	TecUtilGeomSetFillColor (Geom_ID GID, ColorIndex_t FillColor)
	Set the fill color of a geometry.
void	TecUtilGeomSetIsFilled (Geom_ID GID, Boolean_t IsFilled)
	Set whether or not a geometry is filled with a color.
void	TecUtilGeomSetLinePattern (Geom_ID GID, LinePattern_e LinePattern)
	Set the line pattern for a geometry.
void	TecUtilGeomSetPatternLength (Geom_ID GID, double PatternLength)
	Set the line pattern length for a geometry.
void	TecUtilGeomSetLineThickness (Geom_ID GID, double LineThickness)
	Set the line thickness for a geometry.
void	TecUtilGeomEllipseSetNumPoints (Geom_ID GID, SmInteger_t NumEllipsePts)
	Set the number of points used to draw a circle or an ellipse geometry.
void	TecUtilGeomArrowheadSetStyle (Geom_ID GID, ArrowheadStyle_e ArrowheadStyle)
	Set the arrowhead style for a geometry.
void	TecUtilGeomArrowheadSetAttach (Geom_ID GID, ArrowheadAttachment_e ArrowheadAttachment)
	Set the arrowhead attachment for a geometry.
void	TecUtilGeomArrowheadSetSize (Geom_ID GID, double ArrowheadSize)
	Set the arrowhead size for a geometry.
void	TecUtilGeomArrowheadSetAngle (Geom_ID GID, double ArrowheadAngle)
	Set the arrowhead angle for a geometry.
void	TecUtilGeomSetDrawOrder (Geom_ID GID, DrawOrder_e DrawOrder)
	Sets the draw order of a geometry.
Boolean_t	TecUtilGeomImageGetUseRatio (Geom_ID GID)
	Queries the state of the "preserve aspect ratio" toggle for an image geometry.
DrawOrder_e	TecUtilGeomGetDrawOrder (Geom_ID GID)
	Gets the draw order of a geometry.
void	TecUtilGeomSetScope (Geom_ID GID, Scope_e Scope)
	Set the scope for a geometry.
void	TecUtilGeomSetPositionCoordSys (Geom_ID GID, CoordSys_e CoordSys)
	Set the position coordinate system for a geometry.
Boolean_t	TecUtilGeomSetMacroFunctionCmd (Geom_ID GID, const char *Command)
	Set the macro function command for a geometry.
Geom_ID	TecUtilGeomSquareCreate (CoordSys_e PositionCoordSys, double CornerX, double CornerY, double Size)
	Create a square geometry.
Geom_ID	TecUtilGeomCircleCreate (CoordSys_e PositionCoordSys, double CenterX, double CenterY, double Radius)
	Create a circle geometry.
Geom_ID	TecUtilGeomRectangleCreate (CoordSys_e PositionCoordSys, double CornerX, double CornerY, double Width, double Height)
	Create a rectangle geometry.
Geom_ID	TecUtilGeomEllipseCreate (CoordSys_e PositionCoordSys, double CenterX, double CenterY, double HAxis, double VAxis)
	Create an ellipse geometry.
Geom_ID	TecUtilGeom2DPolylineCreate (CoordSys_e PositionCoordSys, double PtsX_Array, double PtsY_Array, LgIndex_t NumPts)
	Create a 2-D polyline geometry.
Geom_ID	TecUtilGeom3DPolylineCreate (double PtsX_Array, double PtsY_Array, double *PtsZ_Array, LgIndex_t NumPts)
	Create a 3-D polyline geometry.
Geom_ID	TecUtilGeom2DMPolyCreate (CoordSys_e PositionCoordSys, LgIndex_t NumPolys, LgIndex_t *NumPointsInPolylines_Array)
	Create a 2-D multi-polyline geometry.
Geom_ID	TecUtilGeom3DMPolyCreate (LgIndex_t NumPolys, LgIndex_t *NumPointsInPolylines_Array)
	Create a 3-D multi-polyline geometry.
Geom_ID	TecUtilGeomArcCreate (CoordSys_e PositionCoordSys, double CenterX, double CenterY, double Radius, double StartAngle, double EndAngle)
	Create a 2-D arc.
Geom_ID	TecUtilGeom2DLineSegmentCreate (CoordSys_e PositionCoordSys, double X1, double Y1, double X2, double Y2)
	Create a 2-D line geometry.
Geom_ID	TecUtilGeom3DLineSegmentCreate (double X1, double Y1, double Z1, double X2, double Y2, double Z2)
	Create a 3-D line.
LgIndex_t	TecUtilGeomMPolyGetPolylineCnt (Geom_ID GID)
	Get the number of polylines in a multi-polyline geometry.
LgIndex_t	TecUtilGeomPolyGetPointCount (Geom_ID GID)
	Get the number of points in a polyline geometry.
LgIndex_t	TecUtilGeomMPolyGetPointCount (Geom_ID GID, LgIndex_t PolyNum)
	Get information about the number of points in a polyline of a multi-polyline geometry.
void	TecUtilGeom2DMPolyGetPoint (Geom_ID GID, LgIndex_t PolyNum, LgIndex_t PointIndex, double X, double Y)
	Gets the 2-D (X,Y) value of point in a 2-D multi-polyline geometry.
void	TecUtilGeom2DPolylineGetPoint (Geom_ID GID, LgIndex_t PointIndex, double X, double Y)
	Get a point (X,Y) of a 2-D polyline.
void	TecUtilGeom2DMPolySetPoint (Geom_ID GID, LgIndex_t PolyNum, LgIndex_t PointIndex, double X, double Y)
	Set the 2-D (X,Y) value of point in a 2-D multi-polyline geometry.
void	TecUtilGeom2DPolylineSetPoint (Geom_ID GID, LgIndex_t PointIndex, double X, double Y)
	Set a point (X,Y) of a 2-D polyline.
void	TecUtilGeom2DMPolySetPolyline (Geom_ID GID, LgIndex_t PolyNum, double X_Array, double Y_Array)
	Set the points for a polyline in a 2-D multi-polyline geometry.
void	TecUtilGeom3DMPolyGetPoint (Geom_ID GID, LgIndex_t PolyNum, LgIndex_t PointIndex, double X, double Y, double *Z)
	Get the 3-D (X, Y, Z) value of point in a 3-D multi-polyline geometry.
void	TecUtilGeom3DPolylineGetPoint (Geom_ID GID, LgIndex_t PointIndex, double X, double Y, double *Z)
	Get a point (X, Y, Z) of a 3-D polyline
void	TecUtilGeom3DMPolySetPoint (Geom_ID GID, LgIndex_t PolyNum, LgIndex_t PointIndex, double X, double Y, double Z)
	Set the 3-D (X, Y, Z) value of point in a 3-D multi-polyline geometry.
void	TecUtilGeom3DPolylineSetPoint (Geom_ID GID, LgIndex_t PointIndex, double X, double Y, double Z)
	Set a point (X, Y, Z) of a 3-D polyline.
void	TecUtilGeom3DMPolySetPolyline (Geom_ID GID, LgIndex_t PolyNum, double X_Array, double Y_Array, double *Z_Array)
	Set the points for a polyline in a 3-D multi-polyline geometry.
double	TecUtilGeomCircleGetRadius (Geom_ID GID)
	Return the radius of a circle geometry.
void	TecUtilGeomCircleSetRadius (Geom_ID GID, double Radius)
	Set the radius of a circle geometry.
double	TecUtilGeomSquareGetSize (Geom_ID GID)
	Get the size of a square geometry.
void	TecUtilGeomSquareSetSize (Geom_ID GID, double Size)
	Set the size of a square geometry.
void	TecUtilGeomRectangleGetSize (Geom_ID GID, double Width, double Height)
	Get the width and height of a rectangle geometry.
void	TecUtilGeomRectangleSetSize (Geom_ID GID, double Width, double Height)
	Set the width and height of a rectangle geometry.
void	TecUtilGeomEllipseGetSize (Geom_ID GID, double HAxis, double VAxis)
	Get length of the axes of an ellipse.
void	TecUtilGeomEllipseSetSize (Geom_ID GID, double HAxis, double VAxis)
	Set the length of the axes of an ellipse.
Geom_ID	TecUtilGeomGetBase (void)
	Get the base geometry attached to the current frame.

Function Documentation

Geom_ID TecUtilGeom2DLineSegmentCreate	(	CoordSys_e	PositionCoordSys,
		double	X1,
		double	Y1,
		double	X2,
		double	Y2
	)

Create a 2-D line geometry.

Use the ID obtained from this function to set geometry attributes such as line style and color using the TecUtilGeomSetXxx functions.

Parameters:

	PositionCoordSys	Coordinate system used to position the geometry. The possible values are: CoordSys_Grid or CoordSys_Frame.
	X1	X-Coordinate for the starting position of the line.
	Y1	Y-Coordinate for the starting position of the line.
	X2	X-Coordinate for the ending position of the line.
	Y2	Y-Coordinate for the ending position of the line.

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

Fortran Syntax:

    SUBROUTINE TecUtilGeom2DLineSegmentCreate(
   &           PositionCoordSys,
   &           X1,
   &           Y1,
   &           X2,
   &           Y2,
   &           ResultPtr)
    INTEGER*4      PositionCoordSys
    REAL*8         X1
    REAL*8         Y1
    REAL*8         X2
    REAL*8         Y2
    POINTER        (ResultPtr, Result)

Python Syntax:

  Results = TecUtil.Geom2DLineSegmentCreate(PositionCoordSys, X1, Y1, X2, Y2)

  Input:
                  PositionCoordSys     CoordSys_e  (defined in TecVals.py)
                  X1                   double
                  Y1                   double
                  X2                   double
                  Y2                   double
  Output:
    Results[0]    ReturnVal            long

Create a 2-D line geometry from (0.1, 0.2) to (0.5, 0.6):

   Geom_ID G;
   G = TecUtilGeom2DLineSegmentCreate(CoordSys_Grid,
                                      .1,.2,.5,.6);

Geom_ID TecUtilGeom2DMPolyCreate	(	CoordSys_e	PositionCoordSys,
		LgIndex_t	NumPolys,
		LgIndex_t *	NumPointsInPolylines_Array
	)

Create a 2-D multi-polyline geometry.

After creating the 2-D multi-polyline geometry, you must assign values to the points in it with TecUtilGeom2DPolylineSetPoint() or TecUtilGeom2DMPolySetPolyline(). Use the ID obtained from this function to set geometry attributes such as line style and color using the TecUtilGeomSetXxx functions.

Parameters:

	PositionCoordSys	Coordinate System. The possible values are: CoordSys_Grid or CoordSys_Frame.
	NumPolys	Number of polylines in the multi-polyline. Must be greater than zero
	NumPointsInPolylines_Array	Array of points in each polyline. Each polyline must have at least two points

Returns:: The geometry ID of the 2-D multi polyline.

Fortran Syntax:

    SUBROUTINE  TecUtilGeom2DMPolyCreate(
   &            PositionCoordSys,
   &            NumPolys,
   &            NumPointsInPolylines_Array,
   &            ResultPtr)
    INTEGER*4       PositionCoordSys
    INTEGER*4       NumPolys
    INTEGER*4       NumPointsInPolylines_Array
    POINTER         (ResultPtr, Result)

Python Syntax:

  Results = TecUtil.Geom2DMPolyCreate(PositionCoordSys, NumPolys, NumPointsInPolylines_Array)

  Input:
                  PositionCoordSys     CoordSys_e  (defined in TecVals.py)
                  NumPolys             int
                  NumPointsInPolylines_Array list of ints
  Output:
    Results[0]    ReturnVal            long

Create a 2-D multi-polyline with two polylines. The first polyline has three points, the second has two:

   LgIndex_t pts_per_line[2] = { 3, Z }; // two polylines 
   double x_polyline_1 = { 0.0, 1.0, 2.0 }; // three points 
   double y_polyline_1 = { 0.0, 1.0, 0.0 };
   double x_polyline_2 = { 1.0, 2.0 }; // two points 
   double y_polyline_2 = { 1.0, 0.0 };
   Geom_ID g;
   
   g = TecUtilGeom2DMPolyCreate(CoordSys_Grid, Z, pts_per_line);
   TecUtilGeom2DMPolySetPolyline(g, 1, x_polyline_1, y_polyline_1);
   TecUtilGeom2DMPolySetPolyline(g, 2, x_polyline_2, y_polyline_2);

void TecUtilGeom2DMPolyGetPoint	(	Geom_ID	GID,
		LgIndex_t	PolyNum,
		LgIndex_t	PointIndex,
		double *	X,
		double *	Y
	)

Gets the 2-D (X,Y) value of point in a 2-D multi-polyline geometry.

Parameters:

	GID	Geometry ID. This must be a 2-D multi-polyline geometry
	PolyNum	Polyline number. Must be greater than or equal to one, and less than or equal to the number of polylines in the geometry
	PointIndex	Index of the point in the polyline. Must be greater than or equal to one, and less than or equal to the number of points in the polyline
	X	Receives the X-value of the point. Must not be NULL
	Y	Receives the Y-value of the point. Must not be NULL

Fortran Syntax:

    SUBROUTINE TecUtilGeom2DMPolyGetPoint(
   &           GIDPtr,
   &           PolyNum,
   &           PointIndex,
   &           X,
   &           Y)
    POINTER         (GIDPtr, GID)
    INTEGER*4       PolyNum
    INTEGER*4       PointIndex
    REAL*8          X
    REAL*8          Y

Python Syntax:

  Results = TecUtil.Geom2DMPolyGetPoint(GID, PolyNum, PointIndex)

  Input:
                  GID                  long
                  PolyNum              int
                  PointIndex           int
  Output:
    Results[0]    X                    double
    Results[1]    Y                    double

Get the value of the tenth point in the second polyline of a 2-D multi-polyline geometry:

   double X,Y;
   extern Geom_ID g; // assume this was allocated somewhere 
   TecUtilGeom2DMPolyGetPoint(g,2,10,&X,&Y);

void TecUtilGeom2DMPolySetPoint	(	Geom_ID	GID,
		LgIndex_t	PolyNum,
		LgIndex_t	PointIndex,
		double	X,
		double	Y
	)

Set the 2-D (X,Y) value of point in a 2-D multi-polyline geometry.

Parameters:

	GID	Geometry ID. This must be a 2-D multi-polyline geometry
	PolyNum	Polyline number. Must be greater than or equal to one, and less than or equal to the number of polylines in the geometry
	PointIndex	Index of the point in the polyline. Must be greater than or equal to one, and less than or equal to the number of points in the polyline
	X	New X-value of the point
	Y	New Y-value of the point

Fortran Syntax:

    SUBROUTINE TecUtilGeom2DMPolySetPoint(
   &           GIDPtr,
   &           PolyNum,
   &           PointIndex,
   &           X,
   &           Y)
    POINTER         (GIDPtr, GID)
    INTEGER*4       PolyNum
    INTEGER*4       PointIndex
    REAL*8          X
    REAL*8          Y

Python Syntax:

  Results = TecUtil.Geom2DMPolySetPoint(GID, PolyNum, PointIndex, X, Y)

  Input:
                  GID                  long
                  PolyNum              int
                  PointIndex           int
                  X                    double
                  Y                    double
  Output:
    Results[0]    ReturnVal            NONE

Set the value of the tenth point in the second polyline of a 2-D multi-polyline geometry:

   extern Geom_ID g; // assume this was allocated somewhere 
   TecUtilGeom2DMPolySetPoint(g,2,10,1.5,2.2);//set to (1.5,2.2)

void TecUtilGeom2DMPolySetPolyline	(	Geom_ID	GID,
		LgIndex_t	PolyNum,
		double *	X_Array,
		double *	Y_Array
	)

Set the points for a polyline in a 2-D multi-polyline geometry.

Parameters:

	GID	Geometry ID. This must be a 2-D multi-polyline geometry
	PolyNum	Polyline number. Must be greater than or equal to one, and less than or equal to the number of polylines in the geometry
	X_Array	Array of X-values. The number of X-values must be equal to the number of points in the polyline specified by PolyNum. Must not be NULL
	Y_Array	Array of Y-values. The number of Y-values must be equal to the number of points in the polyline specified by PolyNum. Must not be NULL

Fortran Syntax:

    SUBROUTINE TecUtilGeom2DMPolySetPolyline(
   &           GIDPtr,
   &           PolyNum,
   &           X_Array,
   &           Y_Array)
    POINTER         (GIDPtr, GID)
    INTEGER*4       PolyNum
    REAL*8          X_Array
    REAL*8          Y_Array

Python Syntax:

  Results = TecUtil.Geom2DMPolySetPolyline(GID, PolyNum, X_Array, Y_Array)

  Input:
                  GID                  long
                  PolyNum              int
                  X_Array              list of doubles
                  Y_Array              list of doubles
  Output:
    Results[0]    ReturnVal            NONE

Geom_ID TecUtilGeom2DPolylineCreate	(	CoordSys_e	PositionCoordSys,
		double *	PtsX_Array,
		double *	PtsY_Array,
		LgIndex_t	NumPts
	)

Create a 2-D polyline geometry.

Use the ID obtained from this function to set geometry attributes such as line style and color using the TecUtilGeomSetXxx functions. By default, the anchor position is set to (0,0). All points are drawn relative to the anchor position. The anchor position can be changed using TecUtilGeomSetXYZAnchorPos().

Parameters:

	PositionCoordSys	Coordinate system used to position the geometry. The possible values are: CoordSys_Grid or CoordSys_Frame.
	PtsX_Array	Array of X-coordinates of the polyline
	PtsY_Array	Array of Y-coordinates of the polyline
	NumPts	Number of points in the array (that is, number of points in the polyline). Must be at least two points.

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

Fortran Syntax:

    SUBROUTINE TecUtilGeom2DPolylineCreate(
   &           PositionCoordSys,
   &           PtsX_Array,
   &           PtsY_Array,
   &           NumPts,
   &           ResultPtr)
    INTEGER*4      PositionCoordSys
    REAL*8         PtsX_Array
    REAL*8         PtsY_Array
    INTEGER*4      NumPts
    POINTER        (ResultPtr, Result)

Python Syntax:

  Results = TecUtil.Geom2DPolylineCreate(PositionCoordSys, PtsX_Array, PtsY_Array, NumPts)

  Input:
                  PositionCoordSys     CoordSys_e  (defined in TecVals.py)
                  PtsX_Array           list of doubles
                  PtsY_Array           list of doubles
                  NumPts               int
  Output:
    Results[0]    ReturnVal            long

Create a 2-D polyline with four points:

   double X[4] = {.2,.5,.6,.4}; //x coords of the polyline
   double Y[4] = {.2,.5,.1,.7}; //y coords of the polyline
   Geom_ID G;
   G = TecUtilGeom2DPolylineCreate(CoordSys_Grid,X,Y,4);

void TecUtilGeom2DPolylineGetPoint	(	Geom_ID	GID,
		LgIndex_t	PointIndex,
		double *	X,
		double *	Y
	)

Get a point (X,Y) of a 2-D polyline.

Parameters:

	GID	Geometry ID. This must be a 2-D multi-polyline geometry
	PointIndex	Index of the point in the polyline. Must be greater than or equal to one, and less than or equal to the number of points in the polyline
	X	Receives the X-value of the point. Must not be NULL
	Y	Receives the Y-value of the point. Must not be NULL

Fortran Syntax:

    SUBROUTINE TecUtilGeom2DPolylineGetPoint(
   &           GIDPtr,
   &           PointIndex,
   &           X,
   &           Y)
    POINTER         (GIDPtr, GID)
    INTEGER*4       PointIndex
    REAL*8          X
    REAL*8          Y

Python Syntax:

  Results = TecUtil.Geom2DPolylineGetPoint(GID, PointIndex)

  Input:
                  GID                  long
                  PointIndex           int
  Output:
    Results[0]    X                    double
    Results[1]    Y                    double

Get the second point of a 2-D polyline geometry:

   double X,Y;
   extern Geom_ID g; // allocated somewhere else 
   TecUtilGeom2DPolylineGetPoint(g,2,&X,&Y);

void TecUtilGeom2DPolylineSetPoint	(	Geom_ID	GID,
		LgIndex_t	PointIndex,
		double	X,
		double	Y
	)

Set a point (X,Y) of a 2-D polyline.

Parameters:

	GID	Geometry ID. This must be a 2-D multi-polyline geometry
	PointIndex	Index of the point to set. Must be greater than or equal to one, and less than or equal to the number of points in the polyline
	X	The new X-value of the point
	Y	The new Y-value of the point

Fortran Syntax:

    SUBROUTINE TecUtilGeom2DPolylineSetPoint(
   &           GIDPtr,
   &           PointIndex,
   &           X,
   &           Y)
    POINTER         (GIDPtr, GID)
    INTEGER*4       PointIndex
    REAL*8          X
    REAL*8          Y

Python Syntax:

  Results = TecUtil.Geom2DPolylineSetPoint(GID, PointIndex, X, Y)

  Input:
                  GID                  long
                  PointIndex           int
                  X                    double
                  Y                    double
  Output:
    Results[0]    ReturnVal            NONE

Set the second point of a 2-D polyline geometry:

   extern Geom_ID g; // allocated somewhere else 
   
   // set to (1.1,2.5) 
   TecUtilGeom2DPolylineSetPoint(g,2,1.1,2.5);

Geom_ID TecUtilGeom3DLineSegmentCreate	(	double	X1,
		double	Y1,
		double	Z1,
		double	X2,
		double	Y2,
		double	Z2
	)

Create a 3-D line.

Use the ID obtained from this function to set geometry attributes such as line style and color using the TecUtilGeomSetXxx functions. All coordinates are in grid coordinates.

Parameters:

	X1	X-Coordinate for Starting position of the line.
	Y1	Y-Coordinate for Starting position of the line.
	Z1	Z-Coordinate for Starting position of the line.
	X2	X-Coordinate for ending position of the line.
	Y2	Y-Coordinate for ending position of the line.
	Z2	Z-Coordinate for ending position of the line.

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

Fortran Syntax:

    SUBROUTINE TecUtilGeom3DLineSegmentCreate(
   &           X1,
   &           Y1,
   &           Z1,
   &           X2,
   &           Y2,
   &           Z2,
   &           ResultPtr)
    REAL*8         X1
    REAL*8         Y1
    REAL*8         Z1
    REAL*8         X2
    REAL*8         Y2
    REAL*8         Z2
    POINTER        (ResultPtr, Result)

Python Syntax:

  Results = TecUtil.Geom3DLineSegmentCreate(X1, Y1, Z1, X2, Y2, Z2)

  Input:
                  X1                   double
                  Y1                   double
                  Z1                   double
                  X2                   double
                  Y2                   double
                  Z2                   double
  Output:
    Results[0]    ReturnVal            long

Create a 3-D line geometry from (0.1, 0.2, 0.2) to (0.5, 0.6, 0.1):

   Geom_ID G;
   G = TecUtilGeom3DLineSegmentCreate(.1,.2,.2,.5,.6,.1);

Geom_ID TecUtilGeom3DMPolyCreate	(	LgIndex_t	NumPolys,
		LgIndex_t *	NumPointsInPolylines_Array
	)

Create a 3-D multi-polyline geometry.

After creating the 3-D multi-polyline, you must assign values to the points in it with either TecUtilGeom3DMPolySetPoint() or TecUtilGeom3DMPolySetPolyline(). Use the ID obtained from this function to set geometry attributes such as line style and color using the TecUtilGeomSetXxx functions.

Parameters:

	NumPolys	Number of polylines in the 3-D multi-polyline. Must be greater than zero.
	NumPointsInPolylines_Array	Array of points in each polyline. Each polyline must have at least two points.

Returns:: The geometry ID of the 3-D multi-polyline.

Fortran Syntax:

    SUBROUTINE TecUtilGeom3DMPolyCreate(
   &           NumPolys,
   &           NumPointsInPolylines_Array,
   &           ResultPtr)
    INTEGER*4      NumPolys
    INTEGER*4      NumPointsInPolylines_Array
    POINTER        (ResultPtr, Result)

Python Syntax:

  Results = TecUtil.Geom3DMPolyCreate(NumPolys, NumPointsInPolylines_Array)

  Input:
                  NumPolys             int
                  NumPointsInPolylines_Array list of ints
  Output:
    Results[0]    ReturnVal            long

Create a 3-D multi-polyline with 2 polylines. The first polyline has three points, the second has two:

   LgIndex_t pts_per_line[2] = { 3, 2 }; // two polylines 
   double x_polyline_1[] = { 0.0, 1.0, 2.0 }; // three points 
   double y_polyline_1[] = { 0.0, 1.0, 0.0 };
   double z_polyline_1[] = { 0.0, 0.5, 0.0 };
   double x_polyline_2[] = { 1.0, 2.0 }; // two points 
   double y_polyline_2[] = { 1.0, 0.0 };
   double z_polyline_2[] = { 0.5, 0.5 };
   Geom_ID g;
   
   g = TecUtilGeom3DMPolyCreate(2, pts_per_line);
   TecUtilGeom3DMPolySetPolyline(g, 1, x_polyline_1,
                                 y_polyline_1, z_polyline_1);
   TecUtilGeom3DMPolySetPolyline(g, 2, x_polyline_2,
                                 y_polyline_2, z_polyline_2);

void TecUtilGeom3DMPolyGetPoint	(	Geom_ID	GID,
		LgIndex_t	PolyNum,
		LgIndex_t	PointIndex,
		double *	X,
		double *	Y,
		double *	Z
	)

Get the 3-D (X, Y, Z) value of point in a 3-D multi-polyline geometry.

Parameters:

	GID	Geometry ID. This must be a 3-D multi-polyline geometry
	PolyNum	Polyline number. Must be greater than or equal to one and less than or equal to the number of polylines in the geometry
	PointIndex	Index of the point in the polyline. Must be greater than or equal to one and less than or equal to the number of points in the polyline
	X	Receives the X-value of the point. Must not be NULL.
	Y	Receives the Y-value of the point. Must not be NULL
	Z	Receives the Z-value of the point. Must not be NULL

Fortran Syntax:

    SUBROUTINE TecUtilGeom3DMPolyGetPoint(
   &           GIDPtr,
   &           PolyNum,
   &           PointIndex,
   &           X,
   &           Y,
   &           Z)
    POINTER         (GIDPtr, GID)
    INTEGER*4       PolyNum
    INTEGER*4       PointIndex
    REAL*8          X
    REAL*8          Y
    REAL*8          Z

Python Syntax:

  Results = TecUtil.Geom3DMPolyGetPoint(GID, PolyNum, PointIndex)

  Input:
                  GID                  long
                  PolyNum              int
                  PointIndex           int
  Output:
    Results[0]    X                    double
    Results[1]    Y                    double
    Results[2]    Z                    double

Get the value of the tenth point in the second 3-D polyline of a multi-polyline geometry:

   double X,Y,Z;
   extern Geom_ID g; // assume this was allocated somewhere 
   TecUtilGeom3DMPolyGetPoint(g,2,10,&X,&Y,&Z);

void TecUtilGeom3DMPolySetPoint	(	Geom_ID	GID,
		LgIndex_t	PolyNum,
		LgIndex_t	PointIndex,
		double	X,
		double	Y,
		double	Z
	)

Set the 3-D (X, Y, Z) value of point in a 3-D multi-polyline geometry.

Parameters:

	GID	Geometry ID. This must be a 3-D multi-polyline geometry
	PolyNum	Polyline number. Must be greater than or equal to one and less than or equal to the number of polylines in the geometry
	PointIndex	Index of the point in the polyline. Must be greater than or equal to one and less than or equal to the number of points in the polyline
	X	New X-value of the point
	Y	New Y-value of the point
	Z	New Z-value of the point

Fortran Syntax:

    SUBROUTINE TecUtilGeom3DMPolySetPoint(
   &           GIDPtr,
   &           PolyNum,
   &           PointIndex,
   &           X,
   &           Y,
   &           Z)
    POINTER         (GIDPtr, GID)
    INTEGER*4       PolyNum
    INTEGER*4       PointIndex
    REAL*8          X
    REAL*8          Y
    REAL*8          Z

Python Syntax:

  Results = TecUtil.Geom3DMPolySetPoint(GID, PolyNum, PointIndex, X, Y, Z)

  Input:
                  GID                  long
                  PolyNum              int
                  PointIndex           int
                  X                    double
                  Y                    double
                  Z                    double
  Output:
    Results[0]    ReturnVal            NONE

Set the value of the tenth point in the second polyline of a 3-D multi-polyline geometry:

   extern Geom_ID g; // assume this was allocated somewhere 
   // set to (2.3,5.4,1.1) 
   TecUtilGeom3DMPolySetPoint(g,2,10,2.3,5.4,1.1);

void TecUtilGeom3DMPolySetPolyline	(	Geom_ID	GID,
		LgIndex_t	PolyNum,
		double *	X_Array,
		double *	Y_Array,
		double *	Z_Array
	)

Set the points for a polyline in a 3-D multi-polyline geometry.

Parameters:

	GID	Geometry ID. This must be a 3-D multi-polyline geometry
	PolyNum	Polyline number. Must be greater than or equal to one and less than or equal to the number of polylines in the geometry
	X_Array	Array of X-values. The number of X-values must be equal to the number of points in the polyline specified by PolyNum. Must not be NULL
	Y_Array	Array of Y-values. The number of Y-values must be equal to the number of points in the polyline specified by PolyNum. Must not be NULL
	Z_Array	Array of Z-values. The number of Z-values must be equal to the number of points in the polyline specified by PolyNum. Must not be NULL

Fortran Syntax:

    SUBROUTINE TecUtilGeom3DMPolySetPolyline(
   &           GIDPtr,
   &           PolyNum,
   &           X_Array,
   &           Y_Array,
   &           Z_Array)
    POINTER         (GIDPtr, GID)
    INTEGER*4       PolyNum
    REAL*8          X_Array
    REAL*8          Y_Array
    REAL*8          Z_Array

Python Syntax:

  Results = TecUtil.Geom3DMPolySetPolyline(GID, PolyNum, X_Array, Y_Array, Z_Array)

  Input:
                  GID                  long
                  PolyNum              int
                  X_Array              list of doubles
                  Y_Array              list of doubles
                  Z_Array              list of doubles
  Output:
    Results[0]    ReturnVal            NONE

Geom_ID TecUtilGeom3DPolylineCreate	(	double *	PtsX_Array,
		double *	PtsY_Array,
		double *	PtsZ_Array,
		LgIndex_t	NumPts
	)

Create a 3-D polyline geometry.

Use the ID obtained from this function to set geometry attributes such as line style and color using the TecUtilGeomSetXxx function. By default, the anchor position is set to (0,0). All points are drawn relative to the anchor position. The anchor position can be changed using TecUtilGeomSetXYZAnchorPos(). All units are in grid coordinates.

Parameters:

	PtsX_Array	Array of X-coordinates of the polyline.
	PtsY_Array	Array of Y-coordinates of the polyline.
	PtsZ_Array	Array of Z-coordinates of the polyline.
	NumPts	Number of points in the array (that is, number of points in the polyline). Must be at least two points

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

Fortran Syntax:

    SUBROUTINE TecUtilGeom3DPolylineCreate(
   &           PtsX_Array,
   &           PtsY_Array,
   &           PtsZ_Array,
   &           NumPts,
   &           ResultPtr)
    REAL*8         PtsX_Array
    REAL*8         PtsY_Array
    REAL*8         PtsZ_Array
    INTEGER*4      NumPts
    POINTER        (ResultPtr, Result)

Python Syntax:

  Results = TecUtil.Geom3DPolylineCreate(PtsX_Array, PtsY_Array, PtsZ_Array, NumPts)

  Input:
                  PtsX_Array           list of doubles
                  PtsY_Array           list of doubles
                  PtsZ_Array           list of doubles
                  NumPts               int
  Output:
    Results[0]    ReturnVal            long

Create a 3-D polyline with four points:

   double X[4] = {.2,.5,.6,.4}; //x coords of the polyline
   double Y[4] = {.2,.5,.1,.7}; //y coords of the polyline
   double Z[4] = {.1,.2,.3,.4}; //z coords of the polyline
   Geom_ID G;
   G = TecUtilGeom3DPolylineCreate(X,Y,Z,4)

void TecUtilGeom3DPolylineGetPoint	(	Geom_ID	GID,
		LgIndex_t	PointIndex,
		double *	X,
		double *	Y,
		double *	Z
	)

Get a point (X, Y, Z) of a 3-D polyline

Parameters:

	GID	Geometry ID. This must be a 3-D multi-polyline geometry
	PointIndex	Index of the point to get. Must be greater than or equal to one and less than or equal to the number of points in the polyline.
	X	Receives the X-value of the point. Must not be NULL
	Y	Receives the Y-value of the point. Must not be NULL
	Z	Receives the Z-value of the point. Must not be NULL

Fortran Syntax:

    SUBROUTINE TecUtilGeom3DPolylineGetPoint(
   &           GIDPtr,
   &           PointIndex,
   &           X,
   &           Y,
   &           Z)
    POINTER         (GIDPtr, GID)
    INTEGER*4       PointIndex
    REAL*8          X
    REAL*8          Y
    REAL*8          Z

Python Syntax:

  Results = TecUtil.Geom3DPolylineGetPoint(GID, PointIndex)

  Input:
                  GID                  long
                  PointIndex           int
  Output:
    Results[0]    X                    double
    Results[1]    Y                    double
    Results[2]    Z                    double

Get the second point of a 3-D polyline geometry:

   double X,Y,Z;
   extern Geom_ID g; // allocated somewhere else 
   TecUtilGeom3DPolylineGetPoint(g,2,&X,&Y,&Z);

void TecUtilGeom3DPolylineSetPoint	(	Geom_ID	GID,
		LgIndex_t	PointIndex,
		double	X,
		double	Y,
		double	Z
	)

Set a point (X, Y, Z) of a 3-D polyline.

Parameters:

	GID	Geometry ID. This must be a 3-D multi-polyline geometry
	PointIndex	Index of the point to set. Must be greater than or equal to one and less than or equal to the number of points in the polyline.
	X	The new X-value of the point
	Y	The new Y-value of the point
	Z	The new Z-value of the point

Fortran Syntax:

    SUBROUTINE TecUtilGeom3DPolylineSetPoint(
   &           GIDPtr,
   &           PointIndex,
   &           X,
   &           Y,
   &           Z)
    POINTER         (GIDPtr, GID)
    INTEGER*4       PointIndex
    REAL*8          X
    REAL*8          Y
    REAL*8          Z

Python Syntax:

  Results = TecUtil.Geom3DPolylineSetPoint(GID, PointIndex, X, Y, Z)

  Input:
                  GID                  long
                  PointIndex           int
                  X                    double
                  Y                    double
                  Z                    double
  Output:
    Results[0]    ReturnVal            NONE

Set the second point of a 3-D polyline geometry:

   extern Geom_ID g; // allocated somewhere else 
   TecUtilGeom3DPolylineSetPoint(g,2,1.1,2.5,1.0);
   // set to (1.1,2.5,1.0)

Geom_ID TecUtilGeomArcCreate	(	CoordSys_e	PositionCoordSys,
		double	CenterX,
		double	CenterY,
		double	Radius,
		double	StartAngle,
		double	EndAngle
	)

Create a 2-D arc.

The arc is currently implemented as a 2-D polyline geometry, thus, the type of object returned is a 2-D polyline geometry object. Use the ID obtained from this function to set geometry attributes such as line style and color using the TecUtilGeomSetXxx functions.

Parameters:

PositionCoordSys

Coordinate system used to position the geometry. Valid values are

Geometry

Functions

Function Documentation