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

Represents a boolean feature builder. More...

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

Public Member Functions

NXOpen::GeometricUtilities::BooleanRegionSelectBooleanRegionSelect ()
 Returns the boolean region select object
Created in NX8.5.0. More...
 
bool ConvertToSew ()
 Returns the convert to sew flag
Created in NX5.0.0. More...
 
bool CopyTargets ()
 Returns the copy targets flag
Created in NX5.0.0. More...
 
bool CopyTools ()
 Returns the copy tools flag
Created in NX5.0.0. More...
 
NXOpen::Features::Feature::BooleanType Operation ()
 Returns the boolean operation
Created in NX4.0.0. More...
 
bool RetainTarget ()
 Returns the retain target flag
Created in NX4.0.0. More...
 
bool RetainTool ()
 Returns the retain tool flag
Created in NX4.0.0. More...
 
void SetConvertToSew (bool convertToSew)
 Sets the convert to sew flag
Created in NX5.0.0. More...
 
void SetCopyTargets (bool copyTargets)
 Sets the copy targets flag
Created in NX5.0.0. More...
 
void SetCopyTools (bool copyTools)
 Sets the copy tools flag
Created in NX5.0.0. More...
 
void SetOperation (NXOpen::Features::Feature::BooleanType operation)
 Sets the boolean operation
Created in NX4.0.0. More...
 
void SetRetainTarget (bool retainTarget)
 Sets the retain target flag
Created in NX4.0.0. More...
 
void SetRetainTool (bool retainTool)
 Sets the retain tool flag
Created in NX4.0.0. More...
 
void SetTarget (NXOpen::Body *target)
 Sets the target body
Created in NX4.0.0. More...
 
void SetTolerance (double tolerance)
 Sets the tolerance
Created in NX5.0.0. More...
 
void SetTool (NXOpen::DisplayableObject *tool)
 Sets the tool body
More...
 
void SetToolBodyCollector (NXOpen::ScCollector *toolBodyCollector)
 Sets the tool body collector for the boolean operation
Created in NX7.5.0. More...
 
NXOpen::BodyTarget ()
 Returns the target body
Created in NX4.0.0. More...
 
NXOpen::SelectBodyListTargets ()
 Returns the target bodies for the boolean operation
Created in NX5.0.0. More...
 
double Tolerance ()
 Returns the tolerance
Created in NX5.0.0. More...
 
NXOpen::DisplayableObjectTool ()
 Returns the tool body
More...
 
NXOpen::ScCollectorToolBodyCollector ()
 Returns the tool body collector for the boolean operation
Created in NX7.5.0. More...
 
NXOpen::SelectDisplayableObjectListTools ()
 Returns the tool bodies for the boolean operation for versions before 7.5 but tool body collector for newer versions
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 boolean feature builder.

Inputs to this class can be convergent objects.
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateBooleanBuilderUsingCollector

Created in NX4.0.0.

Member Function Documentation

NXOpen::GeometricUtilities::BooleanRegionSelect* NXOpen::Features::BooleanBuilder::BooleanRegionSelect ( )

Returns the boolean region select object
Created in NX8.5.0.



License requirements : solid_modeling ("SOLIDS MODELING")

bool NXOpen::Features::BooleanBuilder::ConvertToSew ( )

Returns the convert to sew flag
Created in NX5.0.0.



License requirements : None

bool NXOpen::Features::BooleanBuilder::CopyTargets ( )

Returns the copy targets flag
Created in NX5.0.0.



License requirements : None

bool NXOpen::Features::BooleanBuilder::CopyTools ( )

Returns the copy tools flag
Created in NX5.0.0.



License requirements : None

NXOpen::Features::Feature::BooleanType NXOpen::Features::BooleanBuilder::Operation ( )

Returns the boolean operation
Created in NX4.0.0.



License requirements : None

bool NXOpen::Features::BooleanBuilder::RetainTarget ( )

Returns the retain target flag
Created in NX4.0.0.



License requirements : None

bool NXOpen::Features::BooleanBuilder::RetainTool ( )

Returns the retain tool flag
Created in NX4.0.0.



License requirements : None

void NXOpen::Features::BooleanBuilder::SetConvertToSew ( bool  convertToSew)

Sets the convert to sew flag
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
convertToSewconverttosew
void NXOpen::Features::BooleanBuilder::SetCopyTargets ( bool  copyTargets)

Sets the copy targets flag
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
copyTargetscopytargets
void NXOpen::Features::BooleanBuilder::SetCopyTools ( bool  copyTools)

Sets the copy tools flag
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
copyToolscopytools
void NXOpen::Features::BooleanBuilder::SetOperation ( NXOpen::Features::Feature::BooleanType  operation)

Sets the boolean operation
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
operationType of boolean operation.
void NXOpen::Features::BooleanBuilder::SetRetainTarget ( bool  retainTarget)

Sets the retain target flag
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
retainTargetRetain target flag
void NXOpen::Features::BooleanBuilder::SetRetainTool ( bool  retainTool)

Sets the retain tool flag
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
retainToolRetain tool flag
void NXOpen::Features::BooleanBuilder::SetTarget ( NXOpen::Body target)

Sets the target body
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
targetTarget body for boolean operation. This parameter may not be NULL.
void NXOpen::Features::BooleanBuilder::SetTolerance ( double  tolerance)

Sets the tolerance
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
tolerancetolerance
void NXOpen::Features::BooleanBuilder::SetTool ( NXOpen::DisplayableObject tool)

Sets the tool body

Deprecated:
Deprecated in NX5.0.2.

Use Features::BooleanBuilder::SetToolBodyCollector instead.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
toolTool body for boolean operation. This parameter may not be NULL.
void NXOpen::Features::BooleanBuilder::SetToolBodyCollector ( NXOpen::ScCollector toolBodyCollector)

Sets the tool body collector for the boolean operation
Created in NX7.5.0.



License requirements : None

Parameters
toolBodyCollectortoolbodycollector
NXOpen::Body* NXOpen::Features::BooleanBuilder::Target ( )

Returns the target body
Created in NX4.0.0.



License requirements : None

NXOpen::SelectBodyList* NXOpen::Features::BooleanBuilder::Targets ( )

Returns the target bodies for the boolean operation
Created in NX5.0.0.



License requirements : None

double NXOpen::Features::BooleanBuilder::Tolerance ( )

Returns the tolerance
Created in NX5.0.0.



License requirements : None

NXOpen::DisplayableObject* NXOpen::Features::BooleanBuilder::Tool ( )

Returns the tool body

Deprecated:
Deprecated in NX5.0.2.

Use Features::BooleanBuilder::ToolBodyCollector instead.


Created in NX4.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Features::BooleanBuilder::ToolBodyCollector ( )

Returns the tool body collector for the boolean operation
Created in NX7.5.0.



License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::Features::BooleanBuilder::Tools ( )

Returns the tool bodies for the boolean operation for versions before 7.5 but tool body collector for newer versions

Deprecated:
Deprecated in NX7.5.0.

Use Features::BooleanBuilder::ToolBodyCollector instead.


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.