Ovis_3D_Area_Point_Array_Set()
Abstract
Specifies an array of points defining a 3D area.
Syntax
Ovis_3D_Area_Point_Array_Set (area_dec_ptr, num_points, point_array)
| Argument | Type | Description |
|---|---|---|
area_dec_ptr |
OvisT_3D_Area * |
Area of interest |
num_points |
unsigned int |
Number of points defining the area |
point_array |
OvisT_3D_Position * |
Array of points defining the area |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the array was set; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
point_array can contain no more than 16 points defining the perimeter of a convex polygon. The points must be in either the geodetic or geocentric coordinate system and must be defined in point_array sequentially as they occur around the perimeter of the area
Example
unsigned int num_points = 7;
OvisT_3D_Position * pt_array[num_points];
OvisT_3D_Area * area;
OvisT_Compcode status;
/* … area created at some point */
status = Ovis_3D_Area_Point_Array_Set (area, num_points, pt_array);
Errors
- Decoration is NIL.
- Area must have some points defined.
- Area can only have up to 16 points defined.
- Area's point #
<index>must be a geocentric or geodetic position. - Decoration is not a 3D area.
Reference
- Use the function
Ovis_3D_Area_Point_Array_Get()to obtain the points that define an area.