VirtualAxisBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# VirtualAxisBuilder Class

class `NXOpen.Mechatronics.``VirtualAxisBuilder`

  Bases: `NXOpen.Mechatronics.PhysicsJointBuilder`

  Represents a `NXOpen.Mechatronics.VirtualAxis` builder

  To create a new instance of this class, use `NXOpen.Mechatronics.VirtualAxisCollection.CreateVirtualAxisBuilder()`

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
AnchorPoint | Returns or sets the anchor point
Attachment | Returns the attachment of joint.
AxisType | Returns or sets the axis type
Base | Returns the base of joint.
BaseAnchorPoint | Returns or sets the anchor point of base.
BaseAxisVector | Returns or sets the axis vector of base.
Direction | Returns or sets the direction
Name | Returns or sets the name.
Positioning | Returns or sets a boolean value that indicates whether to create an assembly joint.
StartPosition | Returns the initial position of virtual axis
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
SetAttachment | Sets the attachment.
SetBase | Sets the base.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

VirtualAxisBuilderVirtualAxisType Enumeration | the Axis Type option.

# Property Detail

## AnchorPoint

`VirtualAxisBuilder.``AnchorPoint`

  Returns or sets the anchor point

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

  Getter Method

  Signature `AnchorPoint`

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

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `AnchorPoint`

  Parameters: | point (`NXOpen.Point`) –

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## AxisType

`VirtualAxisBuilder.``AxisType`

  Returns or sets the axis type

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

  Getter Method

  Signature `AxisType`

  Returns: |
  Return type: | `NXOpen.Mechatronics.VirtualAxisBuilderVirtualAxisType`

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `AxisType`

  Parameters: | axisType (`NXOpen.Mechatronics.VirtualAxisBuilderVirtualAxisType`) –

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Direction

`VirtualAxisBuilder.``Direction`

  Returns or sets the direction

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

  Getter Method

  Signature `Direction`

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

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `Direction`

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

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## StartPosition

`VirtualAxisBuilder.``StartPosition`

  Returns the initial position of virtual axis

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

  Getter Method

  Signature `StartPosition`

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

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## Validate

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