NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::MirrorBuilder Class Reference

Represents a Features::Mirror builder
To create a new instance of this class, use Features::FeatureCollection::CreateMirrorBuilder
Default values. More...

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

List of all members.

Public Types

enum  CsysMirrorOptions { CsysMirrorOptionsMirrorXAndY, CsysMirrorOptionsMirrorYAndZ, CsysMirrorOptionsMirrorZAndX }
 the Coordinate System mirror options More...

Public Member Functions

void ClearReferencesToReuse ()
 Clears all the existing references to reuse so that new references can be added
Created in NX8.0.1.
NXOpen::Features::MirrorBuilder::CsysMirrorOptions CsysMirrorOption ()
 Returns the Coordinate System mirroring option
Created in NX8.0.1.
NXOpen::Features::SelectFeatureListFeatureList ()
 Returns the Features to Mirror
Created in NX8.0.1.
bool MaintainHelixHandedness ()
 Returns the option to maintain Helix feature handedness.
bool MaintainThreadHandedness ()
 Returns the option to maintain symbolic thread handedness.
NXOpen::GeometricUtilities::PatternDefinitionPatternService ()
 Returns the GeometricUtilities::PatternDefinition object
Created in NX8.0.1.
NXOpen::PointReferencePoint ()
 Returns the reference point
Created in NX8.0.1.
void SetCsysMirrorOption (NXOpen::Features::MirrorBuilder::CsysMirrorOptions csysOption)
 Sets the Coordinate System mirroring option
Created in NX8.0.1.
void SetMaintainHelixHandedness (bool maintainHelixHandedness)
 Sets the option to maintain Helix feature handedness.
void SetMaintainThreadHandedness (bool maintainThreadHandedness)
 Sets the option to maintain symbolic thread handedness.
void SetReferencePoint (NXOpen::Point *referencePoint)
 Sets the reference point
Created in NX8.0.1.
void SetReferencesToReuse (NXOpen::Features::Feature *inputFeature, const std::vector< NXOpen::NXObject * > &referencesFromInputFeatures)
 Sets the references or selections from the input features which are to be reused for mirror.
void SetUseInferredReferencePoint (bool useInferredReferencePoint)
 Sets a flag to indicate whether to use reference point inferred from selected feature(s) or not.
bool UseInferredReferencePoint ()
 Returns a flag to indicate whether to use reference point inferred from selected feature(s) or not.

Detailed Description

Represents a Features::Mirror builder
To create a new instance of this class, use Features::FeatureCollection::CreateMirrorBuilder
Default values.

Property Value

CsysMirrorOption

MirrorYAndZ

MaintainHelixHandedness

True

MaintainThreadHandedness

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)

UseInferredReferencePoint

True


Created in NX8.0.1.


Member Enumeration Documentation

the Coordinate System mirror options

Enumerator:
CsysMirrorOptionsMirrorXAndY 

Mirror X and Y and derive Z.

CsysMirrorOptionsMirrorYAndZ 

Mirror Y and Z and derive X.

CsysMirrorOptionsMirrorZAndX 

Mirror X and Z and derive Y.


Member Function Documentation

Clears all the existing references to reuse so that new references can be added
Created in NX8.0.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Returns the Coordinate System mirroring option
Created in NX8.0.1.



License requirements : None

Returns the Features to Mirror
Created in NX8.0.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Returns the option to maintain Helix feature handedness.

If 'true', right-handed Helix will be mirrored as right-handed, and left-handed Helix will be mirrored as left-handed. If 'false', right-handed Helix will be mirrored as left-handed, and left-handed Helix will be mirrored as right-handed.
Created in NX8.0.1.

License requirements : None

Returns the option to maintain symbolic thread handedness.

If 'true', right-handed threads will be mirrored as right-handed, and left-handed threads will be mirrored as left-handed. If 'false', right-handed threads will be mirrored as left-handed, and left-handed threads will be mirrored as right-handed.
Created in NX8.0.1.

License requirements : None

Returns the GeometricUtilities::PatternDefinition object
Created in NX8.0.1.



License requirements : None

Returns the reference point
Created in NX8.0.1.



License requirements : None

Sets the Coordinate System mirroring option
Created in NX8.0.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
csysOptioncsysoption
void NXOpen::Features::MirrorBuilder::SetMaintainHelixHandedness ( bool  maintainHelixHandedness)

Sets the option to maintain Helix feature handedness.

If 'true', right-handed Helix will be mirrored as right-handed, and left-handed Helix will be mirrored as left-handed. If 'false', right-handed Helix will be mirrored as left-handed, and left-handed Helix will be mirrored as right-handed.
Created in NX8.0.1.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
maintainHelixHandednessmaintainhelixhandedness
void NXOpen::Features::MirrorBuilder::SetMaintainThreadHandedness ( bool  maintainThreadHandedness)

Sets the option to maintain symbolic thread handedness.

If 'true', right-handed threads will be mirrored as right-handed, and left-handed threads will be mirrored as left-handed. If 'false', right-handed threads will be mirrored as left-handed, and left-handed threads will be mirrored as right-handed.
Created in NX8.0.1.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
maintainThreadHandednessmaintainthreadhandedness

Sets the reference point
Created in NX8.0.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
referencePointreferencepoint
void NXOpen::Features::MirrorBuilder::SetReferencesToReuse ( NXOpen::Features::Feature inputFeature,
const std::vector< NXOpen::NXObject * > &  referencesFromInputFeatures 
)

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

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

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
inputFeatureinputfeature
referencesFromInputFeaturesreferencesfrominputfeatures
void NXOpen::Features::MirrorBuilder::SetUseInferredReferencePoint ( bool  useInferredReferencePoint)

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.1.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
useInferredReferencePointuseinferredreferencepoint

Returns 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.1.

License requirements : None


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