NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Features.PatternFeatureBuilder Class Reference

Represents a NXOpen.Features.PatternFeature builder More...

Inheritance diagram for NXOpen.Features.PatternFeatureBuilder:
NXOpen.Features.FeatureBuilder NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  ExpressionTransferOptions { CreateNew, LinkToOriginal, OriginalInstance }
 the Expression transfer options. More...
 
enum  OutputOptions { PatternFeature, CopiesOfInputFeatures, CopiesOfInputFeaturesInGroup }
 the Output options. More...
 
enum  PatternMethodOptions { Variational = 1, Simple }
 the Pattern method options. More...
 

Public Member Functions

unsafe void ClearReferencesToReuse ()
 Clears all the existing references to reuse so that new references can be added More...
 
unsafe void RemoveAllClocking ()
 Removes clocking from (unclocks) all instances of the NXOpen.Features.PatternFeature . More...
 
unsafe void SetReferencesToReuse (NXOpen.Features.Feature inputFeature, NXOpen.NXObject[] referencesFromInputFeatures)
 Sets the references or selections from the input features which are to be reused for all instances. More...
 
- Public Member Functions inherited from NXOpen.Features.FeatureBuilder
unsafe NXOpen.Features.Feature CommitFeature ()
 Commits the feature parameters and creates the feature More...
 
unsafe NXOpen.Features.Feature GetFeature ()
 Returns the feature currently being edited by this builder. More...
 
unsafe void HideInternalParentFeatureAfterEdit (NXOpen.Features.Feature parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
unsafe void SetParentFeatureInternal (NXOpen.Features.Feature parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited More...
 
unsafe void ShowInternalParentFeatureForEdit (NXOpen.Features.Feature parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
unsafe void UnsetParentFeatureInternal (NXOpen.Features.Feature parentFeature)
 Set the internal parent feature of the feature being edited to external More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe bool CreateReferencePattern [get, set]
 Returns or sets the Create Reference Pattern option More...
 
unsafe
NXOpen.Features.PatternFeatureBuilder.ExpressionTransferOptions 
ExpressionOption [get, set]
 Returns or sets the expression transfer option More...
 
unsafe
NXOpen.Features.SelectFeatureList 
FeatureList [get]
 Returns the Features More...
 
unsafe
NXOpen.Features.PatternFeatureBuilder.OutputOptions 
OutputOption [get, set]
 Returns or sets the output option More...
 
unsafe
NXOpen.Features.PatternFeatureBuilder.PatternMethodOptions 
PatternMethod [get, set]
 Returns or sets the Pattern method More...
 
unsafe
NXOpen.GeometricUtilities.PatternDefinition 
PatternService [get]
 Returns the Pattern definition service More...
 
unsafe NXOpen.Point ReferencePoint [get, set]
 Returns or sets the reference point More...
 
unsafe
NXOpen.GeometricUtilities.PatternReferencePointServiceBuilder 
ReferencePointService [get]
 Returns the reference point service More...
 
unsafe bool UseInferredReferencePoint [get, set]
 Returns or sets a flag to indicate whether to use reference point inferred from selected feature(s) or not. More...
 
- Properties inherited from NXOpen.Features.FeatureBuilder
unsafe bool ParentFeatureInternal [get, set]
 Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Features.PatternFeature builder

To create a new instance of this class, use NXOpen.Features.FeatureCollection.CreatePatternFeatureBuilder

Default values.

Property Value

CreateReferencePattern

True

ExpressionOption

CreateNew

OutputOption

PatternFeature

PatternMethod

Variational

PatternService.AlongPathDefinition.XOnPathSpacing.NCopies.Value

2

PatternService.AlongPathDefinition.XOnPathSpacing.SpaceType

Offset

PatternService.AlongPathDefinition.XPathOption

Offset

PatternService.AlongPathDefinition.YDirectionOption

Section

PatternService.AlongPathDefinition.YOnPathSpacing.NCopies.Value

1

PatternService.AlongPathDefinition.YPathOption

Offset

PatternService.AlongPathDefinition.YSpacing.NCopies.Value

1

PatternService.AlongPathDefinition.YSpacing.PitchDistance.Value

10 (millimeters part), 1 (inches part)

PatternService.AlongPathDefinition.YSpacing.SpaceType

Offset

PatternService.AlongPathDefinition.YSpacing.SpanDistance.Value

100 (millimeters part), 10 (inches part)

PatternService.CircularDefinition.AngularSpacing.NCopies.Value

12

PatternService.CircularDefinition.AngularSpacing.PitchAngle.Value

30

PatternService.CircularDefinition.AngularSpacing.PitchDistance.Value

10 (millimeters part), 1 (inches part)

PatternService.CircularDefinition.AngularSpacing.SpaceType

Offset

PatternService.CircularDefinition.AngularSpacing.SpanAngle.Value

360 (millimeters part), 360 (inches part)

PatternService.CircularDefinition.AngularSpacing.UsePitchOption

Angle

PatternService.CircularDefinition.CreateLastStaggered

true

PatternService.CircularDefinition.HorizontalRef.RotationAngle.Value

0 (millimeters part), 0 (inches part)

PatternService.CircularDefinition.IncludeSeedToggle

true

PatternService.CircularDefinition.RadialSpacing.NCopies.Value

1

PatternService.CircularDefinition.StaggerType

None

PatternService.HelixDefinition.AnglePitch.Value

30

PatternService.HelixDefinition.CountOfInstances.Value

6

PatternService.HelixDefinition.DirectionType

Righthand

PatternService.HelixDefinition.DistancePitch.Value

10 (millimeters part), 0.4 (inches part)

PatternService.HelixDefinition.HelixPitch.Value

50 (millimeters part), 2 (inches part)

PatternService.HelixDefinition.HelixSpan.Value

100 (millimeters part), 4 (inches part)

PatternService.HelixDefinition.NumberOfTurns.Value

2

PatternService.HelixDefinition.SizeOption

CountAngleDistance

PatternService.PatternFill.FillMargin.Value

0 (millimeters part), 0 (inches part)

PatternService.PatternFill.FillOptions

None

PatternService.PatternFill.SimplifiedBoundaryToggle

False

PatternService.PatternOrientation.AlongOrientationOption

NormalToPath

PatternService.PatternOrientation.CircularOrientationOption

FollowPattern

PatternService.PatternOrientation.FollowFaceProjDirOption

PatternPlaneNormal

PatternService.PatternOrientation.GeneralOrientationOption

Fixed

PatternService.PatternOrientation.HelixOrientationOption

FollowPattern

PatternService.PatternOrientation.LinearOrientationOption

Fixed

PatternService.PatternOrientation.MirrorOrientationOption

FollowPattern

PatternService.PatternOrientation.OrientationOption

Fixed

PatternService.PatternOrientation.PolygonOrientationOption

FollowPattern

PatternService.PatternOrientation.SpiralOrientationOption

FollowPattern

PatternService.PatternType

Linear

PatternService.PolygonDefinition.NumberOfSides.Value

6

PatternService.PolygonDefinition.PolygonSizeOption

Inscribed

PatternService.PolygonDefinition.PolygonSpacing.NCopies.Value

4

PatternService.PolygonDefinition.PolygonSpacing.PitchDistance.Value

25 (millimeters part), 1 (inches part)

PatternService.PolygonDefinition.PolygonSpacing.SpaceType

Offset

PatternService.PolygonDefinition.PolygonSpacing.SpanAngle.Value

360

PatternService.PolygonDefinition.RadialSpacing.NCopies.Value

1

PatternService.PolygonDefinition.RadialSpacing.PitchDistance.Value

25 (millimeters part), 1 (inches part)

PatternService.PolygonDefinition.RadialSpacing.SpanDistance.Value

100 (millimeters part), 4 (inches part)

PatternService.RectangularDefinition.CreateLastStaggered

true

PatternService.RectangularDefinition.SimplifiedLayoutType

Square

PatternService.RectangularDefinition.StaggerType

None

PatternService.RectangularDefinition.XSpacing.NCopies.Value

2

PatternService.RectangularDefinition.YSpacing.NCopies.Value

1

PatternService.SpiralDefinition.DirectionType

Lefthand

PatternService.SpiralDefinition.NumberOfTurns.Value

1 (millimeters part), 1 (inches part)

PatternService.SpiralDefinition.RadialPitch.Value

50 (millimeters part), 2 (inches part)

PatternService.SpiralDefinition.SizeSpiralType

NumberOfTurns

PatternService.SpiralDefinition.TotalAngle.Value

360 (millimeters part), 360 (inches part)

UseInferredReferencePoint (deprecated)

True

Created in NX7.5.0

Member Enumeration Documentation

the Expression transfer options.

Enumerator
CreateNew 

New

LinkToOriginal 

Link to Original

OriginalInstance 

Instance of Original

the Output options.

Enumerator
PatternFeature 

Pattern Feature

CopiesOfInputFeatures 

Copies of Input features

CopiesOfInputFeaturesInGroup 

Copies of Input features in Group

the Pattern method options.

Enumerator
Variational 

variational

Simple 

simple

Member Function Documentation

unsafe void NXOpen.Features.PatternFeatureBuilder.ClearReferencesToReuse ( )
inline

Clears all the existing references to reuse so that new references can be added

Created in NX8.0.0

License requirements: solid_modeling ("SOLIDS MODELING")

unsafe void NXOpen.Features.PatternFeatureBuilder.RemoveAllClocking ( )
inline

Removes clocking from (unclocks) all instances of the NXOpen.Features.PatternFeature .

Created in NX8.0.0

License requirements: solid_modeling ("SOLIDS MODELING")

unsafe void NXOpen.Features.PatternFeatureBuilder.SetReferencesToReuse ( NXOpen.Features.Feature  inputFeature,
NXOpen.NXObject[]  referencesFromInputFeatures 
)
inline

Sets the references or selections from the input features which are to be reused for all instances.

The references for reuse should belong to some input feature which needs to be specified while calling this API.

Created in NX8.0.0

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters
inputFeature
referencesFromInputFeatures

Property Documentation

unsafe bool NXOpen.Features.PatternFeatureBuilder.CreateReferencePattern
getset

Returns or sets the Create Reference Pattern option

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.Features.PatternFeatureBuilder.ExpressionTransferOptions NXOpen.Features.PatternFeatureBuilder.ExpressionOption
getset

Returns or sets the expression transfer option

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.Features.SelectFeatureList NXOpen.Features.PatternFeatureBuilder.FeatureList
get

Returns the Features

Created in NX7.5.0

License requirements: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.Features.PatternFeatureBuilder.OutputOptions NXOpen.Features.PatternFeatureBuilder.OutputOption
getset

Returns or sets the output option

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.Features.PatternFeatureBuilder.PatternMethodOptions NXOpen.Features.PatternFeatureBuilder.PatternMethod
getset

Returns or sets the Pattern method

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.GeometricUtilities.PatternDefinition NXOpen.Features.PatternFeatureBuilder.PatternService
get

Returns the Pattern definition service

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.Point NXOpen.Features.PatternFeatureBuilder.ReferencePoint
getset

Returns or sets the reference point

Created in NX7.5.0

Deprecated in NX9.0.0. Use GeometricUtilities.PatternReferencePointServiceBuilder.Point instead.

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.GeometricUtilities.PatternReferencePointServiceBuilder NXOpen.Features.PatternFeatureBuilder.ReferencePointService
get

Returns the reference point service

Created in NX9.0.0

License requirements: None.

unsafe bool NXOpen.Features.PatternFeatureBuilder.UseInferredReferencePoint
getset

Returns or sets a flag to indicate whether to use reference point inferred from selected feature(s) or not.

If 'true', the reference point will be inferred every time the selected feature(s) get modified or updates. If 'false, the reference point provided will be independent of the selected feature(s) but will be associative to the rule by which it was created (e.g. End of Line, Center of Arc).

Created in NX8.0.0

Deprecated in NX9.0.0. Use GeometricUtilities.PatternReferencePointServiceBuilder.IsReferencePointInferred instead.

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")


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