Ovis_Segmented_Line_Segment_Arrows_Set()
Abstract
Specifies whether a segment of a segmented line has arrows at its start and/or its end.
Syntax
Ovis_Segmented_Line_Segment_Arrows_Set (seg_line_ptr, index, head_arrow, tail_arrow)
| Argument | Type | Description |
|---|---|---|
seg_line_ptr |
OvisT_Segmented_Line * |
Specifies the segmented line |
index |
unsigned char |
Specifies the index number of the line segment |
head_arrow |
OvisT_Boolean |
Specifies an arrow at the start of the line segment |
tail_arrow |
OvisT_Boolean |
Specifies 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.
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.
If index is OVISC_SEGMENTED_LINE_ALL_SEGMENTS, all segments of the line are set to the specified arrows.
Example
OvisT_2D_Segmented_Line * line;
/* … .line created at some point */
Ovis_Segmented_Line_Segment_Arrows_Set (line, 0, OvisC_True, OvisC_False);
Errors
- Decoration is not a segmented Line.
- Decoration is NIL.
- 0-based segment index (
<index>) is too large for<num>segments.
Reference
- Use the function
Ovis_Segmented_Line_Segment_Arrows_Get()to obtain the arrow settings of a segment.