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

Represents a FlatteningBuilder builder. More...

Inheritance diagram for NXOpen::FlatteningBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DistortionMapType { DistortionMapTypeNone, DistortionMapTypeLength, DistortionMapTypeArea, DistortionMapTypeAngle }
 This enum defines the distortion map types. More...
 
enum  FlatteningConstantType { FlatteningConstantTypeNoConstraints, FlatteningConstantTypeConstantCurveLength, FlatteningConstantTypeConstantFaceArea, FlatteningConstantTypeConstantBodyVolume }
 This enum defines the flattening constraints types. More...
 
enum  Types { TypesCalculation, TypesReuse }
 This enum defines the operation types. More...
 

Public Member Functions

NXOpen::FlatteningBuilder::DistortionMapType DistortionMap ()
 Returns the distortion map. More...
 
NXOpen::FlatteningBuilder::FlatteningConstantType FlatteningConstant ()
 Returns the constraint type for flattening a curved surface. More...
 
NXOpen::Matrix3x3 ManipulatorMatrix ()
 Returns the orientation of the flattened result. More...
 
NXOpen::Point3d ManipulatorOrigin ()
 Returns the location of the flattened result. More...
 
bool ReverseTransformation ()
 Returns the flag indicating whether to reverse the flattening transformation. More...
 
NXOpen::ScCollectorSelectCutCurves ()
 Returns the curves to cut the surface for reducing distortion. More...
 
NXOpen::Features::SelectFeatureSelectFlatteningFeature ()
 Returns the existing flattening feature to reuse its transformation. More...
 
NXOpen::SelectBodyListSelectReferenceBodies ()
 Returns the reference bodies for constraining constant volumes. More...
 
NXOpen::ScCollectorSelectReferenceCurves ()
 Returns the reference curves for constraining constant lengths. More...
 
NXOpen::SelectDisplayableObjectListSelectReferenceFaces ()
 Returns the reference faces or sheet bodies for constraining constant areas. More...
 
NXOpen::SelectDisplayableObjectListSelectTargetFaces ()
 Returns the selected target faces or sheet bodies to be flattened. More...
 
NXOpen::SelectDisplayableObjectListSelectTransformationObjects ()
 Returns the input transformation objects such as bodies, faces, curves, points, etc to apply flattening transformation on. More...
 
void SetDistortionMap (NXOpen::FlatteningBuilder::DistortionMapType distortionMap)
 Sets the distortion map. More...
 
void SetFlatteningConstant (NXOpen::FlatteningBuilder::FlatteningConstantType flatteningConstant)
 Sets the constraint type for flattening a curved surface. More...
 
void SetManipulatorMatrix (const NXOpen::Matrix3x3 &manipulatorMatrix)
 Sets the orientation of the flattened result. More...
 
void SetManipulatorOrigin (const NXOpen::Point3d &manipulatorOrigin)
 Sets the location of the flattened result. More...
 
void SetReverseTransformation (bool reverseTransformation)
 Sets the flag indicating whether to reverse the flattening transformation. More...
 
void SetSpecifyPoint (NXOpen::Point *specifyPoint)
 Sets a point on the target faces. More...
 
void SetSpecifyPrimaryDirection (NXOpen::Direction *specifyPrimaryDirection)
 Sets the primary direction to define x-axis of the flattening plane
More...
 
void SetType (NXOpen::FlatteningBuilder::Types type)
 Sets the flattening operation type. More...
 
NXOpen::PointSpecifyPoint ()
 Returns a point on the target faces. More...
 
NXOpen::DirectionSpecifyPrimaryDirection ()
 Returns the primary direction to define x-axis of the flattening plane
More...
 
NXOpen::FlatteningBuilder::Types Type ()
 Returns the flattening operation type. 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

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

Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

Member Enumeration Documentation

This enum defines the distortion map types.

Enumerator
DistortionMapTypeNone 

no distortion map

DistortionMapTypeLength 

length distortion map

DistortionMapTypeArea 

area distortion map

DistortionMapTypeAngle 

angle distortion map

This enum defines the flattening constraints types.

Enumerator
FlatteningConstantTypeNoConstraints 

No constraints.

FlatteningConstantTypeConstantCurveLength 

Force constant length.

FlatteningConstantTypeConstantFaceArea 

Force constant area.

FlatteningConstantTypeConstantBodyVolume 

force constant volume of the body

This enum defines the operation types.

Enumerator
TypesCalculation 

Calculate new flattening result.

TypesReuse 

Reuse existing flattening result.

Member Function Documentation

NXOpen::FlatteningBuilder::DistortionMapType NXOpen::FlatteningBuilder::DistortionMap ( )

Returns the distortion map.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

NXOpen::FlatteningBuilder::FlatteningConstantType NXOpen::FlatteningBuilder::FlatteningConstant ( )

Returns the constraint type for flattening a curved surface.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

NXOpen::Matrix3x3 NXOpen::FlatteningBuilder::ManipulatorMatrix ( )

Returns the orientation of the flattened result.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

NXOpen::Point3d NXOpen::FlatteningBuilder::ManipulatorOrigin ( )

Returns the location of the flattened result.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

bool NXOpen::FlatteningBuilder::ReverseTransformation ( )

Returns the flag indicating whether to reverse the flattening transformation.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

NXOpen::ScCollector* NXOpen::FlatteningBuilder::SelectCutCurves ( )

Returns the curves to cut the surface for reducing distortion.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

NXOpen::Features::SelectFeature* NXOpen::FlatteningBuilder::SelectFlatteningFeature ( )

Returns the existing flattening feature to reuse its transformation.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

NXOpen::SelectBodyList* NXOpen::FlatteningBuilder::SelectReferenceBodies ( )

Returns the reference bodies for constraining constant volumes.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

NXOpen::ScCollector* NXOpen::FlatteningBuilder::SelectReferenceCurves ( )

Returns the reference curves for constraining constant lengths.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

NXOpen::SelectDisplayableObjectList* NXOpen::FlatteningBuilder::SelectReferenceFaces ( )

Returns the reference faces or sheet bodies for constraining constant areas.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

NXOpen::SelectDisplayableObjectList* NXOpen::FlatteningBuilder::SelectTargetFaces ( )

Returns the selected target faces or sheet bodies to be flattened.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

NXOpen::SelectDisplayableObjectList* NXOpen::FlatteningBuilder::SelectTransformationObjects ( )

Returns the input transformation objects such as bodies, faces, curves, points, etc to apply flattening transformation on.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

void NXOpen::FlatteningBuilder::SetDistortionMap ( NXOpen::FlatteningBuilder::DistortionMapType  distortionMap)

Sets the distortion map.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
distortionMapdistortionmap
void NXOpen::FlatteningBuilder::SetFlatteningConstant ( NXOpen::FlatteningBuilder::FlatteningConstantType  flatteningConstant)

Sets the constraint type for flattening a curved surface.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
flatteningConstantflatteningconstant
void NXOpen::FlatteningBuilder::SetManipulatorMatrix ( const NXOpen::Matrix3x3 manipulatorMatrix)

Sets the orientation of the flattened result.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
manipulatorMatrixmanipulatormatrix
void NXOpen::FlatteningBuilder::SetManipulatorOrigin ( const NXOpen::Point3d manipulatorOrigin)

Sets the location of the flattened result.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
manipulatorOriginmanipulatororigin
void NXOpen::FlatteningBuilder::SetReverseTransformation ( bool  reverseTransformation)

Sets the flag indicating whether to reverse the flattening transformation.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
reverseTransformationreversetransformation
void NXOpen::FlatteningBuilder::SetSpecifyPoint ( NXOpen::Point specifyPoint)

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.

Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
specifyPointspecifypoint
void NXOpen::FlatteningBuilder::SetSpecifyPrimaryDirection ( NXOpen::Direction specifyPrimaryDirection)

Sets the primary direction to define x-axis of the flattening plane

Deprecated:
Deprecated in NX11.0.0.

Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
specifyPrimaryDirectionspecifyprimarydirection
void NXOpen::FlatteningBuilder::SetType ( NXOpen::FlatteningBuilder::Types  type)

Sets the flattening operation type.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
typetype
NXOpen::Point* NXOpen::FlatteningBuilder::SpecifyPoint ( )

Returns a point on the target faces.

Local normal and orientation of the target face will be used as origin to establish the flattening plane.

Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

NXOpen::Direction* NXOpen::FlatteningBuilder::SpecifyPrimaryDirection ( )

Returns the primary direction to define x-axis of the flattening plane

Deprecated:
Deprecated in NX11.0.0.

Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")

NXOpen::FlatteningBuilder::Types NXOpen::FlatteningBuilder::Type ( )

Returns the flattening operation type.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::Features::FlatteningAndFormingBuilder instead.


Created in NX8.5.3.

License requirements : studio_free_form ("STUDIO FREE FORM")


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