The MWDefineRegions builder
To create a new instance of this class, use NXOpen::Tooling::MWDefineRegionsCollection::CreateBuilder
Default values. More...

Inheritance diagram for NXOpen::Tooling::MWDefineRegionsBuilder:

Public Types
enum	TranslucencyOptionType { TranslucencyOptionTypeSelectedFaces, TranslucencyOptionTypeOtherFaces }
	This enum represents the translucency is to be performed on the selected or non-selected region faces. More...

Public Member Functions
int	ChangeCurrentRegionName (const NXString &regionName)
	Change the region name for the current region. More...

int	ChangeCurrentRegionName (const char *regionName)
	Change the region name for the current region. More...

void	ChangeEntitiesColor (const std::vector< NXOpen::TaggedObject * > &entities, int color)
	Change the color of displayable entities Created in NX6.0.3. More...

void	ChangeRegionFacesColor (const NXString &regionName, int allOrUndefined, int color)
	Change the color of the faces of a region Created in NX6.0.3. More...

void	ChangeRegionFacesColor (const char *regionName, int allOrUndefined, int color)
	Change the color of the faces of a region Created in NX6.0.3. More...

void	ChangeRegionLayer (const NXString &regionName, int layer)
	Change the layer of the region Created in NX6.0.3. More...

void	ChangeRegionLayer (const char *regionName, int layer)
	Change the layer of the region Created in NX6.0.3. More...

NXString	CreateNewRegion ()
	Create a new region. More...

void	CreateNewRegionButton ()
	Button to create a new empty region Created in NX6.0.0. More...

bool	CreatePartingLinesToggle ()
	Returns the create parting lines toggle Created in NX6.0.0. More...

bool	CreateRegionsToggle ()
	Returns the create regions toggle Created in NX6.0.0. More...

void	DeleteAllExistingRegions ()
	Delete all existing regions Created in NX6.0.3. More...

void	DeleteRegion (const NXString &regionName)
	Delete a region Created in NX6.0.3. More...

void	DeleteRegion (const char *regionName)
	Delete a region Created in NX6.0.3. More...

void	DisplayProductBody ()
	Display the product body in the part file Created in NX6.0.3. More...

NXOpen::NXColor *	FaceColor ()
	Returns the face color for the selected region faces Created in NX6.0.0. More...

NXString	GetOrCreateEmptyRegion (int *created)
	Get or create an empty region. More...

void	HookupRegionUdoAndBodyForCavityAndCore ()
	Hook up cavity and core region UDO objects with the corresponding sheet bodies Created in NX6.0.3. More...

void	SearchRegionButton ()
	Button to invoke searching region Created in NX6.0.0. More...

NXOpen::ScCollector *	SelectRegionFaces ()
	Returns the region faces for defining region Created in NX6.0.0. More...

void	SetCreatePartingLinesToggle (bool createPartingLinesToggle)
	Sets the create parting lines toggle Created in NX6.0.0. More...

void	SetCreateRegionsToggle (bool createRegionsToggle)
	Sets the create regions toggle Created in NX6.0.0. More...

void	SetCurrentRegion (const NXString &regionName)
	Set the current region Created in NX6.0.3. More...

void	SetCurrentRegion (const char *regionName)
	Set the current region Created in NX6.0.3. More...

void	SetFaceColor (NXOpen::NXColor *faceColor)
	Sets the face color for the selected region faces Created in NX6.0.0. More...

void	SetTranslucencyOption (NXOpen::Tooling::MWDefineRegionsBuilder::TranslucencyOptionType translucencyOption)
	Sets the translucency option for the selected or non-selected region faces Created in NX6.0.0. More...

void	SetTranslucencyValueScale (int translucencyValueScale)
	Sets the translucency value for the selected or non-selected region faces Created in NX6.0.0. More...

void	SetupRegionsInfo ()
	Setup the UI data for defining regions Created in NX6.0.3. More...

NXOpen::Tooling::MWDefineRegionsBuilder::TranslucencyOptionType	TranslucencyOption ()
	Returns the translucency option for the selected or non-selected region faces Created in NX6.0.0. More...

int	TranslucencyValueScale ()
	Returns the translucency value for the selected or non-selected region faces Created in NX6.0.0. More...

void	UpdateUndefinedFaces (int changeColor)
	Update the undefined faces Created in NX6.0.3. More...

void	UpdateUnsewnBodiesNameAttribute (NXOpen::TaggedObject unsewFeatureTag, const std::vector< NXOpen::Face > &cavityFaces)
	Update name attribute for the unsew bodies of the cavity and core regions Created in NX6.0.3. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	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::NXObject *	GetObject ()
	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

The MWDefineRegions builder
To create a new instance of this class, use NXOpen::Tooling::MWDefineRegionsCollection::CreateBuilder
Default values.

Property

Value

CreatePartingLinesToggle

0

CreateRegionsToggle

0

TranslucencyOption

SelectedFaces

TranslucencyValueScale

0

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Tooling::MWDefineRegionsBuilder::TranslucencyOptionType

This enum represents the translucency is to be performed on the selected or non-selected region faces.

Enumerator
TranslucencyOptionTypeSelectedFaces	Selected region faces.
TranslucencyOptionTypeOtherFaces	Non-selected region faces.

Member Function Documentation

int NXOpen::Tooling::MWDefineRegionsBuilder::ChangeCurrentRegionName ( const NXString & regionName )

Change the region name for the current region.

Returns: return status
Created in NX6.0.3.

License requirements : None

Parameters

regionName region name

int NXOpen::Tooling::MWDefineRegionsBuilder::ChangeCurrentRegionName ( const char * regionName )

Change the region name for the current region.

Returns: return status
Created in NX6.0.3.

License requirements : None

Parameters

regionName region name

void NXOpen::Tooling::MWDefineRegionsBuilder::ChangeEntitiesColor	(	const std::vector< NXOpen::TaggedObject * > &	entities,
		int	color
	)

Change the color of displayable entities
Created in NX6.0.3.

License requirements : None

Parameters

entities	an array of entities
color	color for entities

void NXOpen::Tooling::MWDefineRegionsBuilder::ChangeRegionFacesColor	(	const NXString &	regionName,
		int	allOrUndefined,
		int	color
	)

Change the color of the faces of a region
Created in NX6.0.3.

License requirements : None

Parameters

regionName	region name
allOrUndefined	1: All faces, 2: Undefined faces when regionUDO is 0
color	color for region faces

void NXOpen::Tooling::MWDefineRegionsBuilder::ChangeRegionFacesColor	(	const char *	regionName,
		int	allOrUndefined,
		int	color
	)

Change the color of the faces of a region
Created in NX6.0.3.

License requirements : None

Parameters

regionName	region name
allOrUndefined	1: All faces, 2: Undefined faces when regionUDO is 0
color	color for region faces

void NXOpen::Tooling::MWDefineRegionsBuilder::ChangeRegionLayer	(	const NXString &	regionName,
		int	layer
	)

Change the layer of the region
Created in NX6.0.3.

License requirements : None

Parameters

regionName	region name
layer	layer for region faces

void NXOpen::Tooling::MWDefineRegionsBuilder::ChangeRegionLayer	(	const char *	regionName,
		int	layer
	)

Change the layer of the region
Created in NX6.0.3.

License requirements : None

Parameters

regionName	region name
layer	layer for region faces

NXString NXOpen::Tooling::MWDefineRegionsBuilder::CreateNewRegion ( )

Create a new region.

Returns: new region object created
Created in NX6.0.3.

License requirements : None

void NXOpen::Tooling::MWDefineRegionsBuilder::CreateNewRegionButton ( )

Button to create a new empty region
Created in NX6.0.0.

License requirements : None

bool NXOpen::Tooling::MWDefineRegionsBuilder::CreatePartingLinesToggle ( )

Returns the create parting lines toggle
Created in NX6.0.0.

License requirements : None

bool NXOpen::Tooling::MWDefineRegionsBuilder::CreateRegionsToggle ( )

Returns the create regions toggle
Created in NX6.0.0.

License requirements : None

void NXOpen::Tooling::MWDefineRegionsBuilder::DeleteAllExistingRegions ( )

Delete all existing regions
Created in NX6.0.3.

License requirements : None

void NXOpen::Tooling::MWDefineRegionsBuilder::DeleteRegion ( const NXString & regionName )

Delete a region
Created in NX6.0.3.

License requirements : None

Parameters

regionName region object to be deleted

void NXOpen::Tooling::MWDefineRegionsBuilder::DeleteRegion ( const char * regionName )

Delete a region
Created in NX6.0.3.

License requirements : None

Parameters

regionName region object to be deleted

void NXOpen::Tooling::MWDefineRegionsBuilder::DisplayProductBody ( )

Display the product body in the part file
Created in NX6.0.3.

License requirements : None

NXOpen::NXColor* NXOpen::Tooling::MWDefineRegionsBuilder::FaceColor ( )

Returns the face color for the selected region faces
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Tooling::MWDefineRegionsBuilder::GetOrCreateEmptyRegion ( int * created )

Get or create an empty region.

Returns: empty region object
Created in NX6.0.3.

License requirements : None

Parameters

created Return flag indicating if an empty region UDO is created

void NXOpen::Tooling::MWDefineRegionsBuilder::HookupRegionUdoAndBodyForCavityAndCore ( )

Hook up cavity and core region UDO objects with the corresponding sheet bodies
Created in NX6.0.3.

License requirements : None

void NXOpen::Tooling::MWDefineRegionsBuilder::SearchRegionButton ( )

Button to invoke searching region
Created in NX6.0.0.

License requirements : None

NXOpen::ScCollector* NXOpen::Tooling::MWDefineRegionsBuilder::SelectRegionFaces ( )

Returns the region faces for defining region
Created in NX6.0.0.

License requirements : None

void NXOpen::Tooling::MWDefineRegionsBuilder::SetCreatePartingLinesToggle ( bool createPartingLinesToggle )

Sets the create parting lines toggle
Created in NX6.0.0.

License requirements : None

Parameters

createPartingLinesToggle createpartinglinestoggle

void NXOpen::Tooling::MWDefineRegionsBuilder::SetCreateRegionsToggle ( bool createRegionsToggle )

Sets the create regions toggle
Created in NX6.0.0.

License requirements : None

Parameters

createRegionsToggle createregionstoggle

void NXOpen::Tooling::MWDefineRegionsBuilder::SetCurrentRegion ( const NXString & regionName )

Set the current region
Created in NX6.0.3.

License requirements : None

Parameters

regionName current region name

void NXOpen::Tooling::MWDefineRegionsBuilder::SetCurrentRegion ( const char * regionName )

Set the current region
Created in NX6.0.3.

License requirements : None

Parameters

regionName current region name

void NXOpen::Tooling::MWDefineRegionsBuilder::SetFaceColor ( NXOpen::NXColor * faceColor )

Sets the face color for the selected region faces
Created in NX6.0.0.

License requirements : None

Parameters

faceColor facecolor

void NXOpen::Tooling::MWDefineRegionsBuilder::SetTranslucencyOption ( NXOpen::Tooling::MWDefineRegionsBuilder::TranslucencyOptionType translucencyOption )

Sets the translucency option for the selected or non-selected region faces
Created in NX6.0.0.

License requirements : None

Parameters

translucencyOption translucencyoption

void NXOpen::Tooling::MWDefineRegionsBuilder::SetTranslucencyValueScale ( int translucencyValueScale )

Sets the translucency value for the selected or non-selected region faces
Created in NX6.0.0.

License requirements : None

Parameters

translucencyValueScale translucencyvaluescale

void NXOpen::Tooling::MWDefineRegionsBuilder::SetupRegionsInfo ( )

Setup the UI data for defining regions
Created in NX6.0.3.

License requirements : None

NXOpen::Tooling::MWDefineRegionsBuilder::TranslucencyOptionType NXOpen::Tooling::MWDefineRegionsBuilder::TranslucencyOption ( )

Returns the translucency option for the selected or non-selected region faces
Created in NX6.0.0.

License requirements : None

int NXOpen::Tooling::MWDefineRegionsBuilder::TranslucencyValueScale ( )

Returns the translucency value for the selected or non-selected region faces
Created in NX6.0.0.

License requirements : None

void NXOpen::Tooling::MWDefineRegionsBuilder::UpdateUndefinedFaces ( int changeColor )

Update the undefined faces
Created in NX6.0.3.

License requirements : None

Parameters

changeColor indicator for changing color too

void NXOpen::Tooling::MWDefineRegionsBuilder::UpdateUnsewnBodiesNameAttribute	(	NXOpen::TaggedObject *	unsewFeatureTag,
		const std::vector< NXOpen::Face * > &	cavityFaces
	)

Update name attribute for the unsew bodies of the cavity and core regions
Created in NX6.0.3.

License requirements : None

Parameters

unsewFeatureTag	Unsewn feature object
cavityFaces	an array of cavity faces

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

Tooling_MWDefineRegionsBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation