NXOpen::Tooling::EdgePatchBuilder Class Reference

Represents a builder to be used to create edge patch surfaces. More...

Inheritance diagram for NXOpen::Tooling::EdgePatchBuilder:

Public Types
enum	PatchStatus {   PatchStatusNoLoopExisted, PatchStatusOneLoopExisted, PatchStatusMultiLoopsExisted, PatchStatusSomeLoopsExisted,   PatchStatusLoopNotPatched, PatchStatusPatchedAndSomeSuppressed, PatchStatusPatchedAndAllSuppressed, PatchStatusPatchedAndNoSuppressed }
	Settings of the patch status types. More...
enum	SelectTypes { SelectTypesFace, SelectTypesBody, SelectTypesTraverse }
	Settings of the selection types. More...

Public Member Functions
bool	AllowPatch ()
	Returns the flag indicating if creating copies for patch surface is allowed.
NXOpen::SelectBody *	Body ()
	Returns the body to use to search for loops.
NXOpen::NXColor *	BodyColor ()
	Returns the patch body color.
void	ClearList (int type)
	Clear the index list.
void	DeleteOneLoopList (int index)
	Delete one loop list of the index.
void	DestroyMemory ()
	Destroy the builder memory.
void	DirectionReverse ()
	Reverse reference face direction.
void	EditReferenceFace (int index, const std::vector< NXOpen::Face * > &addFaces, const std::vector< NXOpen::Face * > &removeFaces)
	Add or remove reference faces.
NXOpen::ScCollector *	Face ()
	Returns the face to use to search for loops.
void	FindBodyHoles (NXOpen::Body *body)
	Find holes on the input body.
NXOpen::Tooling::EdgePatchBuilder::PatchStatus	FindEdgesPatch (const std::vector< NXOpen::NXObject * > &edges)
	Get hole information of input edges.
NXOpen::Tooling::EdgePatchBuilder::PatchStatus	FindFaceHoles (NXOpen::Face *referFaces)
	Find holes on the input faces.
void	GetBodyColor (double *redValue, double *greenValue, double *blueValue)
	Returns the body color.
NXOpen::ScCollector *	Loops ()
	Returns the loops to patch.
bool	PatchSurface ()
	Returns the indication to create patch surface bodies in core/cavity.
NXOpen::ScCollector *	ReferenceFace ()
	Returns the reference face to use to create edge patch.
NXOpen::Tooling::EdgePatchBuilder::SelectTypes	SelType ()
	Returns the patch type of the edge patch creation.
void	SetAllowPatch (bool patch)
	Sets the flag indicating if creating copies for patch surface is allowed.
void	SetBodyColor (NXOpen::NXColor *patchColor)
	Sets the patch body color.
void	SetBodyColor (double redValue, double greenValue, double blueValue)
	Sets the body color.
void	SetDeletedList (const std::vector< int > &items)
	Set deleted list value.
void	SetGiveFailedMessage (int giveMessage)
	Set the giving failed message value.
void	SetPatchSurface (bool patchSurface)
	Sets the indication to create patch surface bodies in core/cavity.
void	SetSelectedItems (const std::vector< int > &selectedItems)
	Set the selected items index value.
void	SetSelType (NXOpen::Tooling::EdgePatchBuilder::SelectTypes selType)
	Sets the patch type of the edge patch creation.
void	SetTolerance (double tolerance)
	Set the tolerance value.
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

Represents a builder to be used to create edge patch surfaces.

To create a new instance of this class, use Tooling::EdgePatchCollection::CreateBuilder
Default values.

Property	Value
PatchSurface	1
SelType	Face

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::Tooling::EdgePatchBuilder::PatchStatus

Settings of the patch status types.

Enumerator:

PatchStatusNoLoopExisted	No loop existed in list.
PatchStatusOneLoopExisted	One loop existed in list.
PatchStatusMultiLoopsExisted	More than one loops existed in list.
PatchStatusSomeLoopsExisted	Some loops existed in list.
PatchStatusLoopNotPatched	No loop is patched.
PatchStatusPatchedAndSomeSuppressed	Some patched bodies are suppressed.
PatchStatusPatchedAndAllSuppressed	All patched bodies are suppressed.
PatchStatusPatchedAndNoSuppressed	No patched body is suppressed.

enum NXOpen::Tooling::EdgePatchBuilder::SelectTypes

Settings of the selection types.

Enumerator:

SelectTypesFace	Face types.
SelectTypesBody	Body types.
SelectTypesTraverse	Traverse types.

Member Function Documentation

bool NXOpen::Tooling::EdgePatchBuilder::AllowPatch

(

)

Returns the flag indicating if creating copies for patch surface is allowed.

Created in NX7.5.3.

License requirements : None

NXOpen::SelectBody* NXOpen::Tooling::EdgePatchBuilder::Body

(

)

Returns the body to use to search for loops.

Created in NX7.5.0.

License requirements : None

NXOpen::NXColor* NXOpen::Tooling::EdgePatchBuilder::BodyColor

(

)

Returns the patch body color.

Created in NX7.5.5.

License requirements : None

void NXOpen::Tooling::EdgePatchBuilder::ClearList

(

int

type

)

Clear the index list.

Created in NX7.5.0.

License requirements : None

Parameters

type	indicating which index list to clear

void NXOpen::Tooling::EdgePatchBuilder::DeleteOneLoopList

(

int

index

)

Delete one loop list of the index.

Created in NX7.5.0.

License requirements : None

Parameters

index

the index value

void NXOpen::Tooling::EdgePatchBuilder::DestroyMemory

(

)

Destroy the builder memory.

Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::EdgePatchBuilder::DirectionReverse

(

)

Reverse reference face direction.

Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::EdgePatchBuilder::EditReferenceFace	(	int	index,
		const std::vector< NXOpen::Face * > &	addFaces,
		const std::vector< NXOpen::Face * > &	removeFaces
	)

Add or remove reference faces.

Created in NX7.5.0.

License requirements : None

Parameters

index	the index of list loop
addFaces	The faces to add to reference faces
removeFaces	The faces to remove from reference faces

NXOpen::ScCollector* NXOpen::Tooling::EdgePatchBuilder::Face

(

)

Returns the face to use to search for loops.

Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::EdgePatchBuilder::FindBodyHoles

(

NXOpen::Body *

body

)

Find holes on the input body.

Created in NX7.5.0.

License requirements : None

Parameters

body	the body to find holes on which

NXOpen::Tooling::EdgePatchBuilder::PatchStatus NXOpen::Tooling::EdgePatchBuilder::FindEdgesPatch

(

const std::vector< NXOpen::NXObject * > &

edges

)

Get hole information of input edges.

Returns

the edges or curves patch status
Created in NX7.5.0.

License requirements : None

Parameters

edges

the edges or curves to find holes information

NXOpen::Tooling::EdgePatchBuilder::PatchStatus NXOpen::Tooling::EdgePatchBuilder::FindFaceHoles

(

NXOpen::Face *

referFaces

)

Find holes on the input faces.

Returns

the loop status
Created in NX7.5.0.

License requirements : None

Parameters

referFaces

the faces to find holes

void NXOpen::Tooling::EdgePatchBuilder::GetBodyColor	(	double *	redValue,
		double *	greenValue,
		double *	blueValue
	)

Returns the body color.

Deprecated:

Deprecated in NX8.5.0. Use Tooling::EdgePatchBuilder::BodyColor instead.

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::EdgePatchBuilder::Loops

(

)

Returns the loops to patch.

Created in NX7.5.0.

License requirements : None

bool NXOpen::Tooling::EdgePatchBuilder::PatchSurface

(

)

Returns the indication to create patch surface bodies in core/cavity.

Created in NX7.5.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Tooling::EdgePatchBuilder::ReferenceFace

(

)

Returns the reference face to use to create edge patch.

Created in NX7.5.0.

License requirements : None

NXOpen::Tooling::EdgePatchBuilder::SelectTypes NXOpen::Tooling::EdgePatchBuilder::SelType

(

)

Returns the patch type of the edge patch creation.

Created in NX7.5.0.

License requirements : None

void NXOpen::Tooling::EdgePatchBuilder::SetAllowPatch

(

bool

patch

)

Sets the flag indicating if creating copies for patch surface is allowed.

Created in NX7.5.3.

License requirements : None

Parameters

patch

patch

void NXOpen::Tooling::EdgePatchBuilder::SetBodyColor

(

NXOpen::NXColor *

patchColor

)

Sets the patch body color.

Created in NX7.5.5.

License requirements : None

Parameters

patchColor

the color index

void NXOpen::Tooling::EdgePatchBuilder::SetBodyColor	(	double	redValue,
		double	greenValue,
		double	blueValue
	)

Sets the body color.

Deprecated:

Deprecated in NX8.5.0. Use Tooling::EdgePatchBuilder::SetBodyColor instead.

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::EdgePatchBuilder::SetDeletedList

(

const std::vector< int > &

items

)

Set deleted list value.

Created in NX7.5.0.

License requirements : None

Parameters

items

the deleted index values

void NXOpen::Tooling::EdgePatchBuilder::SetGiveFailedMessage

(

int

giveMessage

)

Set the giving failed message value.

Created in NX7.5.0.

License requirements : None

Parameters

giveMessage

the giving failed message value

void NXOpen::Tooling::EdgePatchBuilder::SetPatchSurface

(

bool

patchSurface

)

Sets the indication to create patch surface bodies in core/cavity.

Created in NX7.5.0.

License requirements : None

Parameters

patchSurface

patchsurface

void NXOpen::Tooling::EdgePatchBuilder::SetSelectedItems

(

const std::vector< int > &

selectedItems

)

Set the selected items index value.

Created in NX7.5.0.

License requirements : None

Parameters

selectedItems

the selected index values

void NXOpen::Tooling::EdgePatchBuilder::SetSelType

(

NXOpen::Tooling::EdgePatchBuilder::SelectTypes

selType

)

Sets the patch type of the edge patch creation.

Created in NX7.5.0.

License requirements : None

Parameters

selType

seltype

void NXOpen::Tooling::EdgePatchBuilder::SetTolerance

(

double

tolerance

)

Set the tolerance value.

Created in NX7.5.0.

License requirements : None

Parameters

tolerance

the tolerance value

---

The documentation for this class was generated from the following file:

• Tooling_EdgePatchBuilder.hxx