PathDraw

(Engine-Level Function)

Description:	Used within a Idea Studio handler to inform the engine that a path is being drawn, and to set the appearance of that path. Used for both lines and pipes. The resulting object will be a GUIPolygon.
Returns:	Numeric
Usage:	Steady State only.
Function Groups:	Graphics
Related to:
Format:	PathDraw(Pen, Brush);
Parameters:

Pen

Required. Defines the color, style and width of the path. May be any of the following: Value Notes Pen object If the pen color is transparent, invisible, or has a zero width, then a 1-pixel black line will be shown only while the path is being drawn to show the position. Palette index Defines only the color of the line. A 1-pixel, solid line will be drawn. System color Defines only the color of the line. A 1-pixel, solid line will be drawn. -1 (transparent line) The line will not be shown, except that a 1-pixel solid black line will be used while the path is being drawn. aRGB string Defines only the color of the line. A 1-pixel, solid line will be drawn.

Brush

Required. Defines the fill color of a closed figure or the color of a pipe. May be any of the following: Value Notes Brush object Defines a foreground, background and pattern for the fill. Palette index Defines only the color of the fill. System color Defines only the color of the fill. -1 (transparent line) The fill will not be shown. aRGB string Defines only the color of the fill.

Comments:

Do not confuse PathDraw with the function DrawPath(). This function will work only inside the context of a window with the Drop Target bit (22) set. The path may have multiple vertices. If the function stops during drawing, no portion will be drawn. When drawing a pipe, set the style for the Pen() to 100.

Examples:

Render a path as a narrow black line:

PathDraw(Pen(("<FFFFFFFF>", 1, 1), Brush(("<FF000000>", 0, 1));

Render a path as a pipe:

PathDraw(Pen("<FF80FF80>", 100, 29), Brush(-1, 0, 1));