HelixPattern Class — NXOpen Python API Reference 12.0.0 documentation

# HelixPattern Class

class `NXOpen.GeometricUtilities.``HelixPattern`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  the Helix pattern definition.

  Allows specification along both the angular and radial directions. .. versionadded:: NX9.0.0

# Properties

Property | Description
--- | ---
AnglePitch | Returns the angle pitch expression for the Helix type pattern
CountOfInstances | Returns the count of instances for the Helix type pattern
DirectionType | Returns or sets the type of helix direction method
DistancePitch | Returns the distance pitch expression for the Helix type pattern
HelixPitch | Returns the helix pitch expression for the Helix type pattern
HelixSpan | Returns the helix span expression for the Helix type pattern
NumberOfTurns | Returns the number of turns for the Helix type pattern
RotationAxis | Returns or sets the rotation axis for the pattern.
SizeOption | Returns or sets the Helix size option
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

HelixPatternDirectionTypes Enumeration | This defines helix direction method
HelixPatternSizeOptions Enumeration | defines Helix size options for Helix type pattern.

# Property Detail

## AnglePitch

`HelixPattern.``AnglePitch`

  Returns the angle pitch expression for the Helix type pattern

  `-------------------------------------`

  Getter Method

  Signature `AnglePitch`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: None.

## CountOfInstances

`HelixPattern.``CountOfInstances`

  Returns the count of instances for the Helix type pattern

  `-------------------------------------`

  Getter Method

  Signature `CountOfInstances`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: None.

## DirectionType

`HelixPattern.``DirectionType`

  Returns or sets the type of helix direction method

  `-------------------------------------`

  Getter Method

  Signature `DirectionType`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.HelixPatternDirectionTypes`

  New in version NX9.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DirectionType`

  Parameters: | directionType (`NXOpen.GeometricUtilities.HelixPatternDirectionTypes`) –

  New in version NX9.0.0.

  License requirements: None.

## DistancePitch

`HelixPattern.``DistancePitch`

  Returns the distance pitch expression for the Helix type pattern

  `-------------------------------------`

  Getter Method

  Signature `DistancePitch`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: None.

## HelixPitch

`HelixPattern.``HelixPitch`

  Returns the helix pitch expression for the Helix type pattern

  `-------------------------------------`

  Getter Method

  Signature `HelixPitch`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: None.

## HelixSpan

`HelixPattern.``HelixSpan`

  Returns the helix span expression for the Helix type pattern

  `-------------------------------------`

  Getter Method

  Signature `HelixSpan`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: None.

## NumberOfTurns

`HelixPattern.``NumberOfTurns`

  Returns the number of turns for the Helix type pattern

  `-------------------------------------`

  Getter Method

  Signature `NumberOfTurns`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX9.0.0.

  License requirements: None.

## RotationAxis

`HelixPattern.``RotationAxis`

  Returns or sets the rotation axis for the pattern.

  `-------------------------------------`

  Getter Method

  Signature `RotationAxis`

  Returns: |
  Return type: | `NXOpen.Axis`

  New in version NX9.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `RotationAxis`

  Parameters: | rotationAxis (`NXOpen.Axis`) –

  New in version NX9.0.0.

  License requirements: None.

## SizeOption

`HelixPattern.``SizeOption`

  Returns or sets the Helix size option

  `-------------------------------------`

  Getter Method

  Signature `SizeOption`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.HelixPatternSizeOptions`

  New in version NX9.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SizeOption`

  Parameters: | option (`NXOpen.GeometricUtilities.HelixPatternSizeOptions`) –

  New in version NX9.0.0.

  License requirements: None.

# Method Detail

## Validate

`HelixPattern.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.