NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Tooling::EdgePatchBuilder Class Reference

Represents a builder to be used to create edge patch surfaces. More...

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

List of all members.

Public Types

enum  PatchStatus {
  PatchStatusNoLoopExisted, PatchStatusOneLoopExisted, PatchStatusMultiLoopsExisted, PatchStatusSomeLoopsExisted,
  PatchStatusLoopNotPatched, PatchStatusPatchedAndSomeSuppressed, PatchStatusPatchedAndAllSuppressed, PatchStatusPatchedAndNoSuppressed
}
 Settings of the patch status types. More...
enum  SelectTypes { SelectTypesFace, SelectTypesBody, SelectTypesTraverse }
 Settings of the selection types. More...

Public Member Functions

bool AllowPatch ()
 Returns the flag indicating if creating copies for patch surface is allowed.
NXOpen::SelectBodyBody ()
 Returns the body to use to search for loops.
NXOpen::NXColorBodyColor ()
 Returns the patch body color.
void ClearList (int type)
 Clear the index list.
void DeleteOneLoopList (int index)
 Delete one loop list of the index.
void DestroyMemory ()
 Destroy the builder memory.
void DirectionReverse ()
 Reverse reference face direction.
void EditReferenceFace (int index, const std::vector< NXOpen::Face * > &addFaces, const std::vector< NXOpen::Face * > &removeFaces)
 Add or remove reference faces.
NXOpen::ScCollectorFace ()
 Returns the face to use to search for loops.
void FindBodyHoles (NXOpen::Body *body)
 Find holes on the input body.
NXOpen::Tooling::EdgePatchBuilder::PatchStatus FindEdgesPatch (const std::vector< NXOpen::NXObject * > &edges)
 Get hole information of input edges.
NXOpen::Tooling::EdgePatchBuilder::PatchStatus FindFaceHoles (NXOpen::Face *referFaces)
 Find holes on the input faces.
void GetBodyColor (double *redValue, double *greenValue, double *blueValue)
 Returns the body color.
NXOpen::ScCollectorLoops ()
 Returns the loops to patch.
bool PatchSurface ()
 Returns the indication to create patch surface bodies in core/cavity.
NXOpen::ScCollectorReferenceFace ()
 Returns the reference face to use to create edge patch.
NXOpen::Tooling::EdgePatchBuilder::SelectTypes SelType ()
 Returns the patch type of the edge patch creation.
void SetAllowPatch (bool patch)
 Sets the flag indicating if creating copies for patch surface is allowed.
void SetBodyColor (NXOpen::NXColor *patchColor)
 Sets the patch body color.
void SetBodyColor (double redValue, double greenValue, double blueValue)
 Sets the body color.
void SetDeletedList (const std::vector< int > &items)
 Set deleted list value.
void SetGiveFailedMessage (int giveMessage)
 Set the giving failed message value.
void SetPatchSurface (bool patchSurface)
 Sets the indication to create patch surface bodies in core/cavity.
void SetSelectedItems (const std::vector< int > &selectedItems)
 Set the selected items index value.
void SetSelType (NXOpen::Tooling::EdgePatchBuilder::SelectTypes selType)
 Sets the patch type of the edge patch creation.
void SetTolerance (double tolerance)
 Set the tolerance value.

Detailed Description

Represents a builder to be used to create edge patch surfaces.


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

Property Value

PatchSurface

1

SelType

Face


Created in NX7.5.0.


Member Enumeration Documentation

Settings of the patch status types.

Enumerator:
PatchStatusNoLoopExisted 

No loop existed in list.

PatchStatusOneLoopExisted 

One loop existed in list.

PatchStatusMultiLoopsExisted 

More than one loops existed in list.

PatchStatusSomeLoopsExisted 

Some loops existed in list.

PatchStatusLoopNotPatched 

No loop is patched.

PatchStatusPatchedAndSomeSuppressed 

Some patched bodies are suppressed.

PatchStatusPatchedAndAllSuppressed 

All patched bodies are suppressed.

PatchStatusPatchedAndNoSuppressed 

No patched body is suppressed.

Settings of the selection types.

Enumerator:
SelectTypesFace 

Face types.

SelectTypesBody 

Body types.

SelectTypesTraverse 

Traverse types.


Member Function Documentation

Returns the flag indicating if creating copies for patch surface is allowed.


Created in NX7.5.3.

License requirements : None

Returns the body to use to search for loops.


Created in NX7.5.0.

License requirements : None

Returns the patch body color.


Created in NX7.5.5.

License requirements : None

Clear the index list.


Created in NX7.5.0.

License requirements : None

Parameters:
typeindicating which index list to clear

Delete one loop list of the index.


Created in NX7.5.0.

License requirements : None

Parameters:
indexthe index value

Destroy the builder memory.


Created in NX7.5.0.

License requirements : None

Reverse reference face direction.


Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::EdgePatchBuilder::EditReferenceFace ( int  index,
const std::vector< NXOpen::Face * > &  addFaces,
const std::vector< NXOpen::Face * > &  removeFaces 
)

Add or remove reference faces.


Created in NX7.5.0.

License requirements : None

Parameters:
indexthe index of list loop
addFacesThe faces to add to reference faces
removeFacesThe faces to remove from reference faces

Returns the face to use to search for loops.


Created in NX7.5.0.

License requirements : None

Find holes on the input body.


Created in NX7.5.0.

License requirements : None

Parameters:
bodythe body to find holes on which

Get hole information of input edges.

Returns:
the edges or curves patch status
Created in NX7.5.0.

License requirements : None
Parameters:
edgesthe edges or curves to find holes information

Find holes on the input faces.

Returns:
the loop status
Created in NX7.5.0.

License requirements : None
Parameters:
referFacesthe faces to find holes
void NXOpen::Tooling::EdgePatchBuilder::GetBodyColor ( double *  redValue,
double *  greenValue,
double *  blueValue 
)

Returns the body color.


Deprecated:
Deprecated in NX8.0.1.


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

Returns the loops to patch.


Created in NX7.5.0.

License requirements : None

Returns the indication to create patch surface bodies in core/cavity.


Created in NX7.5.0.

License requirements : None

Returns the reference face to use to create edge patch.


Created in NX7.5.0.

License requirements : None

Returns the patch type of the edge patch creation.


Created in NX7.5.0.

License requirements : None

Sets the flag indicating if creating copies for patch surface is allowed.


Created in NX7.5.3.

License requirements : None

Parameters:
patchpatch

Sets the patch body color.


Created in NX7.5.5.

License requirements : None

Parameters:
patchColorthe color index
void NXOpen::Tooling::EdgePatchBuilder::SetBodyColor ( double  redValue,
double  greenValue,
double  blueValue 
)

Sets the body color.


Deprecated:
Deprecated in NX8.0.1.


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::EdgePatchBuilder::SetDeletedList ( const std::vector< int > &  items)

Set deleted list value.


Created in NX7.5.0.

License requirements : None

Parameters:
itemsthe deleted index values

Set the giving failed message value.


Created in NX7.5.0.

License requirements : None

Parameters:
giveMessagethe giving failed message value

Sets the indication to create patch surface bodies in core/cavity.


Created in NX7.5.0.

License requirements : None

Parameters:
patchSurfacepatchsurface
void NXOpen::Tooling::EdgePatchBuilder::SetSelectedItems ( const std::vector< int > &  selectedItems)

Set the selected items index value.


Created in NX7.5.0.

License requirements : None

Parameters:
selectedItemsthe selected index values

Sets the patch type of the edge patch creation.


Created in NX7.5.0.

License requirements : None

Parameters:
selTypeseltype

Set the tolerance value.


Created in NX7.5.0.

License requirements : None

Parameters:
tolerancethe tolerance value

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