GetLine

public class GetLine : IDisposable
Use to interactively get a line. The Rhino "Line" command uses GetLine.

Constructors

GetLine

#Since v5.1
public GetLine()

Finalizer

~GetLine

#
~GetLine()
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

Properties

AcceptZeroLengthLine

#Since v5.1
public bool AcceptZeroLengthLine { get; set; }
Controls whether or not a zero length line is acceptable. The default is to require the user to keep picking the end point until we get a point different than the start point.

FeedbackColor

#Since v5.1
public Color FeedbackColor { get; set; }
If set, the feedback color is used to draw the dynamic line when the second point is begin picked. If not set, the active layer color is used.

FirstPointPrompt

#Since v5.1
public string FirstPointPrompt { get; set; }
Prompt when getting first point

FixedLength

#Since v5.1
public double FixedLength { get; set; }
If FixedLength > 0, the line must have the specified length

GetLineMode

#Since v5.1
public GetLineMode GetLineMode { get; set; }
Mode used

HaveFeedbackColor

#Since v5.1
public bool HaveFeedbackColor { get; }
If true, the feedback color is used to draw the dynamic line when the second point is begin picked. If false, the active layer color is used.

MidPointPrompt

#Since v5.1
public string MidPointPrompt { get; set; }
Prompt when getting midpoint

SecondPointPrompt

#Since v5.1
public string SecondPointPrompt { get; set; }
Prompt when getting second point

Methods

Dispose

#Since v5.1
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.

Dispose

#
protected virtual void Dispose(bool disposing)
For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

Parameters:
disposing (bool)true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.

EnableAllVariations

#Since v5.1
public void EnableAllVariations(bool on)
If true, then all line variations are shown if the default line mode is used
Parameters:
on (bool)

EnableFromBothSidesOption

#Since v5.1
public void EnableFromBothSidesOption(bool on)
If true, then the "BothSides" option shows up when the start point is interactively picked.
Parameters:
on (bool)

EnableFromMidPointOption

#Since v5.1
public void EnableFromMidPointOption(bool on)
If true, the "MidPoint" options shows up
Parameters:
on (bool)

Get

#Since v5.1
public Result Get(out Line line)
Perform the 'get' operation.
Parameters:
line (out Line)

SetFirstPoint

#Since v5.1
public void SetFirstPoint(Point3d point)
Use SetFirstPoint to specify the line's starting point and skip the start point interactive picking
Parameters:
point (Point3d)