Show / Hide Table of Contents

Class ConstructAction.CurveInput

Defines an input object for an action derived from ConstructAction. This input object extpects the user to click on a curve (IGeoObject that also implements ICurve. Pressing enter or TAB or clicking the mouse proceeds to the next input object.

Inheritance
System.Object
ConstructAction.InputObject
ConstructAction.CurveInput
Inherited Members
ConstructAction.InputObject.ReadOnly
ConstructAction.InputObject.Optional
ConstructAction.InputObject.Fixed
ConstructAction.InputObject.ResourceId
ConstructAction.InputObject.constructAction
ConstructAction.InputObject.ShowProperty
ConstructAction.InputObject.Init(ConstructAction)
ConstructAction.InputObject.Refresh()
ConstructAction.InputObject.BuildShowProperty()
ConstructAction.InputObject.AcceptInput(Boolean)
ConstructAction.InputObject.MouseLeft()
ConstructAction.InputObject.OnActionDone()
ConstructAction.InputObject.HasHotspot
ConstructAction.InputObject.HotspotPosition
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: CADability.Actions
Assembly: CADability.dll
Syntax
public class CurveInput : ConstructAction.InputObject, ConstructAction.IInputObject

Constructors

| Improve this Doc View Source

CurveInput(String)

Creates a Curveinput object.

Declaration
public CurveInput(string resourceId)
Parameters
Type Name Description
System.String resourceId

the resource id to specify a string from the StringTable. ResourceId+".Label": the Label left of the edit box. ResourceId+".ShortInfo": a short tooltip text ResourceId+"DetailedInfo": a longer tooltip text.

Fields

| Improve this Doc View Source

ModifiableOnly

true: only curves that may be modified are yielded false: any kind of curves curves are yielded

Declaration
public bool ModifiableOnly
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

PreferPath

Prefer path objects instead of single curves (when available)

Declaration
public bool PreferPath
Field Value
Type Description
System.Boolean

Properties

| Improve this Doc View Source

Decomposed

true: only decomposed curves are yielded, false: also path objects, that consist of several subcurves are yielded

Declaration
public bool Decomposed { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

FailCursor

Sets the cursor that will be displayed when no curve is hit

Declaration
public string FailCursor { set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ForwardMouseInputTo

Mouse input should be forwarded to another input object and only processed by this input, when the other input object is fixed.

Declaration
public object ForwardMouseInputTo { get; set; }
Property Value
Type Description
System.Object
| Improve this Doc View Source

HitCursor

Sets the cursor that will be displayed when a curve is hit

Declaration
public string HitCursor { set; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

AdjustHighlight()

Declaration
protected override void AdjustHighlight()
Overrides
ConstructAction.InputObject.AdjustHighlight()
| Improve this Doc View Source

GetCurves()

Gets the currently selected curves.

Declaration
public ICurve[] GetCurves()
Returns
Type Description
ICurve[]
| Improve this Doc View Source

GetSelectedCurve()

Declaration
public ICurve GetSelectedCurve()
Returns
Type Description
ICurve
| Improve this Doc View Source

SetContextMenu(String, ICommandHandler)

Declaration
public void SetContextMenu(string menuId, ICommandHandler handler)
Parameters
Type Name Description
System.String menuId
ICommandHandler handler
| Improve this Doc View Source

SetCurves(ICurve[], ICurve)

Forces the given curves to be displayed

Declaration
public void SetCurves(ICurve[] curves, ICurve selectedCurve)
Parameters
Type Name Description
ICurve[] curves

array of curves

ICurve selectedCurve

currently selected curve

| Improve this Doc View Source

SetSelectedCurve(ICurve)

Set the selected curve

Declaration
public void SetSelectedCurve(ICurve curve)
Parameters
Type Name Description
ICurve curve

this curve should be selected

| Improve this Doc View Source

SplitAtMousePosition(ICurve)

Returns two curves (Path), that represent the given curve, splitted at the vertex which is closest to the mouse position. The endpoint of the first curve is the startpoint of the second curve. If the curve is not closed and the startpoint or endpoint is closest to the mouse position, en empty array will be returned.

Declaration
public ICurve[] SplitAtMousePosition(ICurve composedCurve)
Parameters
Type Name Description
ICurve composedCurve
Returns
Type Description
ICurve[]

Events

| Improve this Doc View Source

CurveSelectionChangedEvent

Provide a method here to react on the user selecting a different curve

Declaration
public event ConstructAction.CurveInput.CurveSelectionChangedDelegate CurveSelectionChangedEvent
Event Type
Type Description
ConstructAction.CurveInput.CurveSelectionChangedDelegate
| Improve this Doc View Source

MouseOverCurvesEvent

Provide a method here to react on the user moving the cursor over curves.

Declaration
public event ConstructAction.CurveInput.MouseOverCurvesDelegate MouseOverCurvesEvent
Event Type
Type Description
ConstructAction.CurveInput.MouseOverCurvesDelegate
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX