Ovis_2D_Line_Endpoints_Get()
Abstract
Returns the endpoints of the 2D line.
Syntax
Ovis_2D_Line_Endpoints_Get (line_dec_ptr, from_ptr, to_ptr)
| Argument | Type | Description |
|---|---|---|
line_dec_ptr |
OvisT_2D_Line * |
Line |
from_ptr |
OvisT_2D_Position * |
Start of the line |
to_ptr |
OvisT_2D_Position * |
End of the line |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the provided object is a valid 2D line. Otherwise, it returns OvisC_Compcode_Failure.
Header
ovis_decoration.h
Details
This function returns the coordinates of the start and end of the 2D line. The line can be a solid line or a segmented line.
Example
OvisT_2D_Position from, to;
OvisT_2D_Line * line;
/*… line created at some point */
Ovis_2D_Line_Endpoints_Get (line, &from, &to);
Errors
- Return address for 'from' position value is NIL.
- Return address for 'to' position value is NIL.
- Decoration is NIL.
- Decoration is not a 2D Line.
Reference
- Use the function
Ovis_2D_Line_Endpoints_Set()to modify the endpoints of the line.