ZPipe
Deprecated. Do not use in new code.
(Engine-Level Function)
Description: | Draws a layered three-dimensional pipe in a window. |
Returns: | Nothing |
Usage: | Steady State only. |
Function Groups: | Graphics |
Related to: | GUIPipe | Pipe |
Format: | ZPipe(XArrayElem, YArrayElem, N, LowIndex, HighIndex, PixelWidth) |
Parameters: |
XArrayElem |
Required. Any numeric expression that specifies the starting array element. The array contains the X coordinates of the path along which to draw the pipe. If processing a multidimensional array, the usual rules apply to decide which dimension should be examined. |
YArrayElem |
Required. Any numeric expression that specifies the starting array element. The array contains the Y coordinates of the path along which to draw the pipe. If processing a multidimensional array, the usual rules apply to decide which dimension should be examined. |
N |
Required. Any numeric expression giving the number of array elements to use to define the path of the pipe. |
LowIndex |
Required. Any numeric expression specifying the low index into the current color palette. It is used in conjunction with the next parameter to adjust the brightness and contrast of the shading. |
HighIndex |
Required. Any numeric expression specifying the high index into the current color palette. It is used in conjunction with the previous parameter to adjust the brightness and contrast of the shading. |
PixelWidth |
Required. Any numeric expression specifying the width of the shaded pipe in pixels and is subject to applicable scaling factors. |
Comments: | Although this is a layered graphic, it cannot be edited using the Idea Studio. It is for use within text mode editing only. The pipe will be drawn with a miter effect, such that pipe segments meet at 45-degree angles. |
Example:
ZPipe(x[0], y[0] { First endpoint for pipe }, 8 { Number of vertices }, 176, 239 { Very dark gray to very light gray }, 24 { Width of pipe in pixels });