Ovis_3D_Area_Point_Array_Get()
Abstract
Gets a copy of the array of points defining a 3D area.
Syntax
Ovis_3D_Area_Point_Array_Get (area_dec_ptr, num_points_ptr, point_array_ptr)
| Argument | Type | Description |
|---|---|---|
area_dec_ptr |
OvisT_3D_Area * |
Area of interest |
num_points_ptr |
unsigned int * |
Memory to be filled with the number of points in the array |
point_array_ptr |
OvisT_3D_Position ** |
Memory to be filled with a copy of the array of points defining the area |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the array was obtained; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
The caller should use prg_mem_free() to free the memory used by the array copy when finished with it.
Example
OvisT_3D_Area * area;
OvisT_3D_Position * pt_array[16];
unsigned int num_points;
OvisT_Compcode status;
/* … area created at some point */
status = Ovis_3D_Area_Point_Array_Get (area, &num_points, &pt_array);
Errors
- Decoration is NIL.
- Return address for number of points is NIL.
- Return address for point array is NIL.
- Decoration is not a 3D area.
Reference
- Use the function
Ovis_3D_Area_Point_Array_Set()to define an area's points.