Class ConstructAction.PlaneInput

Defines an input object for an action derived from ConstructAction. This input object expects the input of a plane. The value may be either entered on the keyboard or by moving the mouse. There is always a base plane which is by default the drawing plane. The mouse input is defines a plane which is parallel to the base plane and contains the mouse point (snapping is applied) Pressing enter or TAB or clicking the mouse proceeds to the next input object.

Inheritance
System.Object
ConstructAction.InputObject
ConstructAction.PlaneInput
Implements
Inherited Members
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 PlaneInput : ConstructAction.InputObject, ConstructAction.IInputObject, ICommandHandler

Constructors

| Improve this Doc View Source

PlaneInput(String)

Constructs a PlaneInput object.

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

the resource id to specify a string from the StringTable.
| Improve this Doc View Source

PlaneInput(String, Plane)

Constructs a PlaneInput object with a initial value.

Declaration
public PlaneInput(string resourceId, Plane basePlane)
Parameters
Type Name Description
System.String resourceId

the resource id to specify a string from the StringTable.
Plane basePlane

the base plane

Properties

| 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

ReadOnly

true: this input field does not accept user input, false: normal input field that requires user input

Declaration
public override bool ReadOnly { get; set; }
Property Value
Type Description
System.Boolean
Overrides

Methods

| Improve this Doc View Source

AdjustHighlight()

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

ForceValue(Plane)

Forces the input object to the specified value. The input filed is updated accordingly.

Declaration
public void ForceValue(Plane val)
Parameters
Type Name Description
Plane val

the value to set

Events

| Improve this Doc View Source

GetPlaneEvent

Provide a method here, if the length not only depends from this input, but is also modified by other means.

Declaration
public event ConstructAction.PlaneInput.GetPlaneDelegate GetPlaneEvent
Event Type
Type Description
ConstructAction.PlaneInput.GetPlaneDelegate
| Improve this Doc View Source

MouseClickEvent

Event that is fired when a mousclick happens and this input has the focus.

Declaration
public event ConstructAction.MouseClickDelegate MouseClickEvent
Event Type
Type Description
ConstructAction.MouseClickDelegate
| Improve this Doc View Source

SetPlaneEvent

Provide a method here to get the result of this input (and modify your object)

Declaration
public event ConstructAction.PlaneInput.SetPlaneDelegate SetPlaneEvent
Event Type
Type Description
ConstructAction.PlaneInput.SetPlaneDelegate

Explicit Interface Implementations

| Improve this Doc View Source

ICommandHandler.OnCommand(String)

Declaration
bool ICommandHandler.OnCommand(string MenuId)
Parameters
Type Name Description
System.String MenuId
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ICommandHandler.OnSelected(MenuWithHandler, Boolean)

Declaration
void ICommandHandler.OnSelected(MenuWithHandler selectedMenuItem, bool selected)
Parameters
Type Name Description
MenuWithHandler selectedMenuItem
System.Boolean selected
| Improve this Doc View Source

ICommandHandler.OnUpdateCommand(String, CommandState)

Declaration
bool ICommandHandler.OnUpdateCommand(string MenuId, CommandState CommandState)
Parameters
Type Name Description
System.String MenuId
CommandState CommandState
Returns
Type Description
System.Boolean

Implements