Ovis_Segmented_Line_Segment_Length_Get()
Abstract
Returns the size (expressed in percentage) of an individual segment as it relates to the entire segmented line.
Syntax
Ovis_Segmented_Line_Segment_Length_Get (seg_line_ptr, index, percentage_ptr)
| Argument | Type | Description |
|---|---|---|
seg_line_ptr |
OvisT_Segmented_Line * |
Segmented line |
index |
unsigned char |
Index number of the line segment |
percentage_ptr |
unsigned char * |
Percentage of the offset |
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
This function returns the size (expressed in percentage) of an individual segment as it relates to the entire segmented line. The entire line is 100 percent; the subject segment represents a percentage of the segmented line.
Note: This function was formerly called Ovis_Segmented_Line_Segment_Offset_Get(). The old name is available as an alias for the new one.
Example
OvisT_2D_Segmented_Line * line;
unsigned char percent;
/* … .line created at some point with 3 segments */
Ovis_Segmented_Line_Segment_Length_Set (line, 1, &percent);
Errors
- Decoration is not a segmented Line.
- Decoration is NIL.
- Can't use 'OVISC_SEGMENTED_LINE_ALL_SEGMENTS' index value.
- Return address for percentage value is NIL.
- 0-based segment index (
<index>) is too large for<num>segments.
Reference
- Use the function
Ovis_Segmented_Line_Segment_Length_Set()to specify the percentage size of a segment.