Ovis_3D_Line_Draw_Mode_Get()
Abstract
Gets the current draw mode for a 3D line.
Syntax
Ovis_3D_Line_Draw_Mode_Get (line_dec_ptr, draw_mode_ptr)
| Argument | Type | Description |
|---|---|---|
line_dec_ptr |
OvisT_3D_Line * |
Line of interest |
draw_mode_ptr |
OvisT_3D_Line_Draw_Mode * |
Memory to be filled with current draw mode. |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the draw mode is obtained; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
This function returns the draw mode being used for a 3D Line or 3D Segmented Line. For a description of draw modes, see Ovis_3D_Line_Draw_Mode_Set().
Example
OvisT_3D_Line * line;
OvisT_3D_Line_Draw_Mode draw_mode;
OvisT_Compcode status;
/*… line created at some point */
status = Ovis_3D_Line_Draw_Mode_Get (line, &draw_mode);
Errors
- Decoration is NIL.
- Return address for 'draw mode' value is NIL.
- Decoration is not a 3D Line or Segmented Line.
Reference
- Use the function
Ovis_3D_Line_Draw_Mode_Set()to modify the draw mode for a 3D line.