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

Represents a builder to be used to add sheet bodies as patch surfaces or delete patch surfaces. More...

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

Public Types

enum  ConvertTypeOption { ConvertTypeOptionWithCopies, ConvertTypeOptionNoCopies }
 The option to convert to have copies or no copies for all selected sheets. More...
 
enum  Types { TypesPatchSurface, TypesPartingSurface }
 The types for assigning sheets. More...
 

Public Member Functions

void AddSelectFace (NXOpen::Body *addFace)
 Add selected face to select list. More...
 
void ClearAddingCandidates ()
 Clear the m_addingCandidates list. More...
 
NXOpen::Tooling::AssignPatchBuilder::ConvertTypeOption ConvertType ()
 Returns the option to convert to have copies or no copies for all selected sheets. More...
 
void GetPatchColor (double *redValue, double *greenValue, double *blueValue)
 Get the defined color of patch surfaces. More...
 
void InitOnEnter ()
 Get initial patched and parting faces to do delete surface function. More...
 
bool KeepSheet ()
 Returns the flag indicating whether to Keep the sheet body or just delete it when deleting a patch surface. More...
 
NXOpen::NXColorPartingColor ()
 Returns the parting surface color
Created in NX11.0.0. More...
 
NXOpen::NXColorPatchColor ()
 Returns the patch surface color. More...
 
NXOpen::SelectBodyListPatchSurfaces ()
 Returns the selected surfaces added as patch surfaces or deleted from patch surfaces. More...
 
void PrepareAllRemovingSheets (const std::vector< NXOpen::Body * > &sheets)
 Get all the related sheets in one feature set. More...
 
void SetConvertType (NXOpen::Tooling::AssignPatchBuilder::ConvertTypeOption convertType)
 Sets the option to convert to have copies or no copies for all selected sheets. More...
 
void SetKeepSheet (bool keepSheet)
 Sets the flag indicating whether to Keep the sheet body or just delete it when deleting a patch surface. More...
 
void SetPartingColor (NXOpen::NXColor *partingColor)
 Sets the parting surface color
Created in NX11.0.0. More...
 
void SetPatchColor (NXOpen::NXColor *patchColor)
 Sets the patch surface color. More...
 
void SetPatchColor (double redValue, double greenValue, double blueValue)
 Set the defined color of patch surfaces. More...
 
void SetType (NXOpen::Tooling::AssignPatchBuilder::Types type)
 Sets the type for editing patch or parting
Created in NX11.0.0. More...
 
NXOpen::Tooling::AssignPatchBuilder::Types Type ()
 Returns the type for editing patch or parting
Created in NX11.0.0. More...
 
void UpdateInitialCandidates ()
 Update initial candidates after changing sheet type. 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 builder to be used to add sheet bodies as patch surfaces or delete patch surfaces.


To create a new instance of this class, use NXOpen::Tooling::AssignPatchCollection::CreateBuilder
Default values.

Property Value

ConvertType

WithCopies

KeepSheet

1


Created in NX7.5.0.

Member Enumeration Documentation

The option to convert to have copies or no copies for all selected sheets.

Enumerator
ConvertTypeOptionWithCopies 

with copies

ConvertTypeOptionNoCopies 

no copies

The types for assigning sheets.

Enumerator
TypesPatchSurface 

patch surface

TypesPartingSurface 

parting surface

Member Function Documentation

void NXOpen::Tooling::AssignPatchBuilder::AddSelectFace ( NXOpen::Body addFace)

Add selected face to select list.


Created in NX7.5.0.

License requirements : None

Parameters
addFaceface to add to user selected face list
void NXOpen::Tooling::AssignPatchBuilder::ClearAddingCandidates ( )

Clear the m_addingCandidates list.


Created in NX7.5.0.

License requirements : None

NXOpen::Tooling::AssignPatchBuilder::ConvertTypeOption NXOpen::Tooling::AssignPatchBuilder::ConvertType ( )

Returns the option to convert to have copies or no copies for all selected sheets.


Created in NX11.0.0.

License requirements : None

void NXOpen::Tooling::AssignPatchBuilder::GetPatchColor ( double *  redValue,
double *  greenValue,
double *  blueValue 
)

Get the defined color of patch surfaces.


Deprecated:
Deprecated in NX8.5.0. Use Tooling::AssignPatchBuilder::PatchColor instead.


Created in NX7.5.0.

License requirements : None

Parameters
redValuered value between 0 and 1
greenValuegreen value between 0 and 1
blueValueblue value between 0 and 1
void NXOpen::Tooling::AssignPatchBuilder::InitOnEnter ( )

Get initial patched and parting faces to do delete surface function.


Created in NX7.5.0.

License requirements : None

bool NXOpen::Tooling::AssignPatchBuilder::KeepSheet ( )

Returns the flag indicating whether to Keep the sheet body or just delete it when deleting a patch surface.


Created in NX7.5.0.

License requirements : None

NXOpen::NXColor* NXOpen::Tooling::AssignPatchBuilder::PartingColor ( )

Returns the parting surface color
Created in NX11.0.0.



License requirements : None

NXOpen::NXColor* NXOpen::Tooling::AssignPatchBuilder::PatchColor ( )

Returns the patch surface color.


Created in NX7.5.5.

License requirements : None

NXOpen::SelectBodyList* NXOpen::Tooling::AssignPatchBuilder::PatchSurfaces ( )

Returns the selected surfaces added as patch surfaces or deleted from patch surfaces.


Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::AssignPatchBuilder::PrepareAllRemovingSheets ( const std::vector< NXOpen::Body * > &  sheets)

Get all the related sheets in one feature set.


Created in NX7.5.0.

License requirements : None

Parameters
sheetsThe sheets to find their related originals
void NXOpen::Tooling::AssignPatchBuilder::SetConvertType ( NXOpen::Tooling::AssignPatchBuilder::ConvertTypeOption  convertType)

Sets the option to convert to have copies or no copies for all selected sheets.


Created in NX11.0.0.

License requirements : None

Parameters
convertTypeconverttype
void NXOpen::Tooling::AssignPatchBuilder::SetKeepSheet ( bool  keepSheet)

Sets the flag indicating whether to Keep the sheet body or just delete it when deleting a patch surface.


Created in NX7.5.0.

License requirements : None

Parameters
keepSheetkeepsheet
void NXOpen::Tooling::AssignPatchBuilder::SetPartingColor ( NXOpen::NXColor partingColor)

Sets the parting surface color
Created in NX11.0.0.



License requirements : None

Parameters
partingColorpartingcolor
void NXOpen::Tooling::AssignPatchBuilder::SetPatchColor ( NXOpen::NXColor patchColor)

Sets the patch surface color.


Created in NX7.5.5.

License requirements : None

Parameters
patchColorpatchcolor
void NXOpen::Tooling::AssignPatchBuilder::SetPatchColor ( double  redValue,
double  greenValue,
double  blueValue 
)

Set the defined color of patch surfaces.


Deprecated:
Deprecated in NX8.5.0. Use Tooling::AssignPatchBuilder::SetPatchColor instead.


Created in NX7.5.0.

License requirements : None

Parameters
redValuered value between 0 and 1
greenValuegreen value between 0 and 1
blueValueblue value between 0 and 1
void NXOpen::Tooling::AssignPatchBuilder::SetType ( NXOpen::Tooling::AssignPatchBuilder::Types  type)

Sets the type for editing patch or parting
Created in NX11.0.0.



License requirements : None

Parameters
typetype
NXOpen::Tooling::AssignPatchBuilder::Types NXOpen::Tooling::AssignPatchBuilder::Type ( )

Returns the type for editing patch or parting
Created in NX11.0.0.



License requirements : None

void NXOpen::Tooling::AssignPatchBuilder::UpdateInitialCandidates ( )

Update initial candidates after changing sheet type.


Created in NX11.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.