FlatteningAndFormingBuilderEx Class

class NXOpen.Features.FlatteningAndFormingBuilderEx

Bases: NXOpen.Features.FeatureBuilder

This 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.CreateFlatteningAndFormingBuilderEx()

Default values.

Property Value
ConstraintOptions NoConstraints
DistortionMapOptions None
ReverseTransformation 0

New in version NX12.0.0.

Properties

Property Description
AuxiliaryFaces Returns the auxiliary faces that will be used to calculate the mapping of being flattened separatly and then connected to the flattened source faces
ConstraintOptions Returns or sets the option to minimize the disturbance
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
DestinationCoordinateSystem Returns or sets the coordinate system
DistortionMapOptions Returns or sets the option to display the distortion map on the source faces.
FixedElementsList Returns the list of points, curves or edges or faces of the source faces that act as fixed items
FlatteningFeature Returns the flattening feature whose unwrapping mapping can be used to replay the unwrap or wrap on other objects
OuterBoundary Returns the outer boundary of the source face that could have the longest length
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
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.
SourceVDirection Returns or sets the secondary direction is the cross product of primary direction and source face normal
SurroundingPatchSurfaceFilename Returns or sets the surrounding patch surface filename
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.
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.
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.

Property Detail

AuxiliaryFaces

FlatteningAndFormingBuilderEx.AuxiliaryFaces

Returns the auxiliary faces that will be used to calculate the mapping of being flattened separatly and then connected to the flattened source faces

-------------------------------------

Getter Method

Signature AuxiliaryFaces

Returns:
Return type:NXOpen.ScCollector

New in version NX12.0.0.

License requirements: None.

ConstraintOptions

FlatteningAndFormingBuilderEx.ConstraintOptions

Returns or sets the option to minimize the disturbance

-------------------------------------

Getter Method

Signature ConstraintOptions

Returns:
Return type:NXOpen.Features.FlatteningAndFormingBuilderExConstraints

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ConstraintOptions

Parameters:constraintOptions (NXOpen.Features.FlatteningAndFormingBuilderExConstraints) –

New in version NX12.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

CutCurves

FlatteningAndFormingBuilderEx.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 CutCurves

Returns:
Return type:NXOpen.Section

New in version NX12.0.0.

License requirements: None.

DestinationCoordinateSystem

FlatteningAndFormingBuilderEx.DestinationCoordinateSystem

Returns or sets the coordinate system

-------------------------------------

Getter Method

Signature DestinationCoordinateSystem

Returns:
Return type:NXOpen.CoordinateSystem

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DestinationCoordinateSystem

Parameters:coordSystem (NXOpen.CoordinateSystem) –

New in version NX12.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

DistortionMapOptions

FlatteningAndFormingBuilderEx.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 DistortionMapOptions

Returns:
Return type:NXOpen.Features.FlatteningAndFormingBuilderExDistortionMap

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DistortionMapOptions

Parameters:distortionMapOptions (NXOpen.Features.FlatteningAndFormingBuilderExDistortionMap) –

New in version NX12.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

FixedElementsList

FlatteningAndFormingBuilderEx.FixedElementsList

Returns the list of points, curves or edges or faces of the source faces that act as fixed items

-------------------------------------

Getter Method

Signature FixedElementsList

Returns:
Return type:NXOpen.NXObjectList

New in version NX12.0.0.

License requirements: None.

FlatteningFeature

FlatteningAndFormingBuilderEx.FlatteningFeature

Returns the flattening feature whose unwrapping mapping can be used to replay the unwrap or wrap on other objects

-------------------------------------

Getter Method

Signature FlatteningFeature

Returns:
Return type:NXOpen.SelectNXObject

New in version NX12.0.0.

License requirements: None.

OuterBoundary

FlatteningAndFormingBuilderEx.OuterBoundary

Returns the outer boundary of the source face that could have the longest length

-------------------------------------

Getter Method

Signature OuterBoundary

Returns:
Return type:NXOpen.SelectNXObject

New in version NX12.0.0.

License requirements: None.

ReverseTransformation

FlatteningAndFormingBuilderEx.ReverseTransformation

Returns or sets the flag indicating if the reverse transformation will be used in the opposite direction

-------------------------------------

Getter Method

Signature ReverseTransformation

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ReverseTransformation

Parameters:reverseTransformation (bool) –

New in version NX12.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

SourceDirection

FlatteningAndFormingBuilderEx.SourceDirection

Returns or sets the source direction determines the orientation of the flattened surface.

-------------------------------------

Getter Method

Signature SourceDirection

Returns:
Return type:NXOpen.Direction

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SourceDirection

Parameters:sourceDirection (NXOpen.Direction) –

New in version NX12.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

SourceFaces

FlatteningAndFormingBuilderEx.SourceFaces

Returns the source faces that will be used to calculate the mapping of being flattened

-------------------------------------

Getter Method

Signature SourceFaces

Returns:
Return type:NXOpen.ScCollector

New in version NX12.0.0.

License requirements: None.

SourceOrigin

FlatteningAndFormingBuilderEx.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 SourceOrigin

Returns:
Return type:NXOpen.Point

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SourceOrigin

Parameters:sourceOrigin (NXOpen.Point) –

New in version NX12.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

SourceVDirection

FlatteningAndFormingBuilderEx.SourceVDirection

Returns or sets the secondary direction is the cross product of primary direction and source face normal

-------------------------------------

Getter Method

Signature SourceVDirection

Returns:
Return type:NXOpen.Direction

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SourceVDirection

Parameters:sourceVDirection (NXOpen.Direction) –

New in version NX12.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

TransformationObjects

FlatteningAndFormingBuilderEx.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 TransformationObjects

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX12.0.0.

License requirements: None.

Type

FlatteningAndFormingBuilderEx.Type

Returns or sets the type

-------------------------------------

Getter Method

Signature Type

Returns:
Return type:NXOpen.Features.FlatteningAndFormingBuilderExTypes

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Type

Parameters:type (NXOpen.Features.FlatteningAndFormingBuilderExTypes) –

New in version NX12.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

Method Detail

Validate

FlatteningAndFormingBuilderEx.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.