NX Open C++ Reference Guide
Public Member Functions
NXOpen::SketchPatternBuilder Class Reference

Represents a SketchPatternBuilder
To create a new instance of this class, use SketchCollection::CreateSketchPatternBuilder
Default values. More...

Inheritance diagram for NXOpen::SketchPatternBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Member Functions

bool CreateSpacingExp ()
 Returns the flag to indicate if a spacing expression needs to be created
Created in NX7.5.0.
bool LockOrientation ()
 Returns the flag to indicate if a spacing expression needs to be created
Created in NX7.5.0.
NXOpen::GeometricUtilities::PatternDefinitionPatternService ()
 Returns the pattern service
Created in NX7.5.0.
NXOpen::SectionSection ()
 Returns the pattern section
Created in NX7.5.0.
void SetCreateSpacingExp (bool createSpacingExp)
 Sets the flag to indicate if a spacing expression needs to be created
Created in NX7.5.0.
void SetEndConstraint (NXOpen::NXObject *parent, int inx, bool isStart, bool constraint)
 This function removes end constraint from the given pattern
Created in NX7.5.0.
void SetLockOrientation (bool lockOrientation)
 Sets the flag to indicate if a spacing expression needs to be created
Created in NX7.5.0.

Detailed Description

Represents a SketchPatternBuilder
To create a new instance of this class, use SketchCollection::CreateSketchPatternBuilder
Default values.

Property Value

CreateSpacingExp

True

LockOrientation

True

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.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.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 NX7.5.0.


Member Function Documentation

Returns the flag to indicate if a spacing expression needs to be created
Created in NX7.5.0.



License requirements : None

Returns the flag to indicate if a spacing expression needs to be created
Created in NX7.5.0.



License requirements : None

Returns the pattern service
Created in NX7.5.0.



License requirements : None

Returns the pattern section
Created in NX7.5.0.



License requirements : None

void NXOpen::SketchPatternBuilder::SetCreateSpacingExp ( bool  createSpacingExp)

Sets the flag to indicate if a spacing expression needs to be created
Created in NX7.5.0.



License requirements : None

Parameters:
createSpacingExpcreatespacingexp
void NXOpen::SketchPatternBuilder::SetEndConstraint ( NXOpen::NXObject parent,
int  inx,
bool  isStart,
bool  constraint 
)

This function removes end constraint from the given pattern
Created in NX7.5.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
parentParent object in base chain
inxIndex of the pattern - starts from 0
isStartTRUE, if we want to remove the start end con
constraintTRUE to add the con, false to remove
void NXOpen::SketchPatternBuilder::SetLockOrientation ( bool  lockOrientation)

Sets the flag to indicate if a spacing expression needs to be created
Created in NX7.5.0.



License requirements : None

Parameters:
lockOrientationlockorientation

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