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

Mold Wizard trim region management builder, trims a body to a boundary of edges, curves or bodies. More...

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

Public Types

enum  BoundaryOption { BoundaryOptionBodyCurve, BoundaryOptionTraverse }
 represents the boundary type option, body/curve type or traverse type. More...
 
enum  RegionOption { RegionOptionKeep, RegionOptionDiscard }
 represents the option to keep or discard the selected region. More...
 

Public Member Functions

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::SelectNXObjectListBoundaryBody ()
 Returns the selection of boundary body to extract region faces, which are used for create intersection curves with target. More...
 
NXOpen::Tooling::TrimRegionBuilder::BoundaryOption BoundaryType ()
 Returns the value of boundary type option, which specifies to use body or edge/curve as boundary object. More...
 
void GetColorValue (double *redValue, double *greenValue, double *blueValue)
 Returns the value of surface patch color. More...
 
NXOpen::ScCollectorLoopCollector ()
 Returns the loop collector to collect the traverse loops. More...
 
NXOpen::RegionPointListRegionPoint ()
 Returns the selection of region point, which will be kept or discarded as the result of trim region. More...
 
NXOpen::Tooling::TrimRegionBuilder::RegionOption RegionType ()
 Returns the value of the option, which specifies to keep or discard the selected region. 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 SetBoundaryType (NXOpen::Tooling::TrimRegionBuilder::BoundaryOption boundaryType)
 Sets the value of boundary type option, which specifies to use body or edge/curve as boundary object. More...
 
void SetColorValue (double redValue, double greenValue, double blueValue)
 Sets the value of surface patch color. More...
 
void SetRegionType (NXOpen::Tooling::TrimRegionBuilder::RegionOption regionType)
 Sets the value of the option, which specifies to keep or discard the selected region. More...
 
void SetTraverseEdges (const std::vector< NXOpen::NXObject * > &traverseEdges)
 Sets the edges from traverse loop to builder data. More...
 
NXOpen::SelectBodyTargetBody ()
 Returns the selection of target to create trim region, body type 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 trim region management builder, trims a body to a boundary of edges, curves or bodies.

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

Property Value

AsPatchSurface

1

BoundaryType

BodyCurve

RegionType

Keep


Created in NX7.5.0.

Member Enumeration Documentation

represents the boundary type option, body/curve type or traverse type.

Enumerator
BoundaryOptionBodyCurve 

select body/edge/curve as boundary object

BoundaryOptionTraverse 

use traverse loop to select boundary object

represents the option to keep or discard the selected region.

Enumerator
RegionOptionKeep 

selected region will be kept.

RegionOptionDiscard 

selected region will be discarded.

Member Function Documentation

bool NXOpen::Tooling::TrimRegionBuilder::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::TrimRegionBuilder::BodyColor ( )

Returns the color value of patch surface body.


Created in NX8.0.1.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Tooling::TrimRegionBuilder::BoundaryBody ( )

Returns the selection of boundary body to extract region faces, which are used for create intersection curves with target.


Created in NX7.5.0.

License requirements : None

NXOpen::Tooling::TrimRegionBuilder::BoundaryOption NXOpen::Tooling::TrimRegionBuilder::BoundaryType ( )

Returns the value of boundary type option, which specifies to use body or edge/curve as boundary object.


Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::TrimRegionBuilder::GetColorValue ( double *  redValue,
double *  greenValue,
double *  blueValue 
)

Returns the value of surface patch 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::ScCollector* NXOpen::Tooling::TrimRegionBuilder::LoopCollector ( )

Returns the loop collector to collect the traverse loops.


Created in NX8.0.0.

License requirements : None

NXOpen::RegionPointList* NXOpen::Tooling::TrimRegionBuilder::RegionPoint ( )

Returns the selection of region point, which will be kept or discarded as the result of trim region.


Created in NX7.5.0.

License requirements : None

NXOpen::Tooling::TrimRegionBuilder::RegionOption NXOpen::Tooling::TrimRegionBuilder::RegionType ( )

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


Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::TrimRegionBuilder::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::TrimRegionBuilder::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::TrimRegionBuilder::SetBoundaryType ( NXOpen::Tooling::TrimRegionBuilder::BoundaryOption  boundaryType)

Sets the value of boundary type option, which specifies to use body or edge/curve as boundary object.


Created in NX7.5.0.

License requirements : None

Parameters
boundaryTypeboundarytype
void NXOpen::Tooling::TrimRegionBuilder::SetColorValue ( double  redValue,
double  greenValue,
double  blueValue 
)

Sets the value of surface patch 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::TrimRegionBuilder::SetRegionType ( NXOpen::Tooling::TrimRegionBuilder::RegionOption  regionType)

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


Created in NX7.5.0.

License requirements : None

Parameters
regionTyperegiontype
void NXOpen::Tooling::TrimRegionBuilder::SetTraverseEdges ( const std::vector< NXOpen::NXObject * > &  traverseEdges)

Sets the edges from traverse loop to builder data.


Created in NX7.5.0.

License requirements : None

Parameters
traverseEdgesthe selected edges
NXOpen::SelectBody* NXOpen::Tooling::TrimRegionBuilder::TargetBody ( )

Returns the selection of target to create trim region, body type 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.