Ovis_3D_Line_Draw_Mode_Set()
Abstract
Sets the draw mode for a 3D line.
Syntax
Ovis_3D_Line_Draw_Mode_Set (line_dec_ptr, draw_mode)
| Argument | Type | Description |
|---|---|---|
line_dec_ptr |
OvisT_3D_Line * |
Line of interest |
draw_mode |
OvisT_3D_Line_Draw_Mode |
Draw mode to set (see Details) |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the draw mode is set; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
This function sets the draw mode for a 3D Line or 3D Segmented Line. By default, lines use the normal draw mode until changed with this function.
draw_mode must be one of the following symbolic constants:
OvisC_3D_Line_Draw_Mode_Normal—lines are drawn through terrain (and thus disappear from sight when the terrain is higher than the line)OvisC_3D_Line_Draw_Mode_Projected—lines are drawn along the surface of the terrain in areas where a normal line would go through the terrainOvisC_3D_Line_Draw_Mode_Line_Of_Sight—lines are drawn beginning at thefrompoint and ending at the first point where a normal line would go through the terrain
Example
OvisT_3D_Line * line;
OvisT_Compcode status;
/*… line created at some point */
status = Ovis_3D_Line_Draw_Mode_Set (line, OvisC_3D_Line_Draw_Mode_Projected);
Errors
- Decoration is NIL.
- Decoration is not a 3D Line or 3D Segmented Line.
Reference
- Use the function
Ovis_3D_Line_Draw_Mode_Get()to get the current draw mode for a 3D line.