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

Represents a builder class that performs various NXOpen::Assemblies::ComponentPattern operations. More...

Inheritance diagram for NXOpen::Assemblies::ComponentPatternBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool Associative ()
 Returns the option to specify whether the NXOpen::Assemblies::ComponentPattern is associative or not. More...
 
NXOpen::SelectDisplayableObjectListComponentPatternSet ()
 Returns the NXOpen::Assemblies::Component for pattern. More...
 
bool CopyConstraintPattern ()
 Returns the copy constraint option. More...
 
bool GetDynamicPositioning ()
 Returns the dynamic positioning flag. More...
 
NXOpen::GeometricUtilities::PatternDefinitionPatternService ()
 Returns the NXOpen::GeometricUtilities::PatternDefinition . More...
 
void SetAssociative (bool isAssociative)
 Sets the option to specify whether the NXOpen::Assemblies::ComponentPattern is associative or not. More...
 
void SetCopyConstraintPattern (bool isCopyConstraintReferencePattern)
 Sets the copy constraint option. More...
 
void SetDynamicPositioning (bool isDynamicPositioning)
 Sets the dynamic positioning flag. More...
 
void SetObject (NXOpen::Assemblies::ComponentPattern *compPattern)
 Sets the object selected for pattern definition
Created in NX11.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 class that performs various NXOpen::Assemblies::ComponentPattern operations.

Input to this class can be PSM facet objects.
To create a new instance of this class, use NXOpen::Assemblies::ComponentAssembly::CreateComponentPatternBuilder
Default values.

Property Value

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)


Created in NX9.0.0.

Member Function Documentation

bool NXOpen::Assemblies::ComponentPatternBuilder::Associative ( )

Returns the option to specify whether the NXOpen::Assemblies::ComponentPattern is associative or not.


Created in NX9.0.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Assemblies::ComponentPatternBuilder::ComponentPatternSet ( )

Returns the NXOpen::Assemblies::Component for pattern.


Created in NX9.0.0.

License requirements : None

bool NXOpen::Assemblies::ComponentPatternBuilder::CopyConstraintPattern ( )

Returns the copy constraint option.

The copy constraint type of pattern is created when this option is enabled otherwise Pure Reference pattern is created.


Created in NX9.0.1.

License requirements : None

bool NXOpen::Assemblies::ComponentPatternBuilder::GetDynamicPositioning ( )

Returns the dynamic positioning flag.

Returns

Created in NX9.0.0.

License requirements : None
NXOpen::GeometricUtilities::PatternDefinition* NXOpen::Assemblies::ComponentPatternBuilder::PatternService ( )

Returns the NXOpen::GeometricUtilities::PatternDefinition .


Created in NX9.0.0.

License requirements : None

void NXOpen::Assemblies::ComponentPatternBuilder::SetAssociative ( bool  isAssociative)

Sets the option to specify whether the NXOpen::Assemblies::ComponentPattern is associative or not.


Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
isAssociativeisassociative
void NXOpen::Assemblies::ComponentPatternBuilder::SetCopyConstraintPattern ( bool  isCopyConstraintReferencePattern)

Sets the copy constraint option.

The copy constraint type of pattern is created when this option is enabled otherwise Pure Reference pattern is created.


Created in NX9.0.1.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
isCopyConstraintReferencePatterniscopyconstraintreferencepattern
void NXOpen::Assemblies::ComponentPatternBuilder::SetDynamicPositioning ( bool  isDynamicPositioning)

Sets the dynamic positioning flag.

It will enable or disable the dynamic preview of the components.


Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
isDynamicPositioningisdynamicpositioning
void NXOpen::Assemblies::ComponentPatternBuilder::SetObject ( NXOpen::Assemblies::ComponentPattern compPattern)

Sets the object selected for pattern definition
Created in NX11.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters
compPatternThe pattern definition object

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