Ovis_3D_Area_Point_Nth_Get()
Abstract
Gets a specified point from the array of points defining a 3D area.
Syntax
Ovis_3D_Area_Point_Nth_Get (area_dec_ptr, index, point)
| Argument | Type | Description |
|---|---|---|
area_dec_ptr |
OvisT_3D_Area * |
Area of interest |
index |
unsigned int |
Index of the desired point |
point_ptr |
OvisT_3D_Position * |
Memory to be filled with the desired point |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the point is obtained; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
None.
Example
OvisT_3D_Position point;
OvisT_3D_Area * area;
OvisT_Compcode status;
/* … area created at some point */
status = Ovis_3D_Area_Point_Nth_Get (area, 0, &point);
Errors
- Decoration is NIL.
- Return address for point data is NIL.
- Decoration is not a 3D area.
- index
<index>must be less than the number of points (<num_points>)
Reference
- Use the function
Ovis_3D_Area_Point_Nth_Set()to modify a single point in the array of points defining a 3D area.