NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Features::PatchBuilder Class Reference

Represents a NXOpen::Features::PatchBuilder Lets you use a sheet body to replace some of the faces of a solid body. More...

Inheritance diagram for NXOpen::Features::PatchBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool CreateHolePatch ()
 Returns the create hole patch. More...
 
bool ReverseDirection ()
 Returns the reverse direction. More...
 
NXOpen::SelectFaceSeedFace ()
 Returns the seed face. More...
 
void SetCreateHolePatch (bool createHolePatch)
 Sets the create hole patch. More...
 
void SetReverseDirection (bool reverseDirection)
 Sets the reverse direction. More...
 
void SetTolerance (double tolerance)
 Sets the tolerance. More...
 
NXOpen::SelectBodyTarget ()
 Returns the target. More...
 
double Tolerance ()
 Returns the tolerance. More...
 
NXOpen::SelectDisplayableObjectTool ()
 Returns the tool. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.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::Features::PatchBuilder Lets you use a sheet body to replace some of the faces of a solid body.

You can also patch a sheet to another sheet.
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreatePatchBuilder
Default values.

Property Value

CreateHolePatch

False

ReverseDirection

False


Created in NX5.0.0.

Member Function Documentation

bool NXOpen::Features::PatchBuilder::CreateHolePatch ( )

Returns the create hole patch.

Patch the closed tool sheet to the target body to create a hole-like patch feature. Note if the edges of the tool sheet have gaps that are larger than the tolerance, the patching may not work as expected.
Created in NX5.0.0.

License requirements : None

bool NXOpen::Features::PatchBuilder::ReverseDirection ( )

Returns the reverse direction.

If set to true, the target body faces against the direction are removed, else the target body faces where the direction points to are removed. The default direction is defined by the normal vector of the first face in tool body, or of the seed face if specified.
Created in NX5.0.0.

License requirements : None

NXOpen::SelectFace* NXOpen::Features::PatchBuilder::SeedFace ( )

Returns the seed face.

Use a single face of the tool sheet that has multiple faces as the direction.
Created in NX5.0.0.

License requirements : None

void NXOpen::Features::PatchBuilder::SetCreateHolePatch ( bool  createHolePatch)

Sets the create hole patch.

Patch the closed tool sheet to the target body to create a hole-like patch feature. Note if the edges of the tool sheet have gaps that are larger than the tolerance, the patching may not work as expected.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
createHolePatchcreateholepatch
void NXOpen::Features::PatchBuilder::SetReverseDirection ( bool  reverseDirection)

Sets the reverse direction.

If set to true, the target body faces against the direction are removed, else the target body faces where the direction points to are removed. The default direction is defined by the normal vector of the first face in tool body, or of the seed face if specified.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
reverseDirectionreversedirection
void NXOpen::Features::PatchBuilder::SetTolerance ( double  tolerance)

Sets the tolerance.

The upper gap between the edges of the target and tool body
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
tolerancetolerance
NXOpen::SelectBody* NXOpen::Features::PatchBuilder::Target ( )

Returns the target.

A solid or sheet body acts as the target for the patch feature.
Created in NX5.0.0.

License requirements : None

double NXOpen::Features::PatchBuilder::Tolerance ( )

Returns the tolerance.

The upper gap between the edges of the target and tool body
Created in NX5.0.0.

License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Features::PatchBuilder::Tool ( )

Returns the tool.

A sheet acts as the tool for the patch feature.
Created in NX5.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.