ReusableObjectPasteBuilder Class¶
-
class
NXOpen.Tooling.
ReusableObjectPasteBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Tooling.ReusableObjectPasteBuilder
Use the
NXOpen.Tooling.ReusableObjectManager
class to create a ReusableObjectPasteBuilder.New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
Associative | Returns or sets the option specifying whether to associate the csys of reuse object to target entity |
DropFace | Returns or sets the drop face required for reattach sketch when using one-pick position method |
DynamicCsysOrientation | Returns or sets the orientation of dynamic csys |
DynamicCsysOrigin | Returns or sets the origin of dynamic csys |
EditFeatureGroup | Returns or sets the feature group created after reuse paste |
ImportedSketch | Returns or sets the imported sketch |
InitialPasteLocation | Returns or sets the initial paste location, this is mainly used to define default paste location of sketch objects |
LibraryName | Returns or sets the library name. |
PasteMethod | Returns or sets the design option to select Boolean operation type |
PatternFeature | Returns or sets the geometry pattern feature |
PatternSketch | Returns or sets the pattern sketch for reusable object |
PositioningFeatSet | Returns the positioning feature set by pattern sketch |
Tag | Returns the Tag for this object. |
TargetBody | Returns or sets the target body required for boolean operation |
TargetFace | Returns or sets the target face required for solid punch |
UseOnePickPositionMethod | Returns or sets the option specifying whether to use one-pick position method for drag/drop |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CreatePatternObjects | Creates the pattern objects |
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. |
GetCreatedObjects | Gets the created objects |
GetObject | Returns the object currently being edited by this builder. |
GetSpreadsheetData | Gets the spreadsheet data @return Spreadsheet data |
LoadPart | Imports given part file to current work part |
RepositionBody | Moves the body to the selected point and orientation |
SetLibraryInformation | Sets library information for the feature |
SetSpreadsheetData | Sets the spreadsheet data |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UpdateLocation | Updates location of reusable object after edit pattern points |
UpdateSpreadsheetData | Updates the spreadsheet data according to the expressions in part |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ReusableObjectPasteBuilderPasteMethods Enumeration | Specifies the design option |
Property Detail¶
Associative¶
-
ReusableObjectPasteBuilder.
Associative
¶ Returns or sets the option specifying whether to associate the csys of reuse object to target entity
-------------------------------------
Getter Method
Signature
Associative()
Returns: Return type: bool New in version NX8.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
Associative(associative)
Parameters: associative (bool) – New in version NX8.0.2.
License requirements: None.
DropFace¶
-
ReusableObjectPasteBuilder.
DropFace
¶ Returns or sets the drop face required for reattach sketch when using one-pick position method
-------------------------------------
Getter Method
Signature
DropFace()
Returns: Drop face Return type: NXOpen.NXObject
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DropFace(face)
Parameters: face ( NXOpen.NXObject
) – Drop faceNew in version NX8.0.0.
License requirements: None.
DynamicCsysOrientation¶
-
ReusableObjectPasteBuilder.
DynamicCsysOrientation
¶ Returns or sets the orientation of dynamic csys
-------------------------------------
Getter Method
Signature
DynamicCsysOrientation()
Returns: Orientation of dynamic csys Return type: NXOpen.Matrix3x3
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DynamicCsysOrientation(orientation)
Parameters: orientation ( NXOpen.Matrix3x3
) – Orientation of dynamic csysNew in version NX8.0.0.
License requirements: None.
DynamicCsysOrigin¶
-
ReusableObjectPasteBuilder.
DynamicCsysOrigin
¶ Returns or sets the origin of dynamic csys
-------------------------------------
Getter Method
Signature
DynamicCsysOrigin()
Returns: Origin of dynamic csys Return type: NXOpen.Point3d
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DynamicCsysOrigin(origin)
Parameters: origin ( NXOpen.Point3d
) – Origin of dynamic csysNew in version NX8.0.0.
License requirements: None.
EditFeatureGroup¶
-
ReusableObjectPasteBuilder.
EditFeatureGroup
¶ Returns or sets the feature group created after reuse paste
-------------------------------------
Getter Method
Signature
EditFeatureGroup()
Returns: Return type: NXOpen.NXObject
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EditFeatureGroup(featureGroup)
Parameters: featureGroup ( NXOpen.NXObject
) –New in version NX8.0.0.
License requirements: None.
ImportedSketch¶
-
ReusableObjectPasteBuilder.
ImportedSketch
¶ Returns or sets the imported sketch
-------------------------------------
Getter Method
Signature
ImportedSketch()
Returns: Imported sketch Return type: NXOpen.NXObject
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ImportedSketch(sketch)
Parameters: sketch ( NXOpen.NXObject
) – Imported sketchNew in version NX8.0.0.
License requirements: None.
InitialPasteLocation¶
-
ReusableObjectPasteBuilder.
InitialPasteLocation
¶ Returns or sets the initial paste location, this is mainly used to define default paste location of sketch objects
-------------------------------------
Getter Method
Signature
InitialPasteLocation()
Returns: Drop location coordinates in absolute Return type: NXOpen.Point3d
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InitialPasteLocation(dropLocation)
Parameters: dropLocation ( NXOpen.Point3d
) – Drop location coordinates in absoluteNew in version NX8.0.0.
License requirements: None.
LibraryName¶
-
ReusableObjectPasteBuilder.
LibraryName
¶ Returns or sets the library name.
This library name is used for the reusable object
-------------------------------------
Getter Method
Signature
LibraryName()
Returns: Library name Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LibraryName(libraryName)
Parameters: libraryName (str) – Library name New in version NX8.0.0.
License requirements: None.
PasteMethod¶
-
ReusableObjectPasteBuilder.
PasteMethod
¶ Returns or sets the design option to select Boolean operation type
-------------------------------------
Getter Method
Signature
PasteMethod()
Returns: Return type: NXOpen.Tooling.ReusableObjectPasteBuilderPasteMethods
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PasteMethod(pasteMethod)
Parameters: pasteMethod ( NXOpen.Tooling.ReusableObjectPasteBuilderPasteMethods
) –New in version NX8.0.0.
License requirements: None.
PatternFeature¶
-
ReusableObjectPasteBuilder.
PatternFeature
¶ Returns or sets the geometry pattern feature
-------------------------------------
Getter Method
Signature
PatternFeature()
Returns: Pattern feature Return type: NXOpen.NXObject
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PatternFeature(pattern)
Parameters: pattern ( NXOpen.NXObject
) – Pattern featureNew in version NX11.0.0.
License requirements: None.
PatternSketch¶
-
ReusableObjectPasteBuilder.
PatternSketch
¶ Returns or sets the pattern sketch for reusable object
-------------------------------------
Getter Method
Signature
PatternSketch()
Returns: Pattern sketch Return type: NXOpen.Sketch
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PatternSketch(sketch)
Parameters: sketch ( NXOpen.Sketch
) – Pattern sketchNew in version NX11.0.0.
License requirements: None.
PositioningFeatSet¶
-
ReusableObjectPasteBuilder.
PositioningFeatSet
¶ Returns the positioning feature set by pattern sketch
-------------------------------------
Getter Method
Signature
PositioningFeatSet()
Returns: Positioning feature set Return type: NXOpen.Features.Feature
New in version NX11.0.0.
License requirements: None.
TargetBody¶
-
ReusableObjectPasteBuilder.
TargetBody
¶ Returns or sets the target body required for boolean operation
-------------------------------------
Getter Method
Signature
TargetBody()
Returns: Target body Return type: NXOpen.NXObject
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TargetBody(body)
Parameters: body ( NXOpen.NXObject
) – Target bodyNew in version NX8.0.0.
License requirements: None.
TargetFace¶
-
ReusableObjectPasteBuilder.
TargetFace
¶ Returns or sets the target face required for solid punch
-------------------------------------
Getter Method
Signature
TargetFace()
Returns: Target face Return type: NXOpen.NXObject
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TargetFace(face)
Parameters: face ( NXOpen.NXObject
) – Target faceNew in version NX8.0.0.
License requirements: None.
UseOnePickPositionMethod¶
-
ReusableObjectPasteBuilder.
UseOnePickPositionMethod
¶ Returns or sets the option specifying whether to use one-pick position method for drag/drop
-------------------------------------
Getter Method
Signature
UseOnePickPositionMethod()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseOnePickPositionMethod(useOnePickPositionMethod)
Parameters: useOnePickPositionMethod (bool) – New in version NX8.0.0.
License requirements: None.
Method Detail¶
CreatePatternObjects¶
-
ReusableObjectPasteBuilder.
CreatePatternObjects
¶ Creates the pattern objects
Signature
CreatePatternObjects(createPattern)
Parameters: createPattern (bool) – Flag indicating whether to create pattern objects or delete New in version NX11.0.0.
License requirements: None.
GetCreatedObjects¶
-
ReusableObjectPasteBuilder.
GetCreatedObjects
¶ Gets the created objects
Signature
GetCreatedObjects()
Returns: Objects, mainly bodies, from the imported part Return type: list of NXOpen.NXObject
New in version NX8.5.0.
License requirements: None.
GetSpreadsheetData¶
-
ReusableObjectPasteBuilder.
GetSpreadsheetData
¶ Gets the spreadsheet data
Signature
GetSpreadsheetData()
Returns: Spreadsheet data Return type: NXOpen.Tooling.SpreadsheetData
New in version NX8.0.0.
License requirements: None.
LoadPart¶
-
ReusableObjectPasteBuilder.
LoadPart
¶ Imports given part file to current work part
Signature
LoadPart(partFileName, dropEntity)
Parameters: - partFileName (str) – Part file name
- dropEntity (
NXOpen.NXObject
) – Selected body face or datum plane of CSYS
Returns: Objects, mainly bodies, from the imported part
Return type: list of
NXOpen.NXObject
New in version NX8.0.0.
License requirements: None.
RepositionBody¶
-
ReusableObjectPasteBuilder.
RepositionBody
¶ Moves the body to the selected point and orientation
Signature
RepositionBody(target, orient, twoPickPositionMode)
Parameters: - target (
NXOpen.Point3d
) – Destination point - orient (
NXOpen.Matrix3x3
) – Orientation - twoPickPositionMode (bool) – Flag specifying whether to reposition the body based on active sketch plane when using two pick position method to drop the body. If True, reposition the body, else, do nothing.
New in version NX8.0.0.
License requirements: None.
- target (
SetLibraryInformation¶
-
ReusableObjectPasteBuilder.
SetLibraryInformation
¶ Sets library information for the feature
Signature
SetLibraryInformation(feature, libraryName, relativePath)
Parameters: - feature (
NXOpen.NXObject
) – Reusable object feature - libraryName (str) – Library name
- relativePath (str) – Relative path where library is located
New in version NX8.0.0.
License requirements: None.
- feature (
SetSpreadsheetData¶
-
ReusableObjectPasteBuilder.
SetSpreadsheetData
¶ Sets the spreadsheet data
Signature
SetSpreadsheetData(spreadsheetData)
Parameters: spreadsheetData ( NXOpen.Tooling.SpreadsheetData
) – Spreadsheet dataNew in version NX8.0.0.
License requirements: None.
UpdateLocation¶
-
ReusableObjectPasteBuilder.
UpdateLocation
¶ Updates location of reusable object after edit pattern points
Signature
UpdateLocation()
New in version NX11.0.0.
License requirements: None.
UpdateSpreadsheetData¶
-
ReusableObjectPasteBuilder.
UpdateSpreadsheetData
¶ Updates the spreadsheet data according to the expressions in part
Signature
UpdateSpreadsheetData()
New in version NX8.0.0.
License requirements: None.
Validate¶
-
ReusableObjectPasteBuilder.
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.