Ovis_Segmented_Line_Segment_Arrows_Get()
Abstract
Returns whether the segment of a segmented line has an arrow at its start and/or its end.
Syntax
Ovis_Segmented_Line_Segment_Arrows_Get (seg_line_ptr, index, head_arrow_ptr, tail_arrow_ptr)
| Argument | Type | Description |
|---|---|---|
seg_line_ptr |
OvisT_Segmented_Line * |
Segmented line |
index |
unsigned char |
Index number of the line segment |
head_arrow_ptr |
OvisT_Boolean * |
True if there is an arrow at the start of the line segment |
tail_arrow_ptr |
OvisT_Boolean * |
True if there is an arrow at the end of the line segment |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the decoration is a valid 2D or 3D segmented line; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
Head arrows face the “from” location of the overall line and tail arrows face the “to” location of the overall line.
Example
OvisT_2D_Segmented_Line * line;
OvisT_Boolean head, tail;
/* … .line created at some point */
Ovis_Segmented_Line_Segment_Arrows_Get (line, 0, &head, &tail);
Errors
- Decoration is not a segmented Line.
- Decoration is NIL.
- 0-based segment index (
<index>) is too large for<num>segments. - Can't use 'OVISC_SEGMENTED_LINE_ALL_SEGMENTS' index value.
- Return address for 'head_arrow' value is NIL.
- Return address for 'tail_arrow' value is NIL.
Reference
- Use the function
Ovis_Segmented_Line_Segment_Arrows_Set()to specify the arrows of a segment.