FlatteningAndFormingBuilder Class¶
-
class
NXOpen.Features.FlatteningAndFormingBuilder¶ Bases:
NXOpen.Features.FeatureBuilderThis class will provide the solution to unwrap 3D non-planar, curved geometry to a 2D plane.
The transformation mapping of unwrapping non-planar faces to a plane can be used bi-directional. Unwrapping geometry and wrapping geometry from a plane to the 3D shape.
To create a new instance of this class, use
NXOpen.Features.FreeformSurfaceCollection.CreateFlatteningAndFormingBuilder()Default values.
Property Value DistortionMapOptions None ReverseTransformation 0 New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| CutCurves | Returns the cut curves on or close to the source face can be used to tear the source face along these curvesto reduce the distortion during flattening |
| DistortionMapOptions | Returns or sets the option to display the distortion map on the source faces. |
| FlatteningFeature | Returns the flattening feature whose unwrapping mapping can be used to replay the unwrap or wrap on other objects |
| 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 |
| ReverseSecondaryDirection | Returns or sets the secondary direction is the cross product of primary direction and source face normal. |
| ReverseTransformation | Returns or sets the flag indicating if the reverse transformation will be used in the opposite direction |
| SourceDirection | Returns or sets the source direction determines the orientation of the flattened surface. |
| SourceFaces | Returns the source faces that will be used to calculate the mapping of being flattened |
| SourceOrigin | Returns or sets the source origin is a point on one of the source face. |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| TabDetection | Returns or sets the flag that indicates if internal tabbed faces can be shown or not. |
| Tag | Returns the Tag for this object. |
| TransformationObjects | Returns the transformation objects are additional objects that can be flattened with the same mapping. |
| Type | Returns or sets the type |
Methods¶
| Method | Description |
|---|---|
| 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. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetDestinationFrame | Returns the destination coordinate system used for the flattening operation. |
| GetFeature | Returns the feature currently being edited by this builder. |
| GetObject | Returns the object currently being edited by this builder. |
| HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
| SetDestinationFrame | Sets the destination coordinate system used for the flattened result. |
| SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
| 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. |
Enumerations¶
| FlatteningAndFormingBuilderDistortionMap Enumeration | Distortion Map options. |
| FlatteningAndFormingBuilderTypes Enumeration | Flattening Types |
Property Detail¶
CutCurves¶
-
FlatteningAndFormingBuilder.CutCurves¶ Returns the cut curves on or close to the source face can be used to tear the source face along these curvesto reduce the distortion during flattening
-------------------------------------Getter Method
Signature
CutCurvesReturns: Return type: NXOpen.SectionNew in version NX11.0.0.
License requirements: None.
DistortionMapOptions¶
-
FlatteningAndFormingBuilder.DistortionMapOptions¶ Returns or sets the option to display the distortion map on the source faces.
Distortion caused by flattening will be marked up as color map
-------------------------------------Getter Method
Signature
DistortionMapOptionsReturns: Return type: NXOpen.Features.FlatteningAndFormingBuilderDistortionMapNew in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DistortionMapOptionsParameters: distortionMapOptions ( NXOpen.Features.FlatteningAndFormingBuilderDistortionMap) –New in version NX11.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
FlatteningFeature¶
-
FlatteningAndFormingBuilder.FlatteningFeature¶ Returns the flattening feature whose unwrapping mapping can be used to replay the unwrap or wrap on other objects
-------------------------------------Getter Method
Signature
FlatteningFeatureReturns: Return type: NXOpen.SelectNXObjectNew in version NX11.0.0.
License requirements: None.
ReverseSecondaryDirection¶
-
FlatteningAndFormingBuilder.ReverseSecondaryDirection¶ Returns or sets the secondary direction is the cross product of primary direction and source face normal.
This direction can be reversed
-------------------------------------Getter Method
Signature
ReverseSecondaryDirectionReturns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReverseSecondaryDirectionParameters: reverseSecondaryDirection (bool) – New in version NX11.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
ReverseTransformation¶
-
FlatteningAndFormingBuilder.ReverseTransformation¶ Returns or sets the flag indicating if the reverse transformation will be used in the opposite direction
-------------------------------------Getter Method
Signature
ReverseTransformationReturns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReverseTransformationParameters: reverseTransformation (bool) – New in version NX11.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SourceDirection¶
-
FlatteningAndFormingBuilder.SourceDirection¶ Returns or sets the source direction determines the orientation of the flattened surface.
-------------------------------------Getter Method
Signature
SourceDirectionReturns: Return type: NXOpen.DirectionNew in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SourceDirectionParameters: sourceDirection ( NXOpen.Direction) –New in version NX11.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SourceFaces¶
-
FlatteningAndFormingBuilder.SourceFaces¶ Returns the source faces that will be used to calculate the mapping of being flattened
-------------------------------------Getter Method
Signature
SourceFacesReturns: Return type: NXOpen.ScCollectorNew in version NX11.0.0.
License requirements: None.
SourceOrigin¶
-
FlatteningAndFormingBuilder.SourceOrigin¶ Returns or sets the source origin is a point on one of the source face.
It is required to establish the flattening plane
-------------------------------------Getter Method
Signature
SourceOriginReturns: Return type: NXOpen.PointNew in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SourceOriginParameters: sourceOrigin ( NXOpen.Point) –New in version NX11.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
TabDetection¶
-
FlatteningAndFormingBuilder.TabDetection¶ Returns or sets the flag that indicates if internal tabbed faces can be shown or not.
-------------------------------------Getter Method
Signature
TabDetectionReturns: Return type: bool New in version NX11.0.1.
License requirements: studio_free_form (“STUDIO FREE FORM”)
-------------------------------------Setter Method
Signature
TabDetectionParameters: tabDetection (bool) – New in version NX11.0.1.
License requirements: studio_free_form (“STUDIO FREE FORM”)
TransformationObjects¶
-
FlatteningAndFormingBuilder.TransformationObjects¶ Returns the transformation objects are additional objects that can be flattened with the same mapping.
Transformation objects are required objects for Forming and Reuse .
-------------------------------------Getter Method
Signature
TransformationObjectsReturns: Return type: NXOpen.SelectNXObjectListNew in version NX11.0.0.
License requirements: None.
Type¶
-
FlatteningAndFormingBuilder.Type¶ Returns or sets the type
-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.Features.FlatteningAndFormingBuilderTypesNew in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TypeParameters: type ( NXOpen.Features.FlatteningAndFormingBuilderTypes) –New in version NX11.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
Method Detail¶
GetDestinationFrame¶
-
FlatteningAndFormingBuilder.GetDestinationFrame¶ Returns the destination coordinate system used for the flattening operation.
Signature
GetDestinationFrame()Returns: a tuple Return type: A tuple consisting of (manipulatorOrigin, manipulatorMatrix). manipulatorOrigin is a NXOpen.Point3d. manipulatorMatrix is aNXOpen.Matrix3x3.New in version NX11.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SetDestinationFrame¶
-
FlatteningAndFormingBuilder.SetDestinationFrame¶ Sets the destination coordinate system used for the flattened result.
Signature
SetDestinationFrame(manipulatorOrigin, manipulatorMatrix)Parameters: - manipulatorOrigin (
NXOpen.Point3d) – - manipulatorMatrix (
NXOpen.Matrix3x3) –
New in version NX11.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
- manipulatorOrigin (
Validate¶
-
FlatteningAndFormingBuilder.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.