Ovis_3D_Area_Point_Nth_Set()
Abstract
Sets a specified point in the array of points defining a 3D area.
Syntax
Ovis_3D_Area_Point_Nth_Set (area_dec_ptr, index, point)
| Argument | Type | Description |
|---|---|---|
area_dec_ptr |
OvisT_3D_Area * |
Area of interest |
index |
unsigned int |
Index of the point to set |
point |
OvisT_3D_Position |
New value for specified point, in geocentric or geodetic coordinates |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the point is set; 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 */
Ovis_3D_Position_Geodetic_Set (&point, 38.98176, -77.09558, 123);
status = Ovis_3D_Area_Point_Nth_Set (area, 0, point);
Errors
- Decoration is NIL.
- Point must be a geocentric or geodetic position.
- 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_Get()to get a single point from the array of points defining a 3D area.