NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Tooling::MWDefineRegionsBuilder Class Reference

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

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

List of all members.

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.
void ChangeEntitiesColor (const std::vector< NXOpen::TaggedObject * > &entities, int color)
 Change the color of displayable entities
Created in NX6.0.3.
void ChangeRegionFacesColor (const NXString &regionName, int allOrUndefined, int color)
 Change the color of the faces of a region
Created in NX6.0.3.
void ChangeRegionLayer (const NXString &regionName, int layer)
 Change the layer of the region
Created in NX6.0.3.
NXString CreateNewRegion ()
 Create a new region.
void CreateNewRegionButton ()
 Button to create a new empty region
Created in NX6.0.0.
bool CreatePartingLinesToggle ()
 Returns the create parting lines toggle
Created in NX6.0.0.
bool CreateRegionsToggle ()
 Returns the create regions toggle
Created in NX6.0.0.
void DeleteAllExistingRegions ()
 Delete all existing regions
Created in NX6.0.3.
void DeleteRegion (const NXString &regionName)
 Delete a region
Created in NX6.0.3.
void DisplayProductBody ()
 Display the product body in the part file
Created in NX6.0.3.
NXOpen::NXColorFaceColor ()
 Returns the face color for the selected region faces
Created in NX6.0.0.
NXString GetOrCreateEmptyRegion (int *created)
 Get or create an empty region.
void HookupRegionUdoAndBodyForCavityAndCore ()
 Hook up cavity and core region UDO objects with the corresponding sheet bodies
Created in NX6.0.3.
void SearchRegionButton ()
 Button to invoke searching region
Created in NX6.0.0.
NXOpen::ScCollectorSelectRegionFaces ()
 Returns the region faces for defining region
Created in NX6.0.0.
void SetCreatePartingLinesToggle (bool createPartingLinesToggle)
 Sets the create parting lines toggle
Created in NX6.0.0.
void SetCreateRegionsToggle (bool createRegionsToggle)
 Sets the create regions toggle
Created in NX6.0.0.
void SetCurrentRegion (const NXString &regionName)
 Set the current region
Created in NX6.0.3.
void SetFaceColor (NXOpen::NXColor *faceColor)
 Sets the face color for the selected region faces
Created in NX6.0.0.
void SetTranslucencyOption (NXOpen::Tooling::MWDefineRegionsBuilder::TranslucencyOptionType translucencyOption)
 Sets the translucency option for the selected or non-selected region faces
Created in NX6.0.0.
void SetTranslucencyValueScale (int translucencyValueScale)
 Sets the translucency value for the selected or non-selected region faces
Created in NX6.0.0.
void SetupRegionsInfo ()
 Setup the UI data for defining regions
Created in NX6.0.3.
NXOpen::Tooling::MWDefineRegionsBuilder::TranslucencyOptionType TranslucencyOption ()
 Returns the translucency option for the selected or non-selected region faces
Created in NX6.0.0.
int TranslucencyValueScale ()
 Returns the translucency value for the selected or non-selected region faces
Created in NX6.0.0.
void UpdateUndefinedFaces (int changeColor)
 Update the undefined faces
Created in NX6.0.3.
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.

Detailed Description

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

Property Value

CreatePartingLinesToggle

0

CreateRegionsToggle

0

TranslucencyOption

SelectedFaces

TranslucencyValueScale

0


Created in NX6.0.0.


Member Enumeration Documentation

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

Change the region name for the current region.

Returns:
return status
Created in NX6.0.3.

License requirements : None
Parameters:
regionNameregion 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:
entitiesan array of entities
colorcolor 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:
regionNameregion name
allOrUndefined1: All faces, 2: Undefined faces when regionUDO is 0
colorcolor 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:
regionNameregion name
layerlayer for region faces

Create a new region.

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

License requirements : None

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



License requirements : None

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



License requirements : None

Returns the create regions toggle
Created in NX6.0.0.



License requirements : None

Delete all existing regions
Created in NX6.0.3.



License requirements : None

Delete a region
Created in NX6.0.3.



License requirements : None

Parameters:
regionNameregion object to be deleted

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



License requirements : None

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



License requirements : None

Get or create an empty region.

Returns:
empty region object
Created in NX6.0.3.

License requirements : None
Parameters:
createdReturn flag indicating if an empty region UDO is created

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



License requirements : None

Button to invoke searching region
Created in NX6.0.0.



License requirements : None

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



License requirements : None

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



License requirements : None

Parameters:
createPartingLinesTogglecreatepartinglinestoggle

Sets the create regions toggle
Created in NX6.0.0.



License requirements : None

Parameters:
createRegionsTogglecreateregionstoggle

Set the current region
Created in NX6.0.3.



License requirements : None

Parameters:
regionNamecurrent region name

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



License requirements : None

Parameters:
faceColorfacecolor

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



License requirements : None

Parameters:
translucencyOptiontranslucencyoption

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



License requirements : None

Parameters:
translucencyValueScaletranslucencyvaluescale

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



License requirements : None

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



License requirements : None

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



License requirements : None

Update the undefined faces
Created in NX6.0.3.



License requirements : None

Parameters:
changeColorindicator 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:
unsewFeatureTagUnsewn feature object
cavityFacesan array of cavity faces

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.