GeomcopyBuilder Class¶
-
class
NXOpen.Features.
GeomcopyBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.Geomcopy
builderTo create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateGeomcopyBuilder
Default values.
Property Value Associative True CopyThreads True CsysMirrorOption MirrorYAndZ FillPathLength FillPathLength New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
AlongPathAngle | Returns the angle dimension used for along path type of instancing. |
Associative | Returns or sets the associative, a logical flag to indicate if the copies are associative. |
BetweenLocations | Returns the between locations data for between locations type of the transformation. |
CopyThreads | Returns or sets the copy threads option |
CsysMirrorOption | Returns or sets the Alternate Datum CSYS mirror method option |
FillPathLength | Returns or sets the fill path length, a distance option for along path type of instancing. |
GeometryToInstance | Returns the selected object list of geometry to instance. |
HideOriginal | Returns or sets the hide original |
MirrorPlane | Returns or sets the mirror plane for mirror type of instancing. |
NumberOfCopies | Returns the number of copies to make for the geometry to instance. |
OnPathDistance | Returns the onpath distance dimension used for along path type of instancing. |
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
PatchSolutionFlag | Returns or sets the patch solution flag |
PatchSurfaceFilename | Returns or sets the patch surface filename |
Path | Returns or sets the section path for along path type of instancing. |
RotateAngle | Returns the angle dimension used for rotation type of instancing. |
RotateDistance | Returns the distance dimension used for rotation type of instancing. |
RotationAxis | Returns or sets the rotation axis for rotation type of instancing. |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
TranslateDistance | Returns the distance dimension used for translation type of instancing. |
TranslationVector | Returns or sets the translation vector for translation type of instancing. |
Type | Returns or sets the transformation type of instancing, such as Between Locations, or Mirror. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature @return |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetFeature | Returns the feature currently being edited by this builder. |
GetObject | Returns the object currently being edited by this builder. |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
GeomcopyBuilderAlongPathDistanceOptions Enumeration | along path distance options |
GeomcopyBuilderCsysMirrorOptions Enumeration | CSYS mirror options |
GeomcopyBuilderTransformTypes Enumeration | user input transform types. |
Property Detail¶
AlongPathAngle¶
-
GeomcopyBuilder.
AlongPathAngle
¶ Returns the angle dimension used for along path type of instancing.
-------------------------------------
Getter Method
Signature
AlongPathAngle()
Returns: Return type: NXOpen.Expression
New in version NX5.0.0.
License requirements: None.
Associative¶
-
GeomcopyBuilder.
Associative
¶ Returns or sets the associative, a logical flag to indicate if the copies are associative.
-------------------------------------
Getter Method
Signature
Associative()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Associative(associative)
Parameters: associative (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
BetweenLocations¶
-
GeomcopyBuilder.
BetweenLocations
¶ Returns the between locations data for between locations type of the transformation.
-------------------------------------
Getter Method
Signature
BetweenLocations()
Returns: Return type: NXOpen.GeometricUtilities.BetweenLocationsData
New in version NX5.0.0.
License requirements: None.
CopyThreads¶
-
GeomcopyBuilder.
CopyThreads
¶ Returns or sets the copy threads option
-------------------------------------
Getter Method
Signature
CopyThreads()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CopyThreads(copyThreads)
Parameters: copyThreads (bool) – New in version NX8.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
CsysMirrorOption¶
-
GeomcopyBuilder.
CsysMirrorOption
¶ Returns or sets the Alternate Datum CSYS mirror method option
-------------------------------------
Getter Method
Signature
CsysMirrorOption()
Returns: Return type: NXOpen.Features.GeomcopyBuilderCsysMirrorOptions
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CsysMirrorOption(csysMirrorOption)
Parameters: csysMirrorOption ( NXOpen.Features.GeomcopyBuilderCsysMirrorOptions
) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
FillPathLength¶
-
GeomcopyBuilder.
FillPathLength
¶ Returns or sets the fill path length, a distance option for along path type of instancing.
-------------------------------------
Getter Method
Signature
FillPathLength()
Returns: Return type: NXOpen.Features.GeomcopyBuilderAlongPathDistanceOptions
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FillPathLength(fillPathLength)
Parameters: fillPathLength ( NXOpen.Features.GeomcopyBuilderAlongPathDistanceOptions
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
GeometryToInstance¶
-
GeomcopyBuilder.
GeometryToInstance
¶ Returns the selected object list of geometry to instance.
-------------------------------------
Getter Method
Signature
GeometryToInstance()
Returns: Return type: NXOpen.SelectObjectList
New in version NX5.0.0.
License requirements: None.
HideOriginal¶
-
GeomcopyBuilder.
HideOriginal
¶ Returns or sets the hide original
-------------------------------------
Getter Method
Signature
HideOriginal()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HideOriginal(hideOriginal)
Parameters: hideOriginal (bool) – New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
MirrorPlane¶
-
GeomcopyBuilder.
MirrorPlane
¶ Returns or sets the mirror plane for mirror type of instancing.
-------------------------------------
Getter Method
Signature
MirrorPlane()
Returns: Return type: NXOpen.Plane
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MirrorPlane(mirrorPlane)
Parameters: mirrorPlane ( NXOpen.Plane
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
NumberOfCopies¶
-
GeomcopyBuilder.
NumberOfCopies
¶ Returns the number of copies to make for the geometry to instance.
-------------------------------------
Getter Method
Signature
NumberOfCopies()
Returns: Return type: NXOpen.Expression
New in version NX5.0.0.
License requirements: None.
OnPathDistance¶
-
GeomcopyBuilder.
OnPathDistance
¶ Returns the onpath distance dimension used for along path type of instancing.
-------------------------------------
Getter Method
Signature
OnPathDistance()
Returns: Return type: NXOpen.GeometricUtilities.OnPathDimensionBuilder
New in version NX5.0.0.
License requirements: None.
Path¶
-
GeomcopyBuilder.
Path
¶ Returns or sets the section path for along path type of instancing.
-------------------------------------
Getter Method
Signature
Path()
Returns: Return type: NXOpen.Section
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Path(path)
Parameters: path ( NXOpen.Section
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
RotateAngle¶
-
GeomcopyBuilder.
RotateAngle
¶ Returns the angle dimension used for rotation type of instancing.
-------------------------------------
Getter Method
Signature
RotateAngle()
Returns: Return type: NXOpen.Expression
New in version NX5.0.0.
License requirements: None.
RotateDistance¶
-
GeomcopyBuilder.
RotateDistance
¶ Returns the distance dimension used for rotation type of instancing.
-------------------------------------
Getter Method
Signature
RotateDistance()
Returns: Return type: NXOpen.Expression
New in version NX5.0.0.
License requirements: None.
RotationAxis¶
-
GeomcopyBuilder.
RotationAxis
¶ Returns or sets the rotation axis for rotation type of instancing.
-------------------------------------
Getter Method
Signature
RotationAxis()
Returns: Return type: NXOpen.Axis
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RotationAxis(rotationAxis)
Parameters: rotationAxis ( NXOpen.Axis
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
TranslateDistance¶
-
GeomcopyBuilder.
TranslateDistance
¶ Returns the distance dimension used for translation type of instancing.
-------------------------------------
Getter Method
Signature
TranslateDistance()
Returns: Return type: NXOpen.Expression
New in version NX5.0.0.
License requirements: None.
TranslationVector¶
-
GeomcopyBuilder.
TranslationVector
¶ Returns or sets the translation vector for translation type of instancing.
-------------------------------------
Getter Method
Signature
TranslationVector()
Returns: Return type: NXOpen.Direction
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TranslationVector(translationVector)
Parameters: translationVector ( NXOpen.Direction
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Type¶
-
GeomcopyBuilder.
Type
¶ Returns or sets the transformation type of instancing, such as Between Locations, or Mirror.
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Features.GeomcopyBuilderTransformTypes
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(transformType)
Parameters: transformType ( NXOpen.Features.GeomcopyBuilderTransformTypes
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Method Detail¶
Validate¶
-
GeomcopyBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.