FrameOnPathBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# FrameOnPathBuilder Class

class `NXOpen.GeometricUtilities.``FrameOnPathBuilder`

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

  Frame on path builder

  New in version NX7.5.1.

# Properties

Property | Description
--- | ---
AnchorLocation | Returns or sets the anchor location
AnchorPosition | Returns the anchor position
Height | Returns the height
IsApexReversed | Returns or sets the value indicating if apex point is reversed
Length | Returns the length
Offset | Returns the offset
Tag | Returns the Tag for this object.
WScale | Returns or sets the width scale

# Methods

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

# Enumerations

FrameOnPathBuilderAnchorLocationType Enumeration | Anchor location types

# Property Detail

## AnchorLocation

`FrameOnPathBuilder.``AnchorLocation`

  Returns or sets the anchor location

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

  Getter Method

  Signature `AnchorLocation`

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

  New in version NX7.5.1.

  License requirements: None.

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

  Setter Method

  Signature `AnchorLocation`

  Parameters: | anchorLocation (`NXOpen.GeometricUtilities.FrameOnPathBuilderAnchorLocationType`) –

  New in version NX7.5.1.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## AnchorPosition

`FrameOnPathBuilder.``AnchorPosition`

  Returns the anchor position

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

  Getter Method

  Signature `AnchorPosition`

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

  New in version NX7.5.1.

  License requirements: None.

## Height

`FrameOnPathBuilder.``Height`

  Returns the height

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

  Getter Method

  Signature `Height`

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

  New in version NX7.5.1.

  License requirements: None.

## IsApexReversed

`FrameOnPathBuilder.``IsApexReversed`

  Returns or sets the value indicating if apex point is reversed

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

  Getter Method

  Signature `IsApexReversed`

  Returns: |
  Return type: | bool

  New in version NX7.5.1.

  License requirements: None.

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

  Setter Method

  Signature `IsApexReversed`

  Parameters: | isReversed (bool) –

  New in version NX7.5.1.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Length

`FrameOnPathBuilder.``Length`

  Returns the length

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

  Getter Method

  Signature `Length`

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

  New in version NX7.5.1.

  License requirements: None.

## Offset

`FrameOnPathBuilder.``Offset`

  Returns the offset

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

  Getter Method

  Signature `Offset`

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

  New in version NX7.5.1.

  License requirements: None.

## WScale

`FrameOnPathBuilder.``WScale`

  Returns or sets the width scale

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

  Getter Method

  Signature `WScale`

  Returns: |
  Return type: | float

  New in version NX7.5.1.

  License requirements: None.

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

  Setter Method

  Signature `WScale`

  Parameters: | wScale (float) –

  New in version NX7.5.1.

  License requirements: None.

# Method Detail

## Validate

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