Represents a builder class Assemblies::ComponentPatternBuilder that performs various component pattern operations. More...

Inheritance diagram for NXOpen::Assemblies::ComponentPatternBuilder:

Public Member Functions
bool	Associative ()
	Returns the associative toggle value which determines whether the component pattern is associative or not.

NXOpen::SelectDisplayableObjectList *	ComponentPatternSet ()
	Returns the selected component objects list.

bool	GetDynamicPositioning ()
	The dynamic positioning toggle is used for dynamic update of component pattern.It will enable or disable the dynamic preview of the components.When toggle is disabled, only the dots provided by the pattern service will be previewed.

NXOpen::GeometricUtilities::PatternDefinition *	PatternService ()
	Returns the pattern definition service object.

void	SetAssociative (bool isAssociative)
	Sets the associative toggle value which determines whether the component pattern is associative or not.

void	SetDynamicPositioning (bool isDynamicPositioning)
	The dynamic positioning toggle value to enable/disable the dynamic preview of the components.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a builder class Assemblies::ComponentPatternBuilder that performs various component pattern operations.

 <br> To create a new instance of this class, use @link Assemblies::ComponentAssembly::CreateComponentPatternBuilder  Assemblies::ComponentAssembly::CreateComponentPatternBuilder @endlink  <br>

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 (deprecated)

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 associative toggle value which determines whether the component pattern is associative or not.

       By default, it will be ON.

Created in NX9.0.0.

License requirements : None

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

Returns the selected component objects list.

Created in NX9.0.0.

License requirements : None

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

The dynamic positioning toggle is used for dynamic update of component pattern.It will enable or disable the dynamic preview of the components.When toggle is disabled, only the dots provided by the pattern service will be previewed.

     @return

Created in NX9.0.0.

License requirements : None

NXOpen::GeometricUtilities::PatternDefinition* NXOpen::Assemblies::ComponentPatternBuilder::PatternService ( )

Returns the pattern definition service object.

Created in NX9.0.0.

License requirements : None

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

Sets the associative toggle value which determines whether the component pattern is associative or not.

       By default, it will be ON.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

isAssociative isassociative

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

The dynamic positioning toggle value to enable/disable the dynamic preview of the components.

Created in NX9.0.0.

License requirements : assemblies ("ASSEMBLIES MODULE")

Parameters

isDynamicPositioning isdynamicpositioning

The documentation for this class was generated from the following file:

Assemblies_ComponentPatternBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation