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

Represents a NXOpen::Features::WrapUnwrap builder. More...

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

Public Types

enum  Types { TypesWrap, TypesUnwrap }
 Settings for the type of wrap operation being performed. More...
 

Public Member Functions

double AngleTolerance ()
 Returns the angle tolerance used to determine the sampling of the curve during processing, and the accuracy of the output. More...
 
bool Associative ()
 Returns the flag that indicates during creation if a feature is to be created or just the curves, true indicates a feature will be created. More...
 
NXOpen::SectionCurves ()
 Returns the curves that are being wrapped or unwrapped. More...
 
NXOpen::ExpressionCutLineAngle ()
 Returns the angle, measured from the point of tangency of the plane and the faces, at which curves will be split during the wrapping operation. More...
 
double DistanceTolerance ()
 Returns the distance tolerance used to determine the sampling of the curve during processing, and the accuracy of the output. More...
 
NXOpen::ScCollectorFaces ()
 Returns the faces that the curves are being unwrapped from or wrapped to. More...
 
NXOpen::SelectISurfacePlane ()
 Returns the planar face or datum plane that the curves are being wrapped from or unwrapped to. More...
 
void SetAngleTolerance (double angleTolerance)
 Sets the angle tolerance used to determine the sampling of the curve during processing, and the accuracy of the output. More...
 
void SetAssociative (bool associative)
 Sets the flag that indicates during creation if a feature is to be created or just the curves, true indicates a feature will be created. More...
 
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance used to determine the sampling of the curve during processing, and the accuracy of the output. More...
 
void SetSpecifyPlane (NXOpen::Plane *plane)
 Sets the specified plane that the curves are being wrapped from or unwrapped to. More...
 
void SetType (NXOpen::Features::WrapBuilder::Types type)
 Sets the type of operation being performed. More...
 
NXOpen::PlaneSpecifyPlane ()
 Returns the specified plane that the curves are being wrapped from or unwrapped to. More...
 
NXOpen::Features::WrapBuilder::Types Type ()
 Returns the type of operation being performed. 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

Represents a NXOpen::Features::WrapUnwrap builder.

This class is used in the process of creating or editing a wrap or unwrap curve feature, as well as creating wrapped or unwrapped curves not associated to a feature.
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateWrapBuilder
Default values.

Property Value

AngleTolerance

0.5

Associative

1

CutLineAngle.Value

180 (millimeters part), 180 (inches part)

DistanceTolerance

0.0254 (millimeters part), 0.001 (inches part)


Created in NX6.0.0.

Member Enumeration Documentation

Settings for the type of wrap operation being performed.

Enumerator
TypesWrap 

Curves are to be wrapped from a plane onto the selected faces, during edit you can get this value but any change will be ignored.

TypesUnwrap 

Curves are to be unwrapped from the selected faces onto the tangent plane, during edit you can get this value but any change will be ignored.

Member Function Documentation

double NXOpen::Features::WrapBuilder::AngleTolerance ( )

Returns the angle tolerance used to determine the sampling of the curve during processing, and the accuracy of the output.


Created in NX6.0.0.

License requirements : None

bool NXOpen::Features::WrapBuilder::Associative ( )

Returns the flag that indicates during creation if a feature is to be created or just the curves, true indicates a feature will be created.


Created in NX6.0.0.

License requirements : None

NXOpen::Section* NXOpen::Features::WrapBuilder::Curves ( )

Returns the curves that are being wrapped or unwrapped.


Created in NX6.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Features::WrapBuilder::CutLineAngle ( )

Returns the angle, measured from the point of tangency of the plane and the faces, at which curves will be split during the wrapping operation.


Created in NX6.0.0.

License requirements : None

double NXOpen::Features::WrapBuilder::DistanceTolerance ( )

Returns the distance tolerance used to determine the sampling of the curve during processing, and the accuracy of the output.


Created in NX6.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::WrapBuilder::Faces ( )

Returns the faces that the curves are being unwrapped from or wrapped to.


Created in NX6.0.0.

License requirements : None

NXOpen::SelectISurface* NXOpen::Features::WrapBuilder::Plane ( )

Returns the planar face or datum plane that the curves are being wrapped from or unwrapped to.


Created in NX6.0.0.

License requirements : None

void NXOpen::Features::WrapBuilder::SetAngleTolerance ( double  angleTolerance)

Sets the angle tolerance used to determine the sampling of the curve during processing, and the accuracy of the output.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
angleToleranceangletolerance
void NXOpen::Features::WrapBuilder::SetAssociative ( bool  associative)

Sets the flag that indicates during creation if a feature is to be created or just the curves, true indicates a feature will be created.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
associativeassociative
void NXOpen::Features::WrapBuilder::SetDistanceTolerance ( double  distanceTolerance)

Sets the distance tolerance used to determine the sampling of the curve during processing, and the accuracy of the output.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
distanceTolerancedistancetolerance
void NXOpen::Features::WrapBuilder::SetSpecifyPlane ( NXOpen::Plane plane)

Sets the specified plane that the curves are being wrapped from or unwrapped to.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
planeplane
void NXOpen::Features::WrapBuilder::SetType ( NXOpen::Features::WrapBuilder::Types  type)

Sets the type of operation being performed.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
typetype
NXOpen::Plane* NXOpen::Features::WrapBuilder::SpecifyPlane ( )

Returns the specified plane that the curves are being wrapped from or unwrapped to.


Created in NX6.0.0.

License requirements : None

NXOpen::Features::WrapBuilder::Types NXOpen::Features::WrapBuilder::Type ( )

Returns the type of operation being performed.


Created in NX6.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.