FlatteningBuilder Class¶
-
class
NXOpen.
FlatteningBuilder
¶ Bases:
NXOpen.Builder
Represents a
FlatteningBuilder
builder. It creates a sheet body, as a flattened representation of some other sheet body or faces.To create a new instance of this class, use
NXOpen.BodyCollection.CreateFlatteningBuilder()
New in version NX8.5.3.
Deprecated since version NX11.0.0: Use
NXOpen.Features.FlatteningAndFormingBuilder
instead.
Properties¶
Property | Description |
---|---|
DistortionMap | Returns or sets the distortion map. |
FlatteningConstant | Returns or sets the constraint type for flattening a curved surface. |
ManipulatorMatrix | Returns or sets the orientation of the flattened result. |
ManipulatorOrigin | Returns or sets the location of the flattened result. |
ReverseTransformation | Returns or sets the flag indicating whether to reverse the flattening transformation. |
SelectCutCurves | Returns the curves to cut the surface for reducing distortion. |
SelectFlatteningFeature | Returns the existing flattening feature to reuse its transformation. |
SelectReferenceBodies | Returns the reference bodies for constraining constant volumes. |
SelectReferenceCurves | Returns the reference curves for constraining constant lengths. |
SelectReferenceFaces | Returns the reference faces or sheet bodies for constraining constant areas. |
SelectTargetFaces | Returns the selected target faces or sheet bodies to be flattened. |
SelectTransformationObjects | Returns the input transformation objects such as bodies, faces, curves, points, etc to apply flattening transformation on. |
SpecifyPoint | Returns or sets a point on the target faces. |
SpecifyPrimaryDirection | Returns or sets the primary direction to define x-axis of the flattening plane |
Tag | Returns the Tag for this object. |
Type | Returns or sets the flattening operation type. |
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. |
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¶
FlatteningBuilderDistortionMapType Enumeration | This enum defines the distortion map types. |
FlatteningBuilderFlatteningConstantType Enumeration | This enum defines the flattening constraints types. |
FlatteningBuilderTypes Enumeration | This enum defines the operation types. |
Property Detail¶
DistortionMap¶
-
FlatteningBuilder.
DistortionMap
¶ Returns or sets the distortion map.
-------------------------------------
Getter Method
Signature
DistortionMap
Returns: Return type: NXOpen.FlatteningBuilderDistortionMapType
New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
-------------------------------------
Setter Method
Signature
DistortionMap
Parameters: distortionMap ( NXOpen.FlatteningBuilderDistortionMapType
) –New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
FlatteningConstant¶
-
FlatteningBuilder.
FlatteningConstant
¶ Returns or sets the constraint type for flattening a curved surface.
-------------------------------------
Getter Method
Signature
FlatteningConstant
Returns: Return type: NXOpen.FlatteningBuilderFlatteningConstantType
New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
-------------------------------------
Setter Method
Signature
FlatteningConstant
Parameters: flatteningConstant ( NXOpen.FlatteningBuilderFlatteningConstantType
) –New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
ManipulatorMatrix¶
-
FlatteningBuilder.
ManipulatorMatrix
¶ Returns or sets the orientation of the flattened result.
-------------------------------------
Getter Method
Signature
ManipulatorMatrix
Returns: Return type: NXOpen.Matrix3x3
New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
-------------------------------------
Setter Method
Signature
ManipulatorMatrix
Parameters: manipulatorMatrix ( NXOpen.Matrix3x3
) –New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
ManipulatorOrigin¶
-
FlatteningBuilder.
ManipulatorOrigin
¶ Returns or sets the location of the flattened result.
-------------------------------------
Getter Method
Signature
ManipulatorOrigin
Returns: Return type: NXOpen.Point3d
New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
-------------------------------------
Setter Method
Signature
ManipulatorOrigin
Parameters: manipulatorOrigin ( NXOpen.Point3d
) –New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
ReverseTransformation¶
-
FlatteningBuilder.
ReverseTransformation
¶ Returns or sets the flag indicating whether to reverse the flattening transformation.
-------------------------------------
Getter Method
Signature
ReverseTransformation
Returns: Return type: bool New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
-------------------------------------
Setter Method
Signature
ReverseTransformation
Parameters: reverseTransformation (bool) – New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SelectCutCurves¶
-
FlatteningBuilder.
SelectCutCurves
¶ Returns the curves to cut the surface for reducing distortion.
-------------------------------------
Getter Method
Signature
SelectCutCurves
Returns: Return type: NXOpen.ScCollector
New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SelectFlatteningFeature¶
-
FlatteningBuilder.
SelectFlatteningFeature
¶ Returns the existing flattening feature to reuse its transformation.
-------------------------------------
Getter Method
Signature
SelectFlatteningFeature
Returns: Return type: NXOpen.Features.SelectFeature
New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SelectReferenceBodies¶
-
FlatteningBuilder.
SelectReferenceBodies
¶ Returns the reference bodies for constraining constant volumes.
-------------------------------------
Getter Method
Signature
SelectReferenceBodies
Returns: Return type: NXOpen.SelectBodyList
New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SelectReferenceCurves¶
-
FlatteningBuilder.
SelectReferenceCurves
¶ Returns the reference curves for constraining constant lengths.
-------------------------------------
Getter Method
Signature
SelectReferenceCurves
Returns: Return type: NXOpen.ScCollector
New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SelectReferenceFaces¶
-
FlatteningBuilder.
SelectReferenceFaces
¶ Returns the reference faces or sheet bodies for constraining constant areas.
-------------------------------------
Getter Method
Signature
SelectReferenceFaces
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SelectTargetFaces¶
-
FlatteningBuilder.
SelectTargetFaces
¶ Returns the selected target faces or sheet bodies to be flattened.
-------------------------------------
Getter Method
Signature
SelectTargetFaces
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SelectTransformationObjects¶
-
FlatteningBuilder.
SelectTransformationObjects
¶ Returns the input transformation objects such as bodies, faces, curves, points, etc to apply flattening transformation on.
-------------------------------------
Getter Method
Signature
SelectTransformationObjects
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SpecifyPoint¶
-
FlatteningBuilder.
SpecifyPoint
¶ Returns or sets a point on the target faces.
Local normal and orientation of the target face will be used as origin to establish the flattening plane.
-------------------------------------
Getter Method
Signature
SpecifyPoint
Returns: Return type: NXOpen.Point
New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
-------------------------------------
Setter Method
Signature
SpecifyPoint
Parameters: specifyPoint ( NXOpen.Point
) –New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
SpecifyPrimaryDirection¶
-
FlatteningBuilder.
SpecifyPrimaryDirection
¶ Returns or sets the primary direction to define x-axis of the flattening plane
-------------------------------------
Getter Method
Signature
SpecifyPrimaryDirection
Returns: Return type: NXOpen.Direction
New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
-------------------------------------
Setter Method
Signature
SpecifyPrimaryDirection
Parameters: specifyPrimaryDirection ( NXOpen.Direction
) –New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
Type¶
-
FlatteningBuilder.
Type
¶ Returns or sets the flattening operation type.
-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.FlatteningBuilderTypes
New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
-------------------------------------
Setter Method
Signature
Type
Parameters: type ( NXOpen.FlatteningBuilderTypes
) –New in version NX8.5.3.
License requirements: studio_free_form (“STUDIO FREE FORM”)
Method Detail¶
Validate¶
-
FlatteningBuilder.
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.