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

Represents a builder for a paste face feature. More...

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

Public Types

enum  PasteOptionType { PasteOptionTypeAutomatic, PasteOptionTypeAdd, PasteOptionTypeSubtract }
 represents the paste option which defines whether the tool body is additive or subtractive. More...
 

Public Member Functions

NXOpen::Features::PasteFaceBuilder::PasteOptionType PasteOption ()
 Returns the paste option defines whether the tool body is additive or subtractive. More...
 
bool ReverseTarget ()
 Returns the reverse target. More...
 
bool ReverseTool ()
 Returns the reverse tool. More...
 
void SetPasteOption (NXOpen::Features::PasteFaceBuilder::PasteOptionType pasteOption)
 Sets the paste option defines whether the tool body is additive or subtractive. More...
 
void SetReverseTarget (bool reverseTarget)
 Sets the reverse target. More...
 
void SetReverseTool (bool reverseTool)
 Sets the reverse tool. More...
 
NXOpen::SelectBodyTargetBody ()
 Returns the target body. More...
 
NXOpen::SelectBodyListToolBody ()
 Returns the collector holding the tool bodies. 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 builder for a paste face feature.


To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreatePasteFaceBuilder

Created in NX6.0.0.

Member Enumeration Documentation

represents the paste option which defines whether the tool body is additive or subtractive.

The paste option can be determined automatically from the add or subtract attributes on the tool body, or manually for a tool body lacking the said attributes.

Enumerator
PasteOptionTypeAutomatic 

determined automatically from the 'add' or 'subtract' attributes on each tool body.

PasteOptionTypeAdd 

each tool body will add to the target body.

PasteOptionTypeSubtract 

each tool body will subtract from the target body.

Member Function Documentation

NXOpen::Features::PasteFaceBuilder::PasteOptionType NXOpen::Features::PasteFaceBuilder::PasteOption ( )

Returns the paste option defines whether the tool body is additive or subtractive.


Created in NX6.0.0.

License requirements : None

bool NXOpen::Features::PasteFaceBuilder::ReverseTarget ( )

Returns the reverse target.

A flag to indicate whether the target body direction is reversed, disabled if target body is solid.
Created in NX6.0.0.

License requirements : None

bool NXOpen::Features::PasteFaceBuilder::ReverseTool ( )

Returns the reverse tool.

A flag to indicate whether the tool body direction is reversed.
Created in NX6.0.0.

License requirements : None

void NXOpen::Features::PasteFaceBuilder::SetPasteOption ( NXOpen::Features::PasteFaceBuilder::PasteOptionType  pasteOption)

Sets the paste option defines whether the tool body is additive or subtractive.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
pasteOptionpaste option
void NXOpen::Features::PasteFaceBuilder::SetReverseTarget ( bool  reverseTarget)

Sets the reverse target.

A flag to indicate whether the target body direction is reversed, disabled if target body is solid.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
reverseTargetreverse target
void NXOpen::Features::PasteFaceBuilder::SetReverseTool ( bool  reverseTool)

Sets the reverse tool.

A flag to indicate whether the tool body direction is reversed.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
reverseToolreverse tool
NXOpen::SelectBody* NXOpen::Features::PasteFaceBuilder::TargetBody ( )

Returns the target body.

The target body can be a solid or sheet.
Created in NX6.0.0.

License requirements : None

NXOpen::SelectBodyList* NXOpen::Features::PasteFaceBuilder::ToolBody ( )

Returns the collector holding the tool bodies.

The tool bodies will be trimmed or extended then united to the target body. The tool bodies should be sheet bodies.
Created in NX6.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.