Go to www.awrcorp.com
Back to search page Click to download printable version of this guide.

3.5.1.19. Wire Helix

Description

A wire representing a curve for which the tangent makes a constant angle with a fixed line. This implementation is for a constant radius and pitch. Typically used for coils and springs.

Parameters

Label – A unique name that identifies the solid. (ISolid/Label)

Coordinate System – The coordinate system in which the solid is defined. Defaults to working coordinate system at time of creation. (ISolid/CoordinateSystem)

Visible - Indicates if the solid is shown in the view. (ISolid/Visible)

Mesh Control Only - Indicates if the solid is used as a tool to control meshing. If True, the portion of the solid that does not overlap the other normal solid is thrown away prior to simulation. Additionally, the material of such a solid is irrelevant so the material parameter is hidden. (ISolid/MeshControlOnly)

Start - [LENGTH] – Start point of the helix defined in the solid’s coordinate system. (IHelix/Start)

Axial Direction - Direction of the axis of the helix defined in the solid’s coordinate system. This is a unitless vector and its magnitude is irrelevant. (IHelix/AxialDirection)

Start Point to Axis Direction - Vector from start point to axis defined in the solid’s coordinate system. This is a unitless vector and its magnitude is irrelevant. (IHelix/StartPointToAxialDirection)

Radius - [LENGTH] - Radius of the helix. (IHelix/Radius)

Pitch - [LENGTH] - The height of one complete turn. (IHelix/Pitch)

Number of Turns – Number of turns in. Note this supports partial turns. (IHelix/NumberOfTurns)

Handedness - Controls the direction of the screwing motion. (IHelix/Handedness)

Example(s)

User Interface Button

Command Details

Mouse click order is:
1. Start
2. Start Point to Axis Direction/Radius
3. Pitch
See command hint for detailed instructions.

Requirements

Magnitude of axial direction and start point to axis must be non-zero. Radius, pitch and number of turns must be non-zero.

Other Notes

None.

Example Creation Script

Solid_2 = Geometry_1.WireHelix("Helix_3", "World", "Air", "-0.013, -0.011, 0", "0, 0, 1", "0.707106781186548, 0.707106781186547, 0", "0.00282842712474619", "0.0055", "2", "Right")

Scripting Interfaces

“ISolid”
“IWireHelix”
“IWire”
“ISolidCreationOperation”
“ISolidOperation”

Please send email to awr.support@ni.com if you would like to provide feedback on this article. Please make sure to include the article link in the email.

Legal and Trademark Notice