pyux.highlight_line - pytha-3d-cad/pytha-lua-api GitHub Wiki
Highlights a line given by two 3D coordinates in the scene in the color of the decoration pens.
pyux.highlight_line(coordinate1, coordinate2 [,options])
| Parameter | Type | Description |
|---|---|---|
coordinate1 |
{x,y,z} |
3D start coordinate of the line |
coordinate2 |
{x,y,z} |
3D end coordinate of the line |
options |
{...} |
Optional: a table that may contain the following options: |
options.pen |
integer |
The index of the decoration pen. The values can be 1 (default), 2 or 3. |
options.arrow |
integer |
Specifies whether the line is drawn with an arrows at its ends: 0 no arrow (default), 1 arrow at end coordinate or 2 arrows at start and end coordinates. |
options.tics |
boolean |
A boolean that specifies whether the line is drawn with tic marks similar to a ruler: false (default) or true. |
options.text |
string |
A string to be displayed above the line, intended to indicate the distance between two points. May be 'nil'. |
To remove the highlight line use pyux.clear_highlights.
Version requirements
This function is available in V26 and above.
See also:
pytha, pyux, pyux.clear_highlights, pyux.highlight_coordinate, pyux.highlight_element, pyux.select_coordinate