NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Tooling::ReusableObjectPasteBuilder Class Reference

Represents a NXOpen::Tooling::ReusableObjectPasteBuilder
Use the NXOpen::Tooling::ReusableObjectManager class to create a ReusableObjectPasteBuilder. More...

Inheritance diagram for NXOpen::Tooling::ReusableObjectPasteBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  PasteMethods {
  PasteMethodsNone, PasteMethodsAdd, PasteMethodsSubtract, PasteMethodsUserdefined,
  PasteMethodsSolidpunch
}
 Specifies the design option. More...
 

Public Member Functions

bool Associative ()
 Returns the option specifying whether to associate the csys of reuse object to target entity
Created in NX8.0.2. More...
 
void CreatePatternObjects (bool createPattern)
 Creates the pattern objects
Created in NX11.0.0. More...
 
NXOpen::NXObjectDropFace ()
 Returns the drop face required for reattach sketch when using one-pick position method
Created in NX8.0.0. More...
 
NXOpen::Matrix3x3 DynamicCsysOrientation ()
 Returns the orientation of dynamic csys
Created in NX8.0.0. More...
 
NXOpen::Point3d DynamicCsysOrigin ()
 Returns the origin of dynamic csys
Created in NX8.0.0. More...
 
NXOpen::NXObjectEditFeatureGroup ()
 Returns the feature group created after reuse paste
Created in NX8.0.0. More...
 
void GetCreatedObjects (std::vector< NXOpen::NXObject * > &createdObjects)
 Gets the created objects
Created in NX8.5.0. More...
 
NXOpen::Tooling::SpreadsheetDataGetSpreadsheetData ()
 Gets the spreadsheet data. More...
 
NXOpen::NXObjectImportedSketch ()
 Returns the imported sketch
Created in NX8.0.0. More...
 
NXOpen::Point3d InitialPasteLocation ()
 Returns the initial paste location, this is mainly used to define default paste location of sketch objects
Created in NX8.0.0. More...
 
NXString LibraryName ()
 Returns the library name. More...
 
void LoadPart (const NXString &partFileName, NXOpen::NXObject *dropEntity, std::vector< NXOpen::NXObject * > &loadedObjects)
 Imports given part file to current work part
Created in NX8.0.0. More...
 
void LoadPart (const char *partFileName, NXOpen::NXObject *dropEntity, std::vector< NXOpen::NXObject * > &loadedObjects)
 Imports given part file to current work part
Created in NX8.0.0. More...
 
NXOpen::Tooling::ReusableObjectPasteBuilder::PasteMethods PasteMethod ()
 Returns the design option to select Boolean operation type
Created in NX8.0.0. More...
 
NXOpen::NXObjectPatternFeature ()
 Returns the geometry pattern feature
Created in NX11.0.0. More...
 
NXOpen::SketchPatternSketch ()
 Returns the pattern sketch for reusable object
Created in NX11.0.0. More...
 
NXOpen::Features::FeaturePositioningFeatSet ()
 Returns the positioning feature set by pattern sketch
Created in NX11.0.0. More...
 
void RepositionBody (const NXOpen::Point3d &target, const NXOpen::Matrix3x3 &orient, bool twoPickPositionMode)
 Moves the body to the selected point and orientation
Created in NX8.0.0. More...
 
void SetAssociative (bool associative)
 Sets the option specifying whether to associate the csys of reuse object to target entity
Created in NX8.0.2. More...
 
void SetDropFace (NXOpen::NXObject *face)
 Sets the drop face required for reattach sketch when using one-pick position method
Created in NX8.0.0. More...
 
void SetDynamicCsysOrientation (const NXOpen::Matrix3x3 &orientation)
 Sets the orientation of dynamic csys
Created in NX8.0.0. More...
 
void SetDynamicCsysOrigin (const NXOpen::Point3d &origin)
 Sets the origin of dynamic csys
Created in NX8.0.0. More...
 
void SetEditFeatureGroup (NXOpen::NXObject *featureGroup)
 Sets the feature group created after reuse paste
Created in NX8.0.0. More...
 
void SetImportedSketch (NXOpen::NXObject *sketch)
 Sets the imported sketch
Created in NX8.0.0. More...
 
void SetInitialPasteLocation (const NXOpen::Point3d &dropLocation)
 Sets the initial paste location, this is mainly used to define default paste location of sketch objects
Created in NX8.0.0. More...
 
void SetLibraryInformation (NXOpen::NXObject *feature, const NXString &libraryName, const NXString &relativePath)
 Sets library information for the feature
Created in NX8.0.0. More...
 
void SetLibraryInformation (NXOpen::NXObject *feature, const char *libraryName, const char *relativePath)
 Sets library information for the feature
Created in NX8.0.0. More...
 
void SetLibraryName (const NXString &libraryName)
 Sets the library name. More...
 
void SetLibraryName (const char *libraryName)
 Sets the library name. More...
 
void SetPasteMethod (NXOpen::Tooling::ReusableObjectPasteBuilder::PasteMethods pasteMethod)
 Sets the design option to select Boolean operation type
Created in NX8.0.0. More...
 
void SetPatternFeature (NXOpen::NXObject *pattern)
 Sets the geometry pattern feature
Created in NX11.0.0. More...
 
void SetPatternSketch (NXOpen::Sketch *sketch)
 Sets the pattern sketch for reusable object
Created in NX11.0.0. More...
 
void SetSpreadsheetData (NXOpen::Tooling::SpreadsheetData *spreadsheetData)
 Sets the spreadsheet data
Created in NX8.0.0. More...
 
void SetTargetBody (NXOpen::NXObject *body)
 Sets the target body required for boolean operation
Created in NX8.0.0. More...
 
void SetTargetFace (NXOpen::NXObject *face)
 Sets the target face required for solid punch
Created in NX8.0.0. More...
 
void SetUseOnePickPositionMethod (bool useOnePickPositionMethod)
 Sets the option specifying whether to use one-pick position method for drag/drop
Created in NX8.0.0. More...
 
NXOpen::NXObjectTargetBody ()
 Returns the target body required for boolean operation
Created in NX8.0.0. More...
 
NXOpen::NXObjectTargetFace ()
 Returns the target face required for solid punch
Created in NX8.0.0. More...
 
void UpdateLocation ()
 Updates location of reusable object after edit pattern points
Created in NX11.0.0. More...
 
void UpdateSpreadsheetData ()
 Updates the spreadsheet data according to the expressions in part
Created in NX8.0.0. More...
 
bool UseOnePickPositionMethod ()
 Returns the option specifying whether to use one-pick position method for drag/drop
Created in NX8.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::Tooling::ReusableObjectPasteBuilder
Use the NXOpen::Tooling::ReusableObjectManager class to create a ReusableObjectPasteBuilder.



Created in NX8.0.0.

Member Enumeration Documentation

Specifies the design option.

Enumerator
PasteMethodsNone 

None.

PasteMethodsAdd 

Add.

PasteMethodsSubtract 

Subtract.

PasteMethodsUserdefined 

UserDefined.

PasteMethodsSolidpunch 

SolidPunch.

Member Function Documentation

bool NXOpen::Tooling::ReusableObjectPasteBuilder::Associative ( )

Returns the option specifying whether to associate the csys of reuse object to target entity
Created in NX8.0.2.



License requirements : None

void NXOpen::Tooling::ReusableObjectPasteBuilder::CreatePatternObjects ( bool  createPattern)

Creates the pattern objects
Created in NX11.0.0.



License requirements : None

Parameters
createPatternFlag indicating whether to create pattern objects or delete
NXOpen::NXObject* NXOpen::Tooling::ReusableObjectPasteBuilder::DropFace ( )

Returns the drop face required for reattach sketch when using one-pick position method
Created in NX8.0.0.



License requirements : None

NXOpen::Matrix3x3 NXOpen::Tooling::ReusableObjectPasteBuilder::DynamicCsysOrientation ( )

Returns the orientation of dynamic csys
Created in NX8.0.0.



License requirements : None

NXOpen::Point3d NXOpen::Tooling::ReusableObjectPasteBuilder::DynamicCsysOrigin ( )

Returns the origin of dynamic csys
Created in NX8.0.0.



License requirements : None

NXOpen::NXObject* NXOpen::Tooling::ReusableObjectPasteBuilder::EditFeatureGroup ( )

Returns the feature group created after reuse paste
Created in NX8.0.0.



License requirements : None

void NXOpen::Tooling::ReusableObjectPasteBuilder::GetCreatedObjects ( std::vector< NXOpen::NXObject * > &  createdObjects)

Gets the created objects
Created in NX8.5.0.



License requirements : None

Parameters
createdObjectsObjects, mainly bodies, from the imported part
NXOpen::Tooling::SpreadsheetData* NXOpen::Tooling::ReusableObjectPasteBuilder::GetSpreadsheetData ( )

Gets the spreadsheet data.

Returns
Spreadsheet data
Created in NX8.0.0.

License requirements : None
NXOpen::NXObject* NXOpen::Tooling::ReusableObjectPasteBuilder::ImportedSketch ( )

Returns the imported sketch
Created in NX8.0.0.



License requirements : None

NXOpen::Point3d NXOpen::Tooling::ReusableObjectPasteBuilder::InitialPasteLocation ( )

Returns the initial paste location, this is mainly used to define default paste location of sketch objects
Created in NX8.0.0.



License requirements : None

NXString NXOpen::Tooling::ReusableObjectPasteBuilder::LibraryName ( )

Returns the library name.

This library name is used for the reusable object
Created in NX8.0.0.

License requirements : None

void NXOpen::Tooling::ReusableObjectPasteBuilder::LoadPart ( const NXString partFileName,
NXOpen::NXObject dropEntity,
std::vector< NXOpen::NXObject * > &  loadedObjects 
)

Imports given part file to current work part
Created in NX8.0.0.



License requirements : None

Parameters
partFileNamePart file name
dropEntitySelected body face or datum plane of CSYS
loadedObjectsObjects, mainly bodies, from the imported part
void NXOpen::Tooling::ReusableObjectPasteBuilder::LoadPart ( const char *  partFileName,
NXOpen::NXObject dropEntity,
std::vector< NXOpen::NXObject * > &  loadedObjects 
)

Imports given part file to current work part
Created in NX8.0.0.



License requirements : None

Parameters
partFileNamePart file name
dropEntitySelected body face or datum plane of CSYS
loadedObjectsObjects, mainly bodies, from the imported part
NXOpen::Tooling::ReusableObjectPasteBuilder::PasteMethods NXOpen::Tooling::ReusableObjectPasteBuilder::PasteMethod ( )

Returns the design option to select Boolean operation type
Created in NX8.0.0.



License requirements : None

NXOpen::NXObject* NXOpen::Tooling::ReusableObjectPasteBuilder::PatternFeature ( )

Returns the geometry pattern feature
Created in NX11.0.0.



License requirements : None

NXOpen::Sketch* NXOpen::Tooling::ReusableObjectPasteBuilder::PatternSketch ( )

Returns the pattern sketch for reusable object
Created in NX11.0.0.



License requirements : None

NXOpen::Features::Feature* NXOpen::Tooling::ReusableObjectPasteBuilder::PositioningFeatSet ( )

Returns the positioning feature set by pattern sketch
Created in NX11.0.0.



License requirements : None

void NXOpen::Tooling::ReusableObjectPasteBuilder::RepositionBody ( const NXOpen::Point3d target,
const NXOpen::Matrix3x3 orient,
bool  twoPickPositionMode 
)

Moves the body to the selected point and orientation
Created in NX8.0.0.



License requirements : None

Parameters
targetDestination point
orientOrientation
twoPickPositionModeFlag 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.
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetAssociative ( bool  associative)

Sets the option specifying whether to associate the csys of reuse object to target entity
Created in NX8.0.2.



License requirements : None

Parameters
associativeassociative
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetDropFace ( NXOpen::NXObject face)

Sets the drop face required for reattach sketch when using one-pick position method
Created in NX8.0.0.



License requirements : None

Parameters
faceDrop face
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetDynamicCsysOrientation ( const NXOpen::Matrix3x3 orientation)

Sets the orientation of dynamic csys
Created in NX8.0.0.



License requirements : None

Parameters
orientationOrientation of dynamic csys
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetDynamicCsysOrigin ( const NXOpen::Point3d origin)

Sets the origin of dynamic csys
Created in NX8.0.0.



License requirements : None

Parameters
originOrigin of dynamic csys
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetEditFeatureGroup ( NXOpen::NXObject featureGroup)

Sets the feature group created after reuse paste
Created in NX8.0.0.



License requirements : None

Parameters
featureGroupfeaturegroup
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetImportedSketch ( NXOpen::NXObject sketch)

Sets the imported sketch
Created in NX8.0.0.



License requirements : None

Parameters
sketchImported sketch
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetInitialPasteLocation ( const NXOpen::Point3d dropLocation)

Sets the initial paste location, this is mainly used to define default paste location of sketch objects
Created in NX8.0.0.



License requirements : None

Parameters
dropLocationDrop location coordinates in absolute
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetLibraryInformation ( NXOpen::NXObject feature,
const NXString libraryName,
const NXString relativePath 
)

Sets library information for the feature
Created in NX8.0.0.



License requirements : None

Parameters
featureReusable object feature
libraryNameLibrary name
relativePathRelative path where library is located
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetLibraryInformation ( NXOpen::NXObject feature,
const char *  libraryName,
const char *  relativePath 
)

Sets library information for the feature
Created in NX8.0.0.



License requirements : None

Parameters
featureReusable object feature
libraryNameLibrary name
relativePathRelative path where library is located
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetLibraryName ( const NXString libraryName)

Sets the library name.

This library name is used for the reusable object
Created in NX8.0.0.

License requirements : None

Parameters
libraryNameLibrary name
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetLibraryName ( const char *  libraryName)

Sets the library name.

This library name is used for the reusable object
Created in NX8.0.0.

License requirements : None

Parameters
libraryNameLibrary name
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetPasteMethod ( NXOpen::Tooling::ReusableObjectPasteBuilder::PasteMethods  pasteMethod)

Sets the design option to select Boolean operation type
Created in NX8.0.0.



License requirements : None

Parameters
pasteMethodpastemethod
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetPatternFeature ( NXOpen::NXObject pattern)

Sets the geometry pattern feature
Created in NX11.0.0.



License requirements : None

Parameters
patternPattern feature
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetPatternSketch ( NXOpen::Sketch sketch)

Sets the pattern sketch for reusable object
Created in NX11.0.0.



License requirements : None

Parameters
sketchPattern sketch
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetSpreadsheetData ( NXOpen::Tooling::SpreadsheetData spreadsheetData)

Sets the spreadsheet data
Created in NX8.0.0.



License requirements : None

Parameters
spreadsheetDataSpreadsheet data
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetTargetBody ( NXOpen::NXObject body)

Sets the target body required for boolean operation
Created in NX8.0.0.



License requirements : None

Parameters
bodyTarget body
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetTargetFace ( NXOpen::NXObject face)

Sets the target face required for solid punch
Created in NX8.0.0.



License requirements : None

Parameters
faceTarget face
void NXOpen::Tooling::ReusableObjectPasteBuilder::SetUseOnePickPositionMethod ( bool  useOnePickPositionMethod)

Sets the option specifying whether to use one-pick position method for drag/drop
Created in NX8.0.0.



License requirements : None

Parameters
useOnePickPositionMethoduseonepickpositionmethod
NXOpen::NXObject* NXOpen::Tooling::ReusableObjectPasteBuilder::TargetBody ( )

Returns the target body required for boolean operation
Created in NX8.0.0.



License requirements : None

NXOpen::NXObject* NXOpen::Tooling::ReusableObjectPasteBuilder::TargetFace ( )

Returns the target face required for solid punch
Created in NX8.0.0.



License requirements : None

void NXOpen::Tooling::ReusableObjectPasteBuilder::UpdateLocation ( )

Updates location of reusable object after edit pattern points
Created in NX11.0.0.



License requirements : None

void NXOpen::Tooling::ReusableObjectPasteBuilder::UpdateSpreadsheetData ( )

Updates the spreadsheet data according to the expressions in part
Created in NX8.0.0.



License requirements : None

bool NXOpen::Tooling::ReusableObjectPasteBuilder::UseOnePickPositionMethod ( )

Returns the option specifying whether to use one-pick position method for drag/drop
Created in NX8.0.0.



License requirements : None


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