Ovis_2D_Line_Endpoints_Set()
Abstract
Specifies the endpoints of the 2D line.
Syntax
Ovis_2D_Line_Endpoints_Set (line_dec_ptr, from, to)
| Argument | Type | Description |
|---|---|---|
line_dec_ptr |
OvisT_2D_Line * |
Line |
from |
OvisT_2D_Position |
Specifies the start of the line |
to |
OvisT_2D_Position |
Specifies the 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 specifies 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 */
from.x = to.x = 0;
from.y = 50;
to.y = -50;
Ovis_2D_Line_Endpoints_Set (line, from, to);
Errors
- Decoration is not a 2D line.
- Decoration is NIL.
- Invalid 'from' 2D position <x,y>. 2D position values must be between –128 and 127.
- Invalid 'to' 2D position <x,y>. 2D position values must be between –128 and 127.
Reference
- Use the function
Ovis_2D_Line_Endpoints_Get()to obtain the endpoints of the line.