nxopen.tooling

Interface MWDefineRegionsBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface MWDefineRegionsBuilder
extends Builder

The MWDefineRegions builder
To create a new instance of this class, use MWDefineRegionsCollection.createBuilder()
Default values.

Property	Value
CreatePartingLinesToggle	0
CreateRegionsToggle	0
TranslucencyOption	SelectedFaces
TranslucencyValueScale	0

Created in NX6.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MWDefineRegionsBuilder.OrCreateEmptyRegionData This class holds the data returned from getOrCreateEmptyRegion()
static class	MWDefineRegionsBuilder.TranslucencyOptionType This enum represents the translucency is to be performed on the selected or non-selected region faces

Method Summary

Modifier and Type	Method and Description
int	changeCurrentRegionName(String regionName) Change the region name for the current region License requirements: None.
void	changeEntitiesColor(TaggedObject[] entities, int color) Change the color of displayable entities License requirements: None.
void	changeRegionFacesColor(String regionName, int allOrUndefined, int color) Change the color of the faces of a region License requirements: None.
void	changeRegionLayer(String regionName, int layer) Change the layer of the region License requirements: None.
String	createNewRegion() Create a new region License requirements: None.
void	createNewRegionButton() Button to create a new empty region License requirements: None.
boolean	createPartingLinesToggle() Returns the create parting lines toggle License requirements: None.
boolean	createRegionsToggle() Returns the create regions toggle License requirements: None.
void	deleteAllExistingRegions() Delete all existing regions License requirements: None.
void	deleteRegion(String regionName) Delete a region License requirements: None.
void	displayProductBody() Display the product body in the part file License requirements: None.
NXColor	faceColor() Returns the face color for the selected region faces License requirements: None.
MWDefineRegionsBuilder.OrCreateEmptyRegionData	getOrCreateEmptyRegion() Get or create an empty region License requirements: None.
void	hookupRegionUdoAndBodyForCavityAndCore() Hook up cavity and core region UDO objects with the corresponding sheet bodies License requirements: None.
void	searchRegionButton() Button to invoke searching region License requirements: None.
ScCollector	selectRegionFaces() Returns the region faces for defining region License requirements: None.
void	setCreatePartingLinesToggle(boolean createPartingLinesToggle) License requirements: None.
void	setCreateRegionsToggle(boolean createRegionsToggle) License requirements: None.
void	setCurrentRegion(String regionName) Set the current region License requirements: None.
void	setFaceColor(NXColor faceColor) License requirements: None.
void	setTranslucencyOption(MWDefineRegionsBuilder.TranslucencyOptionType translucencyOption) License requirements: None.
void	setTranslucencyValueScale(int translucencyValueScale) License requirements: None.
void	setupRegionsInfo() Setup the UI data for defining regions License requirements: None.
MWDefineRegionsBuilder.TranslucencyOptionType	translucencyOption() Returns the translucency option for the selected or non-selected region faces License requirements: None.
int	translucencyValueScale() Returns the translucency value for the selected or non-selected region faces License requirements: None.
void	updateUndefinedFaces(int changeColor) Update the undefined faces License requirements: None.
void	updateUnsewnBodiesNameAttribute(TaggedObject unsewFeatureTag, Face[] cavityFaces) Update name attribute for the unsew bodies of the cavity and core regions License requirements: None.

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

createNewRegionButton

void createNewRegionButton()
                    throws NXException,
                           RemoteException

Button to create a new empty region
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

selectRegionFaces

ScCollector selectRegionFaces()
                       throws NXException,
                              RemoteException

Returns the region faces for defining region
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

searchRegionButton

void searchRegionButton()
                 throws NXException,
                        RemoteException

Button to invoke searching region
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

createRegionsToggle

boolean createRegionsToggle()
                     throws NXException,
                            RemoteException

Returns the create regions toggle
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setCreateRegionsToggle

void setCreateRegionsToggle(boolean createRegionsToggle)
                     throws NXException,
                            RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

createRegionsToggle -

Throws:

NXException

RemoteException

createPartingLinesToggle

boolean createPartingLinesToggle()
                          throws NXException,
                                 RemoteException

Returns the create parting lines toggle
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setCreatePartingLinesToggle

void setCreatePartingLinesToggle(boolean createPartingLinesToggle)
                          throws NXException,
                                 RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

createPartingLinesToggle -

Throws:

NXException

RemoteException

faceColor

NXColor faceColor()
           throws NXException,
                  RemoteException

Returns the face color for the selected region faces
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setFaceColor

void setFaceColor(NXColor faceColor)
           throws NXException,
                  RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

faceColor -

Throws:

NXException

RemoteException

translucencyOption

MWDefineRegionsBuilder.TranslucencyOptionType translucencyOption()
                                                          throws NXException,
                                                                 RemoteException

Returns the translucency option for the selected or non-selected region faces
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setTranslucencyOption

void setTranslucencyOption(MWDefineRegionsBuilder.TranslucencyOptionType translucencyOption)
                    throws NXException,
                           RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

translucencyOption -

Throws:

NXException

RemoteException

translucencyValueScale

int translucencyValueScale()
                    throws NXException,
                           RemoteException

Returns the translucency value for the selected or non-selected region faces
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setTranslucencyValueScale

void setTranslucencyValueScale(int translucencyValueScale)
                        throws NXException,
                               RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

translucencyValueScale -

Throws:

NXException

RemoteException

setupRegionsInfo

void setupRegionsInfo()
               throws NXException,
                      RemoteException

Setup the UI data for defining regions
License requirements: None.

Created in NX6.0.3

Throws:

NXException

RemoteException

displayProductBody

void displayProductBody()
                 throws NXException,
                        RemoteException

Display the product body in the part file
License requirements: None.

Created in NX6.0.3

Throws:

NXException

RemoteException

createNewRegion

String createNewRegion()
                throws NXException,
                       RemoteException

Create a new region
License requirements: None.

Created in NX6.0.3

Returns:

new region object created

Throws:

NXException

RemoteException

getOrCreateEmptyRegion

MWDefineRegionsBuilder.OrCreateEmptyRegionData getOrCreateEmptyRegion()
                                                               throws NXException,
                                                                      RemoteException

Get or create an empty region
License requirements: None.

Created in NX6.0.3

Returns:

a OrCreateEmptyRegionData object

Throws:

NXException

RemoteException

deleteRegion

void deleteRegion(String regionName)
           throws NXException,
                  RemoteException

Delete a region
License requirements: None.

Created in NX6.0.3

Parameters:

regionName - region object to be deleted

Throws:

NXException

RemoteException

setCurrentRegion

void setCurrentRegion(String regionName)
               throws NXException,
                      RemoteException

Set the current region
License requirements: None.

Created in NX6.0.3

Parameters:

regionName - current region name

Throws:

NXException

RemoteException

changeCurrentRegionName

int changeCurrentRegionName(String regionName)
                     throws NXException,
                            RemoteException

Change the region name for the current region
License requirements: None.

Created in NX6.0.3

Parameters:

regionName - region name

Returns:

return status

Throws:

NXException

RemoteException

changeRegionFacesColor

void changeRegionFacesColor(String regionName,
                            int allOrUndefined,
                            int color)
                     throws NXException,
                            RemoteException

Change the color of the faces of a region
License requirements: None.

Created in NX6.0.3

Parameters:

regionName - region name

allOrUndefined - 1: All faces, 2: Undefined faces when regionUDO is 0

color - color for region faces

Throws:

NXException

RemoteException

changeEntitiesColor

void changeEntitiesColor(TaggedObject[] entities,
                         int color)
                  throws NXException,
                         RemoteException

Change the color of displayable entities
License requirements: None.

Created in NX6.0.3

Parameters:

entities - an array of entities

color - color for entities

Throws:

NXException

RemoteException

changeRegionLayer

void changeRegionLayer(String regionName,
                       int layer)
                throws NXException,
                       RemoteException

Change the layer of the region
License requirements: None.

Created in NX6.0.3

Parameters:

regionName - region name

layer - layer for region faces

Throws:

NXException

RemoteException

updateUndefinedFaces

void updateUndefinedFaces(int changeColor)
                   throws NXException,
                          RemoteException

Update the undefined faces
License requirements: None.

Created in NX6.0.3

Parameters:

changeColor - indicator for changing color too

Throws:

NXException

RemoteException

deleteAllExistingRegions

void deleteAllExistingRegions()
                       throws NXException,
                              RemoteException

Delete all existing regions
License requirements: None.

Created in NX6.0.3

Throws:

NXException

RemoteException

updateUnsewnBodiesNameAttribute

void updateUnsewnBodiesNameAttribute(TaggedObject unsewFeatureTag,
                                     Face[] cavityFaces)
                              throws NXException,
                                     RemoteException

Update name attribute for the unsew bodies of the cavity and core regions
License requirements: None.

Created in NX6.0.3

Parameters:

unsewFeatureTag - Unsewn feature object

cavityFaces - an array of cavity faces

Throws:

NXException

RemoteException

hookupRegionUdoAndBodyForCavityAndCore

void hookupRegionUdoAndBodyForCavityAndCore()
                                     throws NXException,
                                            RemoteException

Hook up cavity and core region UDO objects with the corresponding sheet bodies
License requirements: None.

Created in NX6.0.3

Throws:

NXException

RemoteException