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:

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.
NXOpen::NXColor *	BodyColor ()
	Returns the color value of patch surface body.
NXOpen::SelectNXObjectList *	BoundaryBody ()
	Returns the selection of boundary body to extract region faces, which are used for create intersection curves with target.
NXOpen::Tooling::TrimRegionBuilder::BoundaryOption	BoundaryType ()
	Returns the value of boundary type option, which specifies to use body or edge/curve as boundary object.
void	GetColorValue (double *redValue, double *greenValue, double *blueValue)
	Returns the value of surface patch color.
NXOpen::ScCollector *	LoopCollector ()
	Returns the loop collector to collect the traverse loops.
NXOpen::RegionPointList *	RegionPoint ()
	Returns the selection of region point, which will be kept or discarded as the result of trim region.
NXOpen::Tooling::TrimRegionBuilder::RegionOption	RegionType ()
	Returns the value of the option, which specifies to keep or discard the selected region.
void	SetAsPatchSurface (bool asPatchSurface)
	Sets the value of option, which specifies whether to set the result region as patch surface or not.
void	SetBodyColor (NXOpen::NXColor *patchColor)
	Sets the color value of patch surface body.
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.
void	SetColorValue (double redValue, double greenValue, double blueValue)
	Sets the value of surface patch color.
void	SetRegionType (NXOpen::Tooling::TrimRegionBuilder::RegionOption regionType)
	Sets the value of the option, which specifies to keep or discard the selected region.
void	SetTraverseEdges (const std::vector< NXOpen::NXObject * > &traverseEdges)
	Sets the edges from traverse loop to builder data.
NXOpen::SelectBody *	TargetBody ()
	Returns the selection of target to create trim region, body type only.
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

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.  <br> To create a new instance of this class, use @link Tooling::TrimRegionCollection::CreateTrimRegionBuilder  Tooling::TrimRegionCollection::CreateTrimRegionBuilder @endlink  <br> 

Default values.

Property	Value
AsPatchSurface	1
BoundaryType	BodyCurve
RegionType	Keep

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::Tooling::TrimRegionBuilder::BoundaryOption

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

enum NXOpen::Tooling::TrimRegionBuilder::RegionOption

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

redValue	red value between 0 and 1
greenValue	green value between 0 and 1
blueValue	blue 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

asPatchSurface

aspatchsurface

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

patchColor

the 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

boundaryType

boundarytype

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

redValue	red value between 0 and 1
greenValue	green value between 0 and 1
blueValue	blue 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

regionType

regiontype

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

traverseEdges

the 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:

• Tooling_TrimRegionBuilder.hxx