MeshSurfaceBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# MeshSurfaceBuilder Class

class `NXOpen.Features.``MeshSurfaceBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Mesh Surface Builder class.

  To create a new instance of this class, use `NXOpen.Features.FeatureCollection.CreateMeshSurfaceBuilder()`

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
FaceConstraintDirection | Returns or sets
FeatureType | Returns or sets
NormalToEndSections | Returns or sets the normal to end sections for Through Curves surface.
ParametersData | Returns or sets
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
RebuildData | Returns or sets
SimpleConstruction | Returns or sets
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
BuildProfileFromSections | Creates mesh surface profile string.
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetAngleAlignmentPoints | Get angle alignment points
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetDistanceAlignmentVector | Get distance alignment vector
GetFaceConstraintCollectors | Get faces constraints collectors for through curves and curves mesh types surfaces.
GetFaceConstraintTypes | Get end constraints types.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
GetProfile | Get mesh profile string with provided index.
GetProfilePointAlignment | Get profile string point alignment info.
GetToleranceString | Get tolerances strings.
GetTolerances | Get tolerances.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
InsertProfileString | Insert a string (string_index, with order) into a profile (profile_index).
NewParametersData | Create a mesh parameters transient object data.
NewProfile | Construct a new mesh profile string transient object.
NewRebuildData | Allocate memory for Mesh type surface rebuild data.
RemovePointsAlignment | Remove points alignment information.
RemoveProfileString | Remove a string (string_index) from a profile (profile_index)
RemoveSpineAlignment | Remove spine alignment.
ReorderProfileStringCurves | Reorder profile string curves.
RestorePointsAlignment | Restore the last removed points alignment information if there is one.
SetAngleAlignmentPoints | Set angle alignment points.
SetDistanceAlignmentVector | Set distance alignment vector
SetFaceConstraintCollectors | Set faces constraints collectors for through curves and curves mesh types surfaces.
SetFaceConstraintTypes | Set end constraints types.
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
SetProfilePointAlignment | Set profile string alignment info.
SetToleranceString | Set tolerances strings for mesh type surface.
SetTolerances | Set tolerances for mesh type surfaces.
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.
ValidateFeatureParameters | Validate the new parameters for mesh surface editing.

# Enumerations

MeshSurfaceBuilderConstraintDirection Enumeration | End face constraints direction.
MeshSurfaceBuilderConstraintType Enumeration | End face constraints types.

# Property Detail

## FaceConstraintDirection

`MeshSurfaceBuilder.``FaceConstraintDirection`

  Returns or sets

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

  Getter Method

  Signature `FaceConstraintDirection`

  Returns: |
  Return type: | `NXOpen.Features.MeshSurfaceBuilderConstraintDirection`

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

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

  Setter Method

  Signature `FaceConstraintDirection`

  Parameters: | constraintDirection (`NXOpen.Features.MeshSurfaceBuilderConstraintDirection`) –

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## FeatureType

`MeshSurfaceBuilder.``FeatureType`

  Returns or sets

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

  Getter Method

  Signature `FeatureType`

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

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

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

  Setter Method

  Signature `FeatureType`

  Parameters: | featureType (`NXOpen.MeshParameterDataFeatureType`) –

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## NormalToEndSections

`MeshSurfaceBuilder.``NormalToEndSections`

  Returns or sets the normal to end sections for Through Curves surface.

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

  Getter Method

  Signature `NormalToEndSections`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

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

  Setter Method

  Signature `NormalToEndSections`

  Parameters: | normalToEndSections (bool) –

  New in version NX5.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## ParametersData

`MeshSurfaceBuilder.``ParametersData`

  Returns or sets

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

  Getter Method

  Signature `ParametersData`

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

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

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

  Setter Method

  Signature `ParametersData`

  Parameters: | parameters (`NXOpen.MeshParameterData`) –

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## RebuildData

`MeshSurfaceBuilder.``RebuildData`

  Returns or sets

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

  Getter Method

  Signature `RebuildData`

  Returns: | Requested rebuild data.
  Return type: | `NXOpen.SurfaceRebuildData`

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

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

  Setter Method

  Signature `RebuildData`

  Parameters: | rbData (`NXOpen.SurfaceRebuildData`) – Rebuild data

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## SimpleConstruction

`MeshSurfaceBuilder.``SimpleConstruction`

  Returns or sets

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

  Getter Method

  Signature `SimpleConstruction`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

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

  Setter Method

  Signature `SimpleConstruction`

  Parameters: | simple (bool) –

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

# Method Detail

## BuildProfileFromSections

`MeshSurfaceBuilder.``BuildProfileFromSections`

  Creates mesh surface profile string.

  Signature `BuildProfileFromSections(conehead, profileStringType, skinType, stringPointType, sections, editInsertProfile, profile)`

  Parameters:

  - conehead (bool) – Display conehead?
  - profileStringType (`NXOpen.MeshProfileStringType`) – Mesh profile string type
  - skinType (`NXOpen.MeshParameterDataFeatureType`) – Mesh surface type
  - stringPointType (`NXOpen.MeshProfileStringSelectedPoint`) – Profile string point type
  - sections (list of `NXOpen.Section`) – Sections
  - editInsertProfile (bool) – Flag to indicate if this is temporary profile to inserting new string purpose only.
  - profile (`NXOpen.MeshProfileString`) – Mesh profile string

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## GetAngleAlignmentPoints

`MeshSurfaceBuilder.``GetAngleAlignmentPoints`

  Get angle alignment points

  Signature `GetAngleAlignmentPoints()`

  Returns: | a tuple
  Return type: | A tuple consisting of (point1, point2). point1 is a `NXOpen.Point3d`. Point 1 point2 is a `NXOpen.Point3d`. Point 2

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## GetDistanceAlignmentVector

`MeshSurfaceBuilder.``GetDistanceAlignmentVector`

  Get distance alignment vector

  Signature `GetDistanceAlignmentVector()`

  Returns: | Vector
  Return type: | `NXOpen.Vector3d`

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## GetFaceConstraintCollectors

`MeshSurfaceBuilder.``GetFaceConstraintCollectors`

  Get faces constraints collectors for through curves and curves mesh types surfaces.

  Signature `GetFaceConstraintCollectors(nSides, numCollectors, numConsTypes)`

  Parameters:

  - nSides (int) –
  - numCollectors (int) –
  - numConsTypes (int) –

  Returns: | a tuple
  Return type: | A tuple consisting of (facesCons, collectors, consTypes). facesCons is a list of int. Number of faces on each side collectors is a list of `NXOpen.ScCollector`. Constraints collectors. consTypes is a list of `NXOpen.Features.MeshSurfaceBuilderConstraintType`. type on each side.

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## GetFaceConstraintTypes

`MeshSurfaceBuilder.``GetFaceConstraintTypes`

  Get end constraints types.

  Signature `GetFaceConstraintTypes(constraintSize)`

  Parameters: | constraintSize (int) –
  Returns: | Constraint types
  Return type: | list of `NXOpen.Features.MeshSurfaceBuilderConstraintType`

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## GetProfile

`MeshSurfaceBuilder.``GetProfile`

  Get mesh profile string with provided index.

  Signature `GetProfile(index)`

  Parameters: | index (int) – Profile index.
  Returns: | Requested profile data.
  Return type: | `NXOpen.MeshProfileString`

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## GetProfilePointAlignment

`MeshSurfaceBuilder.``GetProfilePointAlignment`

  Get profile string point alignment info.

  Given a profile string, get alignment point parameters on segments indexed by align_index along the profile string.

  Signature `GetProfilePointAlignment(stringIndex, arrayLength)`

  Parameters:

  - stringIndex (int) – string index in profile strings
  - arrayLength (int) –

  Returns: | a tuple
  Return type: | A tuple consisting of (alignIndex, alignParams) alignIndex is a list of int. Alignment indices alignParams is a list of float. Alignment parameters

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## GetToleranceString

`MeshSurfaceBuilder.``GetToleranceString`

  Get tolerances strings.

  Signature `GetToleranceString(tolStrLength)`

  Parameters: | tolStrLength (int) –
  Returns: |
  Return type: | list of str

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## GetTolerances

`MeshSurfaceBuilder.``GetTolerances`

  Get tolerances.

  Signature `GetTolerances(tolLength)`

  Parameters: | tolLength (int) –
  Returns: |
  Return type: | list of float

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## InsertProfileString

`MeshSurfaceBuilder.``InsertProfileString`

  Insert a string (string_index, with order) into a profile (profile_index).

  Signature `InsertProfileString(profileIndex, order, stringIndex)`

  Parameters:

  - profileIndex (int) – mesh profile string index
  - order (`NXOpen.MeshProfileStringInsertOrder`) – before or after
  - stringIndex (int) – String index in mesh profile string

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## NewParametersData

`MeshSurfaceBuilder.``NewParametersData`

  Create a mesh parameters transient object data.

  Signature `NewParametersData()`

  Returns: | Allocated rebuild data.
  Return type: | `NXOpen.MeshParameterData`

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## NewProfile

`MeshSurfaceBuilder.``NewProfile`

  Construct a new mesh profile string transient object.

  Signature `NewProfile()`

  Returns: | New mesh profile string.
  Return type: | `NXOpen.MeshProfileString`

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## NewRebuildData

`MeshSurfaceBuilder.``NewRebuildData`

  Allocate memory for Mesh type surface rebuild data.

  Signature `NewRebuildData()`

  Returns: | Allocated rebuild data.
  Return type: | `NXOpen.SurfaceRebuildData`

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## RemovePointsAlignment

`MeshSurfaceBuilder.``RemovePointsAlignment`

  Remove points alignment information.

  Remove alignment can be restore by calling `Features.MeshSurfaceBuilder.RestorePointsAlignment()`

  Signature `RemovePointsAlignment()`

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## RemoveProfileString

`MeshSurfaceBuilder.``RemoveProfileString`

  Remove a string (string_index) from a profile (profile_index)

  Signature `RemoveProfileString(profileIndex, stringIndex)`

  Parameters:

  - profileIndex (int) – mesh profile string index
  - stringIndex (int) – String index in mesh profile string

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## RemoveSpineAlignment

`MeshSurfaceBuilder.``RemoveSpineAlignment`

  Remove spine alignment.

  Signature `RemoveSpineAlignment()`

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## ReorderProfileStringCurves

`MeshSurfaceBuilder.``ReorderProfileStringCurves`

  Reorder profile string curves.

  Signature `ReorderProfileStringCurves(stringIndex, stringStartCurve)`

  Parameters:

  - stringIndex (int) – Profile string index.
  - stringStartCurve (`NXOpen.Curve`) – New start curve.

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## RestorePointsAlignment

`MeshSurfaceBuilder.``RestorePointsAlignment`

  Restore the last removed points alignment information if there is one.

  Once restored, the saved alignment information will no logner be available.

  Signature `RestorePointsAlignment()`

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## SetAngleAlignmentPoints

`MeshSurfaceBuilder.``SetAngleAlignmentPoints`

  Set angle alignment points.

  Points will be used to evaluate the alignment angle.

  Signature `SetAngleAlignmentPoints(point1, point2)`

  Parameters:

  - point1 (`NXOpen.Point3d`) – Point 1
  - point2 (`NXOpen.Point3d`) – Point 2

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## SetDistanceAlignmentVector

`MeshSurfaceBuilder.``SetDistanceAlignmentVector`

  Set distance alignment vector

  Signature `SetDistanceAlignmentVector(vector)`

  Parameters: | vector (`NXOpen.Vector3d`) – Vector

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## SetFaceConstraintCollectors

`MeshSurfaceBuilder.``SetFaceConstraintCollectors`

  Set faces constraints collectors for through curves and curves mesh types surfaces.

  Signature `SetFaceConstraintCollectors(facesCons, collectors, consTypes)`

  Parameters:

  - facesCons (list of int) – Number of faces on all sides
  - collectors (list of `NXOpen.ScCollector`) – Constraints collectors.
  - consTypes (list of `NXOpen.Features.MeshSurfaceBuilderConstraintType`) – type on each side.

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## SetFaceConstraintTypes

`MeshSurfaceBuilder.``SetFaceConstraintTypes`

  Set end constraints types.

  Signature `SetFaceConstraintTypes(constraintTypes)`

  Parameters: | constraintTypes (list of `NXOpen.Features.MeshSurfaceBuilderConstraintType`) – Constraint types

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## SetProfilePointAlignment

`MeshSurfaceBuilder.``SetProfilePointAlignment`

  Set profile string alignment info.

  For each profile string, user needs to spectify the point alignment parameters on segments indexed by align_index along the profile string.

  Signature `SetProfilePointAlignment(stringIndex, alignIndex, alignParams)`

  Parameters:

  - stringIndex (int) – string index in profile strings
  - alignIndex (list of int) – Alignment indices
  - alignParams (list of float) – Alignment parameters (normalized)

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## SetToleranceString

`MeshSurfaceBuilder.``SetToleranceString`

  Set tolerances strings for mesh type surface.

  The strings much match the values.

  Signature `SetToleranceString(tolString)`

  Parameters: | tolString (list of str) – Tolerances

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## SetTolerances

`MeshSurfaceBuilder.``SetTolerances`

  Set tolerances for mesh type surfaces.

  Signature `SetTolerances(tol)`

  Parameters: | tol (list of float) – Tolerances

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)

## Validate

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

## ValidateFeatureParameters

`MeshSurfaceBuilder.``ValidateFeatureParameters`

  Validate the new parameters for mesh surface editing.

  Signature `ValidateFeatureParameters()`

  New in version NX4.0.0.

  License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)