NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Features::FlatteningAndFormingBuilder Class Reference

This class will provide the solution to unwrap 3D non-planar, curved geometry to a 2D plane. More...

Inheritance diagram for NXOpen::Features::FlatteningAndFormingBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DistortionMap { DistortionMapNone, DistortionMapLength, DistortionMapArea, DistortionMapAngle }
 Distortion Map options. More...
 
enum  Types { TypesCalculation, TypesReuse }
 Flattening Types. More...
 

Public Member Functions

NXOpen::SectionCutCurves ()
 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
Created in NX11.0.0. More...
 
NXOpen::Features::FlatteningAndFormingBuilder::DistortionMap DistortionMapOptions ()
 Returns the option to display the distortion map on the source faces. More...
 
NXOpen::SelectNXObjectFlatteningFeature ()
 Returns the flattening feature whose unwrapping mapping can be used to replay the unwrap or wrap on other objects
Created in NX11.0.0. More...
 
void GetDestinationFrame (NXOpen::Point3d *manipulatorOrigin, NXOpen::Matrix3x3 *manipulatorMatrix)
 Returns the destination coordinate system used for the flattening operation. More...
 
bool ReverseSecondaryDirection ()
 Returns the secondary direction is the cross product of primary direction and source face normal. More...
 
bool ReverseTransformation ()
 Returns the flag indicating if the reverse transformation will be used in the opposite direction
Created in NX11.0.0. More...
 
void SetDestinationFrame (const NXOpen::Point3d &manipulatorOrigin, const NXOpen::Matrix3x3 &manipulatorMatrix)
 Sets the destination coordinate system used for the flattened result. More...
 
void SetDistortionMapOptions (NXOpen::Features::FlatteningAndFormingBuilder::DistortionMap distortionMapOptions)
 Sets the option to display the distortion map on the source faces. More...
 
void SetReverseSecondaryDirection (bool reverseSecondaryDirection)
 Sets the secondary direction is the cross product of primary direction and source face normal. More...
 
void SetReverseTransformation (bool reverseTransformation)
 Sets the flag indicating if the reverse transformation will be used in the opposite direction
Created in NX11.0.0. More...
 
void SetSourceDirection (NXOpen::Direction *sourceDirection)
 Sets the source direction determines the orientation of the flattened surface. More...
 
void SetSourceOrigin (NXOpen::Point *sourceOrigin)
 Sets the source origin is a point on one of the source face. More...
 
void SetTabDetection (bool tabDetection)
 Sets the flag that indicates if internal tabbed faces can be shown or not. More...
 
void SetType (NXOpen::Features::FlatteningAndFormingBuilder::Types type)
 Sets the type
Created in NX11.0.0. More...
 
NXOpen::DirectionSourceDirection ()
 Returns the source direction determines the orientation of the flattened surface. More...
 
NXOpen::ScCollectorSourceFaces ()
 Returns the source faces that will be used to calculate the mapping of being flattened
Created in NX11.0.0. More...
 
NXOpen::PointSourceOrigin ()
 Returns the source origin is a point on one of the source face. More...
 
bool TabDetection ()
 Returns the flag that indicates if internal tabbed faces can be shown or not. More...
 
NXOpen::SelectNXObjectListTransformationObjects ()
 Returns the transformation objects are additional objects that can be flattened with the same mapping. More...
 
NXOpen::Features::FlatteningAndFormingBuilder::Types Type ()
 Returns the type
Created in NX11.0.0. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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::CreateFlatteningAndFormingBuilder
Default values.

Property Value

DistortionMapOptions

None

ReverseTransformation

0


Created in NX11.0.0.

Member Enumeration Documentation

Distortion Map options.

The options provides ability to display a distortion map on the source faces.

Enumerator
DistortionMapNone 

No distortion map.

DistortionMapLength 

Distortion of length.

DistortionMapArea 

Distortion of area.

DistortionMapAngle 

Shear distortion of U/V directions.

Flattening Types.

Enumerator
TypesCalculation 

This option faces to be flattened will be used to calculate the mapping.

The mapping can also be applied to additional transformation objects.

TypesReuse 

This option uses a transformation maping of an existing flattening feature to reapply it in its original or reversed direction to additional transformation objects.

Member Function Documentation

NXOpen::Section* NXOpen::Features::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
Created in NX11.0.0.



License requirements : None

NXOpen::Features::FlatteningAndFormingBuilder::DistortionMap NXOpen::Features::FlatteningAndFormingBuilder::DistortionMapOptions ( )

Returns the option to display the distortion map on the source faces.

Distortion caused by flattening will be marked up as color map
Created in NX11.0.0.

License requirements : None

NXOpen::SelectNXObject* NXOpen::Features::FlatteningAndFormingBuilder::FlatteningFeature ( )

Returns the flattening feature whose unwrapping mapping can be used to replay the unwrap or wrap on other objects
Created in NX11.0.0.



License requirements : None

void NXOpen::Features::FlatteningAndFormingBuilder::GetDestinationFrame ( NXOpen::Point3d manipulatorOrigin,
NXOpen::Matrix3x3 manipulatorMatrix 
)

Returns the destination coordinate system used for the flattening operation.


Created in NX11.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
manipulatorOriginmanipulatororigin
manipulatorMatrixmanipulatormatrix
bool NXOpen::Features::FlatteningAndFormingBuilder::ReverseSecondaryDirection ( )

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

This direction can be reversed
Created in NX11.0.0.

License requirements : None

bool NXOpen::Features::FlatteningAndFormingBuilder::ReverseTransformation ( )

Returns the flag indicating if the reverse transformation will be used in the opposite direction
Created in NX11.0.0.



License requirements : None

void NXOpen::Features::FlatteningAndFormingBuilder::SetDestinationFrame ( const NXOpen::Point3d manipulatorOrigin,
const NXOpen::Matrix3x3 manipulatorMatrix 
)

Sets the destination coordinate system used for the flattened result.


Created in NX11.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
manipulatorOriginmanipulatororigin
manipulatorMatrixmanipulatormatrix
void NXOpen::Features::FlatteningAndFormingBuilder::SetDistortionMapOptions ( NXOpen::Features::FlatteningAndFormingBuilder::DistortionMap  distortionMapOptions)

Sets the option to display the distortion map on the source faces.

Distortion caused by flattening will be marked up as color map
Created in NX11.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
distortionMapOptionsdistortionmapoptions
void NXOpen::Features::FlatteningAndFormingBuilder::SetReverseSecondaryDirection ( bool  reverseSecondaryDirection)

Sets the secondary direction is the cross product of primary direction and source face normal.

This direction can be reversed
Created in NX11.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
reverseSecondaryDirectionreversesecondarydirection
void NXOpen::Features::FlatteningAndFormingBuilder::SetReverseTransformation ( bool  reverseTransformation)

Sets the flag indicating if the reverse transformation will be used in the opposite direction
Created in NX11.0.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
reverseTransformationreversetransformation
void NXOpen::Features::FlatteningAndFormingBuilder::SetSourceDirection ( NXOpen::Direction sourceDirection)

Sets the source direction determines the orientation of the flattened surface.


Created in NX11.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
sourceDirectionsourcedirection
void NXOpen::Features::FlatteningAndFormingBuilder::SetSourceOrigin ( NXOpen::Point sourceOrigin)

Sets the source origin is a point on one of the source face.

It is required to establish the flattening plane
Created in NX11.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
sourceOriginsourceorigin
void NXOpen::Features::FlatteningAndFormingBuilder::SetTabDetection ( bool  tabDetection)

Sets the flag that indicates if internal tabbed faces can be shown or not.


Created in NX11.0.1.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
tabDetectiontabdetection
void NXOpen::Features::FlatteningAndFormingBuilder::SetType ( NXOpen::Features::FlatteningAndFormingBuilder::Types  type)

Sets the type
Created in NX11.0.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
typetype
NXOpen::Direction* NXOpen::Features::FlatteningAndFormingBuilder::SourceDirection ( )

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


Created in NX11.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::FlatteningAndFormingBuilder::SourceFaces ( )

Returns the source faces that will be used to calculate the mapping of being flattened
Created in NX11.0.0.



License requirements : None

NXOpen::Point* NXOpen::Features::FlatteningAndFormingBuilder::SourceOrigin ( )

Returns the source origin is a point on one of the source face.

It is required to establish the flattening plane
Created in NX11.0.0.

License requirements : None

bool NXOpen::Features::FlatteningAndFormingBuilder::TabDetection ( )

Returns the flag that indicates if internal tabbed faces can be shown or not.


Created in NX11.0.1.

License requirements : studio_free_form ("STUDIO FREE FORM")

NXOpen::SelectNXObjectList* NXOpen::Features::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 .
Created in NX11.0.0.

License requirements : None

NXOpen::Features::FlatteningAndFormingBuilder::Types NXOpen::Features::FlatteningAndFormingBuilder::Type ( )

Returns the type
Created in NX11.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.