RectangularPattern Class — NXOpen Python API Reference 12.0.0 documentation

# RectangularPattern Class

class `NXOpen.GeometricUtilities.``RectangularPattern`

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

  the rectangular pattern definition.

  Allows specification along two linear axes, which may or may not be orthogonal. .. versionadded:: NX7.5.0

# Properties

Property | Description
--- | ---
CreateLastStaggered | Returns or sets the option to generate the last item in a staggered row.
HorizontalRef | Returns the horizontal reference
SimplifiedLayoutType | Returns or sets the simplified layout type to be used by the pattern
StaggerType | Returns or sets the type of stagger to be used by the pattern
Tag | Returns the Tag for this object.
UseYDirectionToggle | Returns or sets the UseYDirection toggle attribute.
XDirection | Returns or sets the x axis
XFlip | Returns or sets the XSelection flip attribute.
XSelection | Returns the direction object.
XSpacing | Returns the instance spacing along the x axis
XSymmetryToggle | Returns or sets the XSymmetry toggle attribute.
YDirection | Returns or sets the y axis, which can be any vector not parallel to the x axis
YFlip | Returns or sets the YSelection flip attribute.
YSelection | Returns the direction object.
YSpacing | Returns the instance spacing along the y axis
YSymmetryToggle | Returns or sets the YSymmetry toggle attribute.

# Methods

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

# Enumerations

RectangularPatternSimplifiedLayoutTypes Enumeration | defines simplified layout type for linear pattern.
RectangularPatternStaggerOptions Enumeration | defines any stagger to be defined on the pattern.

# Property Detail

## CreateLastStaggered

`RectangularPattern.``CreateLastStaggered`

  Returns or sets the option to generate the last item in a staggered row.

  If ‘true’ the pattern will be narrower on rows that have been staggered.

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

  Getter Method

  Signature `CreateLastStaggered`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `CreateLastStaggered`

  Parameters: | create (bool) –

  New in version NX7.5.0.

  License requirements: None.

## HorizontalRef

`RectangularPattern.``HorizontalRef`

  Returns the horizontal reference

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

  Getter Method

  Signature `HorizontalRef`

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

  New in version NX8.0.0.

  License requirements: None.

## SimplifiedLayoutType

`RectangularPattern.``SimplifiedLayoutType`

  Returns or sets the simplified layout type to be used by the pattern

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

  Getter Method

  Signature `SimplifiedLayoutType`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SimplifiedLayoutType`

  Parameters: | type (`NXOpen.GeometricUtilities.RectangularPatternSimplifiedLayoutTypes`) –

  New in version NX8.0.0.

  License requirements: None.

## StaggerType

`RectangularPattern.``StaggerType`

  Returns or sets the type of stagger to be used by the pattern

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

  Getter Method

  Signature `StaggerType`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `StaggerType`

  Parameters: | spaceType (`NXOpen.GeometricUtilities.RectangularPatternStaggerOptions`) –

  New in version NX7.5.0.

  License requirements: None.

## UseYDirectionToggle

`RectangularPattern.``UseYDirectionToggle`

  Returns or sets the UseYDirection toggle attribute.

  This function gets the UseYDirection toggle value

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

  Getter Method

  Signature `UseYDirectionToggle`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `UseYDirectionToggle`

  Parameters: | toggle (bool) –

  New in version NX7.5.0.

  License requirements: None.

## XDirection

`RectangularPattern.``XDirection`

  Returns or sets the x axis

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

  Getter Method

  Signature `XDirection`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `XDirection`

  Parameters: | xDirection (`NXOpen.Direction`) –

  New in version NX7.5.0.

  License requirements: None.

## XFlip

`RectangularPattern.``XFlip`

  Returns or sets the XSelection flip attribute.

  This function flips X selection object of the 2D pattern

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

  Getter Method

  Signature `XFlip`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `XFlip`

  Parameters: | flip (bool) –

  New in version NX7.5.0.

  License requirements: None.

## XSelection

`RectangularPattern.``XSelection`

  Returns the direction object.

  This function gets X direction object of the 2D pattern. This call will result in an Exception if not called in 2D mode.

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

  Getter Method

  Signature `XSelection`

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

  New in version NX7.5.0.

  License requirements: None.

## XSpacing

`RectangularPattern.``XSpacing`

  Returns the instance spacing along the x axis

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

  Getter Method

  Signature `XSpacing`

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

  New in version NX7.5.0.

  License requirements: None.

## XSymmetryToggle

`RectangularPattern.``XSymmetryToggle`

  Returns or sets the XSymmetry toggle attribute.

  This function gets the x Symmetry toggle value

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

  Getter Method

  Signature `XSymmetryToggle`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `XSymmetryToggle`

  Parameters: | toggle (bool) –

  New in version NX7.5.0.

  License requirements: None.

## YDirection

`RectangularPattern.``YDirection`

  Returns or sets the y axis, which can be any vector not parallel to the x axis

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

  Getter Method

  Signature `YDirection`

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

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `YDirection`

  Parameters: | yDirection (`NXOpen.Direction`) –

  New in version NX7.5.0.

  License requirements: None.

## YFlip

`RectangularPattern.``YFlip`

  Returns or sets the YSelection flip attribute.

  This function flips Y selection object of the 2D pattern

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

  Getter Method

  Signature `YFlip`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `YFlip`

  Parameters: | flip (bool) –

  New in version NX7.5.0.

  License requirements: None.

## YSelection

`RectangularPattern.``YSelection`

  Returns the direction object.

  This function gets Y direction object of the 2D pattern. This call will result in an Exception if not called in 2D mode.

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

  Getter Method

  Signature `YSelection`

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

  New in version NX7.5.0.

  License requirements: None.

## YSpacing

`RectangularPattern.``YSpacing`

  Returns the instance spacing along the y axis

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

  Getter Method

  Signature `YSpacing`

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

  New in version NX7.5.0.

  License requirements: None.

## YSymmetryToggle

`RectangularPattern.``YSymmetryToggle`

  Returns or sets the YSymmetry toggle attribute.

  This function gets the y Symmetry toggle value

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

  Getter Method

  Signature `YSymmetryToggle`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

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

  Setter Method

  Signature `YSymmetryToggle`

  Parameters: | toggle (bool) –

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## Validate

`RectangularPattern.``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.