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

Represents a builder for a pattern face feature, post NX9. More...

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

Public Member Functions

bool CopyChamferLabels ()
 Returns the chamfer label options . More...
 
NXOpen::ScCollectorFaceCollector ()
 Returns the face collector. More...
 
NXOpen::GeometricUtilities::PatternDefinitionPatternDefinition ()
 Returns the pattern definition service. More...
 
NXOpen::GeometricUtilities::PatternReferencePointServiceBuilderReferencePoint ()
 Returns the reference point service. More...
 
void SetCopyChamferLabels (bool shouldLabelChamfer)
 Sets the chamfer label options . 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 builder for a pattern face feature, post NX9.


To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreatePatternFaceFeatureBuilder
Default values.

Property Value

CopyChamferLabels

false

PatternDefinition.AlongPathDefinition.XOnPathSpacing.NCopies.Value

2

PatternDefinition.AlongPathDefinition.XOnPathSpacing.SpaceType

Offset

PatternDefinition.AlongPathDefinition.XPathOption

Offset

PatternDefinition.AlongPathDefinition.YDirectionOption

Section

PatternDefinition.AlongPathDefinition.YOnPathSpacing.NCopies.Value

1

PatternDefinition.AlongPathDefinition.YPathOption

Offset

PatternDefinition.AlongPathDefinition.YSpacing.NCopies.Value

1

PatternDefinition.AlongPathDefinition.YSpacing.PitchDistance.Value

10 (millimeters part), 1 (inches part)

PatternDefinition.AlongPathDefinition.YSpacing.SpaceType

Offset

PatternDefinition.AlongPathDefinition.YSpacing.SpanDistance.Value

100 (millimeters part), 10 (inches part)

PatternDefinition.CircularDefinition.AngularSpacing.NCopies.Value

12

PatternDefinition.CircularDefinition.AngularSpacing.PitchAngle.Value

30

PatternDefinition.CircularDefinition.AngularSpacing.PitchDistance.Value

10 (millimeters part), 1 (inches part)

PatternDefinition.CircularDefinition.AngularSpacing.SpaceType

Offset

PatternDefinition.CircularDefinition.AngularSpacing.SpanAngle.Value

360 (millimeters part), 360 (inches part)

PatternDefinition.CircularDefinition.AngularSpacing.UsePitchOption

Angle

PatternDefinition.CircularDefinition.CreateLastStaggered

true

PatternDefinition.CircularDefinition.HorizontalRef.RotationAngle.Value

0 (millimeters part), 0 (inches part)

PatternDefinition.CircularDefinition.IncludeSeedToggle

true

PatternDefinition.CircularDefinition.RadialSpacing.NCopies.Value

1

PatternDefinition.CircularDefinition.StaggerType

None

PatternDefinition.HelixDefinition.AnglePitch.Value

30

PatternDefinition.HelixDefinition.CountOfInstances.Value

6

PatternDefinition.HelixDefinition.DirectionType

Righthand

PatternDefinition.HelixDefinition.DistancePitch.Value

10 (millimeters part), 0.4 (inches part)

PatternDefinition.HelixDefinition.HelixPitch.Value

50 (millimeters part), 2 (inches part)

PatternDefinition.HelixDefinition.HelixSpan.Value

100 (millimeters part), 4 (inches part)

PatternDefinition.HelixDefinition.NumberOfTurns.Value

2

PatternDefinition.HelixDefinition.SizeOption

CountAngleDistance

PatternDefinition.PatternFill.FillMargin.Value

0 (millimeters part), 0 (inches part)

PatternDefinition.PatternFill.FillOptions

None

PatternDefinition.PatternFill.SimplifiedBoundaryToggle

False

PatternDefinition.PatternOrientation.AlongOrientationOption

NormalToPath

PatternDefinition.PatternOrientation.CircularOrientationOption

FollowPattern

PatternDefinition.PatternOrientation.FollowFaceProjDirOption

PatternPlaneNormal

PatternDefinition.PatternOrientation.GeneralOrientationOption

Fixed

PatternDefinition.PatternOrientation.HelixOrientationOption

FollowPattern

PatternDefinition.PatternOrientation.LinearOrientationOption

Fixed

PatternDefinition.PatternOrientation.MirrorOrientationOption

FollowPattern

PatternDefinition.PatternOrientation.OrientationOption

Fixed

PatternDefinition.PatternOrientation.PolygonOrientationOption

FollowPattern

PatternDefinition.PatternOrientation.SpiralOrientationOption

FollowPattern

PatternDefinition.PatternType

Linear

PatternDefinition.PolygonDefinition.NumberOfSides.Value

6

PatternDefinition.PolygonDefinition.PolygonSizeOption

Inscribed

PatternDefinition.PolygonDefinition.PolygonSpacing.NCopies.Value

4

PatternDefinition.PolygonDefinition.PolygonSpacing.PitchDistance.Value

25 (millimeters part), 1 (inches part)

PatternDefinition.PolygonDefinition.PolygonSpacing.SpaceType

Offset

PatternDefinition.PolygonDefinition.PolygonSpacing.SpanAngle.Value

360

PatternDefinition.PolygonDefinition.RadialSpacing.NCopies.Value

1

PatternDefinition.PolygonDefinition.RadialSpacing.PitchDistance.Value

25 (millimeters part), 1 (inches part)

PatternDefinition.PolygonDefinition.RadialSpacing.SpanDistance.Value

100 (millimeters part), 4 (inches part)

PatternDefinition.RectangularDefinition.CreateLastStaggered

true

PatternDefinition.RectangularDefinition.SimplifiedLayoutType

Square

PatternDefinition.RectangularDefinition.StaggerType

None

PatternDefinition.RectangularDefinition.XSpacing.NCopies.Value

2

PatternDefinition.RectangularDefinition.YSpacing.NCopies.Value

1

PatternDefinition.SpiralDefinition.DirectionType

Lefthand

PatternDefinition.SpiralDefinition.NumberOfTurns.Value

1 (millimeters part), 1 (inches part)

PatternDefinition.SpiralDefinition.RadialPitch.Value

50 (millimeters part), 2 (inches part)

PatternDefinition.SpiralDefinition.SizeSpiralType

NumberOfTurns

PatternDefinition.SpiralDefinition.TotalAngle.Value

360 (millimeters part), 360 (inches part)


Created in NX9.0.0.

Member Function Documentation

bool NXOpen::Features::PatternFaceFeatureBuilder::CopyChamferLabels ( )

Returns the chamfer label options .

'true' if the chamfer faces should be labeled automatically 'false' if the chamfer faces should not be labeled automatically
Created in NX9.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::PatternFaceFeatureBuilder::FaceCollector ( )

Returns the face collector.

Collects the input faces to pattern
Created in NX9.0.0.

License requirements : None

NXOpen::GeometricUtilities::PatternDefinition* NXOpen::Features::PatternFaceFeatureBuilder::PatternDefinition ( )

Returns the pattern definition service.

This is the object that determines the type of pattern and holds the associated data that comes with it.
Created in NX9.0.0.

License requirements : None

NXOpen::GeometricUtilities::PatternReferencePointServiceBuilder* NXOpen::Features::PatternFaceFeatureBuilder::ReferencePoint ( )

Returns the reference point service.

This contains the origin for creating pattern based transformations
Created in NX9.0.0.

License requirements : None

void NXOpen::Features::PatternFaceFeatureBuilder::SetCopyChamferLabels ( bool  shouldLabelChamfer)

Sets the chamfer label options .

'true' if the chamfer faces should be labeled automatically 'false' if the chamfer faces should not be labeled automatically
Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
shouldLabelChamfershouldlabelchamfer

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