Ovis_Decoration_3D_Segmented_Line_Create()
Abstract
Creates a 3D segmented line.
Syntax
Ovis_Decoration_3D_Segmented_Line_Create (from, to, num_segments, color, thickness, layer_ptr, destroy_proc, user_state_ptr)
| Argument | Type | Description |
|---|---|---|
from |
OvisT_3D_Position |
Start of the segmented line |
to |
OvisT_3D_Position |
End of the segmented line |
num_segments |
unsigned char |
Number of segments (at least 1) |
color |
PrgT_Color |
Color |
thickness |
unsigned char |
Thickness of the segmented line |
layer_ptr |
OvisT_Layer * |
Ovis layer |
destroy_proc |
OvisT_Decoration_State_Destroy_Proc |
Destroys the data associated with the object and deallocates its memory |
user_state_ptr |
void * |
Optional user-provided state of the decoration |
Return Type
OvisT_3D_Segmented_Line*
The 3D segmented line
Header
ovis_decoration.h
Details
This function creates an Ovis 3D segmented line. It specifies the attributes of the segmented line.
Example
OvisT_3D_Position from, to;
OvisT_3D_Segmented_Line * line;
PrgT_Color color = prg_color_from_string ("green");
Ovis_3D_Position_Geodetic_Set (&from, 0, 0, 100);
Ovis_3D_Position_Geodetic_Set (&to, 0, 0, 200);
line = Ovis_Decoration_3D_Segmented_Line_Create (from, to, 3, color, 1, OPC_NIL,
OPC_NIL, OPC_NIL);
Errors
- Number of segments must be greater than 0.
Reference
- Use the function
Ovis_3D_Line_Endpoints_Set()to modify the endpoints of the line. - Use the function
Ovis_Decoration_Flashing_Set()to modify the flashing status of the entire line. - Use the function
Ovis_Segmented_Line_Segment_Length_Set()to specify the size of the segment as a percentage of the line’s total size. - Use the function
Ovis_Segmented_Line_Segment_Color_Set()to modify the color of a segment of the line. - Use the function
Ovis_Segmented_Line_Segment_Transparency_Set()to modify the transparency of a segment of the line. - Use the function
Ovis_Segmented_Line_Segment_Pattern_Set()to modify the pattern used in a segment of the line. - Use the function
Ovis_Segmented_Line_Segment_Thickness_Set()to modify the thickness of a segment of the line. - Use the function
Ovis_Segmented_Line_Segment_Arrows_Set()to enable/disable arrows at the ends of a segment of the line.