DXFReaderNETControlAddHelix Method
|
Adds a new helix to the current drawing.
Namespace:
DXFReaderNET
Assembly:
DXFReaderNET (in DXFReaderNET.dll) Version: 20.12.2
Syntaxpublic EntityObject AddHelix(
Vector3 AxixBasePoint,
Vector3 StartPoint,
double Radius,
double Turns,
double TurnHeight = 0,
short ACIColor = 256,
string LayerName = "",
string LineTypeName = "",
bool AddToDrawing = true,
bool HandedNess = true,
Vector3 AxixVector = default,
short ConstrainType = 1
)
Public Function AddHelix (
AxixBasePoint As Vector3,
StartPoint As Vector3,
Radius As Double,
Turns As Double,
Optional TurnHeight As Double = 0,
Optional ACIColor As Short = 256,
Optional LayerName As String = "",
Optional LineTypeName As String = "",
Optional AddToDrawing As Boolean = true,
Optional HandedNess As Boolean = true,
Optional AxixVector As Vector3 = Nothing,
Optional ConstrainType As Short = 1
) As EntityObject
public:
EntityObject^ AddHelix(
Vector3 AxixBasePoint,
Vector3 StartPoint,
double Radius,
double Turns,
double TurnHeight = 0,
short ACIColor = 256,
String^ LayerName = L"",
String^ LineTypeName = L"",
bool AddToDrawing = true,
bool HandedNess = true,
Vector3 AxixVector = Vector3(),
short ConstrainType = 1
)
member AddHelix :
AxixBasePoint : Vector3 *
StartPoint : Vector3 *
Radius : float *
Turns : float *
?TurnHeight : float *
?ACIColor : int16 *
?LayerName : string *
?LineTypeName : string *
?AddToDrawing : bool *
?HandedNess : bool *
?AxixVector : Vector3 *
?ConstrainType : int16
(* Defaults:
let _TurnHeight = defaultArg TurnHeight 0
let _ACIColor = defaultArg ACIColor 256
let _LayerName = defaultArg LayerName ""
let _LineTypeName = defaultArg LineTypeName ""
let _AddToDrawing = defaultArg AddToDrawing true
let _HandedNess = defaultArg HandedNess true
let _AxixVector = defaultArg AxixVector new Vector3()
let _ConstrainType = defaultArg ConstrainType 1
*)
-> EntityObject
METHOD AddHelix(
AxixBasePoint AS Vector3,
StartPoint AS Vector3,
Radius AS REAL8,
Turns AS REAL8,
TurnHeight AS REAL8 := 0,
ACIColor AS SHORT := 256,
LayerName AS STRING := "",
LineTypeName AS STRING := "",
AddToDrawing AS LOGIC := TRUE,
HandedNess AS LOGIC := TRUE,
AxixVector AS Vector3 := new Vector3(),
ConstrainType AS SHORT := 1
) AS EntityObject
Parameters
- AxixBasePoint
- Type: DXFReaderNETVector3
The helix axis base point in world coordinates. - StartPoint
- Type: DXFReaderNETVector3
The helix start point in world coordinates. The perpendicular distance from this point to the axis is the base radius. - Radius
- Type: SystemDouble
The helix top radius in drawing's units. 0 is allowed if the base radius (from StartPoint) is greater than 0. - Turns
- Type: SystemDouble
The number of turns. Must be greater than zero. - TurnHeight (Optional)
- Type: SystemDouble
The height of one turn in drawing's units. Use 0 for a planar spiral (Default value = 0). - ACIColor (Optional)
- Type: SystemInt16
A number for 0 to 256 corresponding to the AutoCAD Color Index (0 = ByBlock; 256 = ByLayer. Default value = 256). - LayerName (Optional)
- Type: SystemString
The layer name. If omitted, or layername doesn't exist, the CurrentLayer will be used. - LineTypeName (Optional)
- Type: SystemString
The linetype name. If omitted, or linetype doesn't exist, the CurrentLineTypeName will be used. - AddToDrawing (Optional)
- Type: SystemBoolean
If false the helix is created but not added to the drawing (rubber-band preview). Default value = true. - HandedNess (Optional)
- Type: SystemBoolean
True for a right-handed (CCW) helix, false for left-handed (CW). Default value = true. - AxixVector (Optional)
- Type: DXFReaderNETVector3
The helix axis direction. If omitted or zero, the world Z axis is used. - ConstrainType (Optional)
- Type: SystemInt16
0 = constrain turn height, 1 = constrain turns, 2 = constrain height. Default value = 1.
Return Value
Type:
EntityObjectThe new added
Helix.
RemarksThe entity is added to the active layout. Base radius and top radius cannot both be 0.
Examples
Adds a helix with 3 turns, base at the origin, start at (10, 0, 0) and turn height 5.
[C#]
dxfReaderNETControl1.AddHelix(new Vector3(0, 0, 0), new Vector3(10, 0, 0), 10, 3, 5);
[Visual Basic]
DxfReaderNETControl1.AddHelix(New Vector3(0, 0, 0), New Vector3(10, 0, 0), 10, 3, 5)
See Also