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

Mold Wizard enlarge surface management builder, trims a enlarged surface to a boundary of edges, curves, datum planes or faces. More...

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

Public Types

enum  KeepDiscardOption { KeepDiscardOptionKeep, KeepDiscardOptionDiscard }
 represents the keep discard options for selected region. More...
 

Public Member Functions

void AddPlanarFaceData (NXOpen::Face *planarFace)
 Initializes the planar face data with face, and adds the data to builder. More...
 
void AddSurfaceData (NXOpen::Face *addFace)
 Initializes the surface data with face, and adds the data to builder. More...
 
bool AsPatchSurface ()
 Returns the value of option, which specifies whether to set the result region as patch surface or not. More...
 
NXOpen::NXColorBodyColor ()
 Returns the color value of patch surface body. More...
 
NXOpen::SelectNXObjectListBoundarySelection ()
 Returns the selection of boundary to trim the target surface, it could be face, datum plane, edge and curve. More...
 
bool ChangeAllSizes ()
 Returns the value of option, which specifies when enlarging surface, whether to change all the sizes at the same time or not. More...
 
void CreatePreviewSurface ()
 Create preview surface data from builder. More...
 
bool CutToBoundary ()
 Returns the value of option, which specifies whether to cut the target to boundary objects or not. More...
 
bool DragData ()
 Returns the drag preview body data from builder according to face. More...
 
void ErasePlanarFaceData (NXOpen::Face *planarFace)
 Erases the planar face data from builder according to face. More...
 
void EraseSurfaceData (NXOpen::Face *eraseFace)
 Erases the surface data from builder according to face. More...
 
void GetColorValue (double *redValue, double *greenValue, double *blueValue)
 Returns the value of patch surface color. More...
 
NXOpen::Tooling::EnlargeSurfaceBuilder::KeepDiscardOption RegionOption ()
 Returns the value of the option, which specifies to keep or discard the selected region. More...
 
NXOpen::RegionPointListRegionSelection ()
 Returns the selection of region, which will be kept or discarded as the result of enlarged surface. More...
 
bool ReselTargetData ()
 Returns the reselect target face data from builder. More...
 
void SetAsPatchSurface (bool asPatchSurface)
 Sets the value of option, which specifies whether to set the result region as patch surface or not. More...
 
void SetBodyColor (NXOpen::NXColor *patchColor)
 Sets the color value of patch surface body. More...
 
void SetChangeAllSizes (bool changeAllSizes)
 Sets the value of option, which specifies when enlarging surface, whether to change all the sizes at the same time or not. More...
 
void SetColorValue (double redValue, double greenValue, double blueValue)
 Sets the value of patch surface color. More...
 
void SetCutToBoundary (bool cutToBoundary)
 Sets the value of option, which specifies whether to cut the target to boundary objects or not. More...
 
void SetDragData (bool setDragData)
 Sets the drag preview body data from builder according to face. More...
 
void SetRangeValue (NXOpen::Face *rangeFace, const std::vector< double > &rangeValue)
 Sets the value of surface range to buider data according to range face. More...
 
void SetRegionOption (NXOpen::Tooling::EnlargeSurfaceBuilder::KeepDiscardOption regionOption)
 Sets the value of the option, which specifies to keep or discard the selected region. More...
 
void SetReselTargetData (bool setReselTargetData)
 Sets the reselect target face data from builder. More...
 
void SetTargetFace (NXOpen::Face *targetFace)
 Sets the target face to target surface data. More...
 
NXOpen::GeometricUtilities::SurfaceRangeBuilderSurfaceRange ()
 Returns the surface range data, which controls the enlarged parameters of surface. More...
 
NXOpen::ScCollectorTargetSelection ()
 Returns the selection of target to create enlarge surface, body face only. 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

Mold Wizard enlarge surface management builder, trims a enlarged surface to a boundary of edges, curves, datum planes or faces.

Optionally creates output trimmed sheet body as a patch surface.
To create a new instance of this class, use NXOpen::Tooling::EnlargeSurfaceCollection::CreateEnlargeSurfaceBuilder
Default values.

Property Value

AsPatchSurface

1

ChangeAllSizes

1

CutToBoundary

1

RegionOption

Keep

SurfaceRange.AnchorPosition

Vertex1


Created in NX7.5.0.

Member Enumeration Documentation

represents the keep discard options for selected region.

Enumerator
KeepDiscardOptionKeep 

selected region will be kept.

KeepDiscardOptionDiscard 

selected region will be discarded.

Member Function Documentation

void NXOpen::Tooling::EnlargeSurfaceBuilder::AddPlanarFaceData ( NXOpen::Face planarFace)

Initializes the planar face data with face, and adds the data to builder.


Created in NX7.5.0.

License requirements : None

Parameters
planarFaceface to add to planar face data
void NXOpen::Tooling::EnlargeSurfaceBuilder::AddSurfaceData ( NXOpen::Face addFace)

Initializes the surface data with face, and adds the data to builder.


Created in NX7.5.0.

License requirements : None

Parameters
addFaceface to add to surface data
bool NXOpen::Tooling::EnlargeSurfaceBuilder::AsPatchSurface ( )

Returns the value of option, which specifies whether to set the result region as patch surface or not.


Created in NX7.5.0.

License requirements : None

NXOpen::NXColor* NXOpen::Tooling::EnlargeSurfaceBuilder::BodyColor ( )

Returns the color value of patch surface body.


Created in NX8.0.1.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Tooling::EnlargeSurfaceBuilder::BoundarySelection ( )

Returns the selection of boundary to trim the target surface, it could be face, datum plane, edge and curve.


Created in NX7.5.0.

License requirements : None

bool NXOpen::Tooling::EnlargeSurfaceBuilder::ChangeAllSizes ( )

Returns the value of option, which specifies when enlarging surface, whether to change all the sizes at the same time or not.


Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::EnlargeSurfaceBuilder::CreatePreviewSurface ( )

Create preview surface data from builder.


Created in NX8.5.0.

License requirements : None

bool NXOpen::Tooling::EnlargeSurfaceBuilder::CutToBoundary ( )

Returns the value of option, which specifies whether to cut the target to boundary objects or not.


Created in NX7.5.0.

License requirements : None

bool NXOpen::Tooling::EnlargeSurfaceBuilder::DragData ( )

Returns the drag preview body data from builder according to face.


Created in NX8.5.0.

License requirements : None

void NXOpen::Tooling::EnlargeSurfaceBuilder::ErasePlanarFaceData ( NXOpen::Face planarFace)

Erases the planar face data from builder according to face.


Created in NX7.5.0.

License requirements : None

Parameters
planarFaceface to get planar face data
void NXOpen::Tooling::EnlargeSurfaceBuilder::EraseSurfaceData ( NXOpen::Face eraseFace)

Erases the surface data from builder according to face.


Created in NX7.5.0.

License requirements : None

Parameters
eraseFaceface to get surface data
void NXOpen::Tooling::EnlargeSurfaceBuilder::GetColorValue ( double *  redValue,
double *  greenValue,
double *  blueValue 
)

Returns the value of patch surface color.


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
NXOpen::Tooling::EnlargeSurfaceBuilder::KeepDiscardOption NXOpen::Tooling::EnlargeSurfaceBuilder::RegionOption ( )

Returns the value of the option, which specifies to keep or discard the selected region.


Created in NX7.5.0.

License requirements : None

NXOpen::RegionPointList* NXOpen::Tooling::EnlargeSurfaceBuilder::RegionSelection ( )

Returns the selection of region, which will be kept or discarded as the result of enlarged surface.


Created in NX7.5.0.

License requirements : None

bool NXOpen::Tooling::EnlargeSurfaceBuilder::ReselTargetData ( )

Returns the reselect target face data from builder.


Created in NX8.5.0.

License requirements : None

void NXOpen::Tooling::EnlargeSurfaceBuilder::SetAsPatchSurface ( bool  asPatchSurface)

Sets the value of option, which specifies whether to set the result region as patch surface or not.


Created in NX7.5.0.

License requirements : None

Parameters
asPatchSurfaceaspatchsurface
void NXOpen::Tooling::EnlargeSurfaceBuilder::SetBodyColor ( NXOpen::NXColor patchColor)

Sets the color value of patch surface body.


Created in NX8.0.1.

License requirements : None

Parameters
patchColorthe color index
void NXOpen::Tooling::EnlargeSurfaceBuilder::SetChangeAllSizes ( bool  changeAllSizes)

Sets the value of option, which specifies when enlarging surface, whether to change all the sizes at the same time or not.


Created in NX7.5.0.

License requirements : None

Parameters
changeAllSizeschangeallsizes
void NXOpen::Tooling::EnlargeSurfaceBuilder::SetColorValue ( double  redValue,
double  greenValue,
double  blueValue 
)

Sets the value of patch surface color.


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::EnlargeSurfaceBuilder::SetCutToBoundary ( bool  cutToBoundary)

Sets the value of option, which specifies whether to cut the target to boundary objects or not.


Created in NX7.5.0.

License requirements : None

Parameters
cutToBoundarycuttoboundary
void NXOpen::Tooling::EnlargeSurfaceBuilder::SetDragData ( bool  setDragData)

Sets the drag preview body data from builder according to face.


Created in NX8.5.0.

License requirements : None

Parameters
setDragDatasetdragdata
void NXOpen::Tooling::EnlargeSurfaceBuilder::SetRangeValue ( NXOpen::Face rangeFace,
const std::vector< double > &  rangeValue 
)

Sets the value of surface range to buider data according to range face.


Created in NX7.5.0.

License requirements : None

Parameters
rangeFacerange face
rangeValuearray of u and v range value
void NXOpen::Tooling::EnlargeSurfaceBuilder::SetRegionOption ( NXOpen::Tooling::EnlargeSurfaceBuilder::KeepDiscardOption  regionOption)

Sets the value of the option, which specifies to keep or discard the selected region.


Created in NX7.5.0.

License requirements : None

Parameters
regionOptionregionoption
void NXOpen::Tooling::EnlargeSurfaceBuilder::SetReselTargetData ( bool  setReselTargetData)

Sets the reselect target face data from builder.


Created in NX8.5.0.

License requirements : None

Parameters
setReselTargetDatasetreseltargetdata
void NXOpen::Tooling::EnlargeSurfaceBuilder::SetTargetFace ( NXOpen::Face targetFace)

Sets the target face to target surface data.


Created in NX7.5.0.

License requirements : None

Parameters
targetFacetarget face
NXOpen::GeometricUtilities::SurfaceRangeBuilder* NXOpen::Tooling::EnlargeSurfaceBuilder::SurfaceRange ( )

Returns the surface range data, which controls the enlarged parameters of surface.


Created in NX7.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Tooling::EnlargeSurfaceBuilder::TargetSelection ( )

Returns the selection of target to create enlarge surface, body face only.


Created in NX7.5.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.