GetTwoWayLayout (2)

GetTwoWayLayout

Function used to perform segment layouts (in 2 directions) at a specified span, horizontal run, as well as spacing.

Syntax:

Procedure: GetTwoWayLayout(aItem: string; sSpanHint, sRunHint: string; bIncludeFirst, bIncludeLast: boolean; nSpacing: double; aAreaSection: string): boolean;

Arguments: 
AItem: String
Specifies the area section to assign the layout segments to.

sSpanHint: String
Hint message displayed on mouse cursor indicating to pick the "span" direction.

sRunHint: String
Hint message displayed on mouse cursor indicating to pick the "run" direction.

bIncludeFirst: Boolean
Specifies whether to include a segment at the "start" run point. Even if it does not fall within the spacing range.

bIncludeLast: Boolean
Specifies whether to include a segment at the "last" run point. Even if it does not fall within the spacing range.

nSpacing: Double
Specifies the "run" spacing used when laying out segment objects.

AArea: String (optional parameter)
Specifies a defined "Area Segment" to trim/extend laid segments to. Supply either the path or GUID to the area section. Or, empty double-quotes for no trim/extending required.

API Call:

var
  bIncludeFirst : boolean;
  bIncludeLast  : boolean;
  nSpacing      : double;
  aItem         : string;
  aAreaSection  : string;
begin
  aItem := NewItem('\Job\Takeoff', 'Segment', 'Name');

  // place or ignore segment at run "start" point...
  bIncludeFirst := FALSE; // (T/F)...

  // place or ignore segment at run "end" point...
  bIncludeLast := FALSE; // (T/F)...

  // spacing (inches) used when creating segments...
  nSpacing := 24; // 12, 16, 24...

  // (optional) either create or select a area section to trim or extend to...
  aAreaSection := SelectedItem();

  // Function that lays the sticks (2 ways)...
  GetTwoWayLayout(aItem,
                  'Pick the Span Line...'
                  'Pick the Run Line...'
                  bIncludeFirst, bIncludeLast,
                  nSpacing,
                  aAreaSection);
end;