Ovis_Segmented_Line_Segment_Arrows_Get()

Abstract

Returns whether the segment of a segmented line has an arrow at its start and/or its end.

Syntax

Ovis_Segmented_Line_Segment_Arrows_Get (seg_line_ptr, index, head_arrow_ptr, tail_arrow_ptr)
Argument Type Description
seg_line_ptr OvisT_Segmented_Line * Segmented line
index unsigned char Index number of the line segment
head_arrow_ptr OvisT_Boolean * True if there is an arrow at the start of the line segment
tail_arrow_ptr OvisT_Boolean * True if there is an arrow at the end of the line segment

Return Type

OvisT_Compcode

OvisC_Compcode_Success if the decoration is a valid 2D or 3D segmented line; OvisC_Compcode_Failure otherwise.

ovis_decoration.h

Details

Head arrows face the “from” location of the overall line and tail arrows face the “to” location of the overall line.

Example

OvisT_2D_Segmented_Line						* line;
OvisT_Boolean						  head, tail;

/* … .line created at some point  */

Ovis_Segmented_Line_Segment_Arrows_Get (line, 0, &head, &tail);

Errors

  • Decoration is not a segmented Line.
  • Decoration is NIL.
  • 0-based segment index (<index>) is too large for <num> segments.
  • Can't use 'OVISC_SEGMENTED_LINE_ALL_SEGMENTS' index value.
  • Return address for 'head_arrow' value is NIL.
  • Return address for 'tail_arrow' value is NIL.

Reference

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com