RigidBodyBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# RigidBodyBuilder Class

class `NXOpen.Mechatronics.``RigidBodyBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Mechatronics.RigidBodyBuilder`.

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

  New in version NX7.5.1.

# Properties

Property | Description
--- | ---
AngularVelocityDirection | Returns or sets the angular velocity direction.
AngularVelocityMagnitude | Returns the angular velocity magnitude.
Geometry | Returns the geometries.
InertiaIxx | Returns the inertia Ixx.
InertiaIxy | Returns the inertia Ixy.
InertiaIxz | Returns the inertia Ixz.
InertiaIyy | Returns the inertia Iyy.
InertiaIyz | Returns the inertia Iyz.
InertiaIzz | Returns the inertia Izz.
LinearVelocityDirection | Returns or sets the linear velocity.
LinearVelocityMagnitude | Returns the linear velocity magnitude.
Mass | Returns the mass.
MassCenterPoint | Returns or sets the mass center point.
MassProperty | Returns or sets the auto-calculate mass property flag which is used to indicate whether all mass properties are calculated by system.
Name | Returns or sets the name.
Orientation | Returns or sets the orientation.
Tag | Returns the Tag for this object.
TagForm | Returns the tagform.

# 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.
SetGeometry | Sets the geometry
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

RigidBodyBuilderMassPropertiesOption Enumeration | the mass property option.

# Property Detail

## AngularVelocityDirection

`RigidBodyBuilder.``AngularVelocityDirection`

  Returns or sets the angular velocity direction.

  It is only used when angular velocity is not zero.

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

  Getter Method

  Signature `AngularVelocityDirection`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `AngularVelocityDirection`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## AngularVelocityMagnitude

`RigidBodyBuilder.``AngularVelocityMagnitude`

  Returns the angular velocity magnitude.

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

  Getter Method

  Signature `AngularVelocityMagnitude`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Geometry

`RigidBodyBuilder.``Geometry`

  Returns the geometries.

  This can be a `NXOpen.Assemblies.ComponentAssembly`, `NXOpen.Point` , bodies and curve.

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

  Getter Method

  Signature `Geometry`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## InertiaIxx

`RigidBodyBuilder.``InertiaIxx`

  Returns the inertia Ixx.

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

  Getter Method

  Signature `InertiaIxx`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## InertiaIxy

`RigidBodyBuilder.``InertiaIxy`

  Returns the inertia Ixy.

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

  Getter Method

  Signature `InertiaIxy`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## InertiaIxz

`RigidBodyBuilder.``InertiaIxz`

  Returns the inertia Ixz.

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

  Getter Method

  Signature `InertiaIxz`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## InertiaIyy

`RigidBodyBuilder.``InertiaIyy`

  Returns the inertia Iyy.

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

  Getter Method

  Signature `InertiaIyy`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## InertiaIyz

`RigidBodyBuilder.``InertiaIyz`

  Returns the inertia Iyz.

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

  Getter Method

  Signature `InertiaIyz`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## InertiaIzz

`RigidBodyBuilder.``InertiaIzz`

  Returns the inertia Izz.

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

  Getter Method

  Signature `InertiaIzz`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## LinearVelocityDirection

`RigidBodyBuilder.``LinearVelocityDirection`

  Returns or sets the linear velocity.

  It is only used when linear velocity is not zero.

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

  Getter Method

  Signature `LinearVelocityDirection`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `LinearVelocityDirection`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## LinearVelocityMagnitude

`RigidBodyBuilder.``LinearVelocityMagnitude`

  Returns the linear velocity magnitude.

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

  Getter Method

  Signature `LinearVelocityMagnitude`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Mass

`RigidBodyBuilder.``Mass`

  Returns the mass.

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

  Getter Method

  Signature `Mass`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## MassCenterPoint

`RigidBodyBuilder.``MassCenterPoint`

  Returns or sets the mass center point.

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

  Getter Method

  Signature `MassCenterPoint`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `MassCenterPoint`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## MassProperty

`RigidBodyBuilder.``MassProperty`

  Returns or sets the auto-calculate mass property flag which is used to indicate whether all mass properties are calculated by system.

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

  Getter Method

  Signature `MassProperty`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `MassProperty`

  Parameters: | massProperty (`NXOpen.Mechatronics.RigidBodyBuilderMassPropertiesOption`) –

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Name

`RigidBodyBuilder.``Name`

  Returns or sets the name.

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

  Getter Method

  Signature `Name`

  Returns: |
  Return type: | str

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `Name`

  Parameters: | name (str) –

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Orientation

`RigidBodyBuilder.``Orientation`

  Returns or sets the orientation.

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

  Getter Method

  Signature `Orientation`

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

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

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

  Setter Method

  Signature `Orientation`

  Parameters: | orientation (`NXOpen.CoordinateSystem`) –

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## TagForm

`RigidBodyBuilder.``TagForm`

  Returns the tagform.

  This is a `NXOpen.Mechatronics.TagFormObject` object.

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

  Getter Method

  Signature `TagForm`

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

  New in version NX10.0.0.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

# Method Detail

## SetGeometry

`RigidBodyBuilder.``SetGeometry`

  Sets the geometry

  Signature `SetGeometry(geometries)`

  Parameters: | geometries (list of `NXOpen.NXObject`) – Input geometries

  New in version NX7.5.1.

  License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

## Validate

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