GetLine

Public Class

Use to interactively get a line. The Rhino “Line” command uses GetLine.

Inheritance Hierarchy

System.Object
Rhino.Input.Custom.GetLine

Namespace: Rhino.Input.Custom

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class GetLine : IDisposable

The GetLine type exposes the following members.

Constructors

Name

Description

---

Public Method

GetLine

Initializes a new instance of the GetLine class

---

Properties

Name

Description

---

Public Property

AcceptZeroLengthLine

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.

---

Public Property

FeedbackColor

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.

---

Public Property

FirstPointPrompt

Prompt when getting first point

---

Public Property

FixedLength

If FixedLength > 0, the line must have the specified length

---

Public Property

GetLineMode

Mode used

---

Public Property

HaveFeedbackColor

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.

---

Public Property

MidPointPrompt

Prompt when getting midpoint

---

Public Property

SecondPointPrompt

Prompt when getting second point

---

Methods

Name

Description

---

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

---

Protected Method

Dispose(Boolean)

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.

---

Public Method

EnableAllVariations

If true, then all line variations are shown if the default line mode is used

---

Public Method

EnableFromBothSidesOption

If true, then the “BothSides” option shows up when the start point is interactively picked.

---

Public Method

EnableFromMidPointOption

If true, the “MidPoint” options shows up

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Protected Method

Finalize

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

(Overrides Object.Finalize..)

---

Public Method

Get

Perform the ‘get’ operation.

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Public Method

SetFirstPoint

Use SetFirstPoint to specify the line’s starting point and skip the start point interactive picking

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---