Ovis_Line_Arrows_Get()
Abstract
Returns whether a solid line has arrows at its start and/or its end.
Syntax
Ovis_Line_Arrows_Get (line_dec_ptr, head_arrow_ptr, tail_arrow_ptr)
| Argument | Type | Description |
|---|---|---|
line_dec_ptr |
OvisT_Line * |
Arrow line |
head_arrow_ptr |
OvisT_Boolean * |
True if there is an arrow at the start of the line |
tail_arrow_ptr |
OvisT_Boolean * |
True if there is an arrow at the end of the line |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the decoration is a 2D or 3D solid line (not a segmented line). Otherwise, it returns OvisC_Compcode_Failure.
Header
ovis_decoration.h
Details
A “head” arrow is located next to (and faces) the “from” position of the line. A “tail” arrow is located next to (and faces) the “to” position.
Example
OvisT_2D_Line * line;
OvisT_Boolean head, tail;
/* … .line created at some point */
Ovis_Line_Arrows_Get (line, &head, &tail);
Errors
- Decoration is not a line.
- Decoration is NIL.
- Return address for 'head_arrow' value is NIL.
- Return address for 'tail_arrow' value is NIL.
Reference
- Use the function Ovis_Line_Arrows_Set() to modify the arrows of the line.