NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Tooling.MWDefineRegionsBuilder Class Reference

The MWDefineRegions builder More...

Inheritance diagram for NXOpen.Tooling.MWDefineRegionsBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  TranslucencyOptionType { SelectedFaces, OtherFaces }
 This enum represents the translucency is to be performed on the selected or non-selected region faces More...
 

Public Member Functions

unsafe int ChangeCurrentRegionName (string regionName)
 Change the region name for the current region More...
 
unsafe void ChangeEntitiesColor (NXOpen.TaggedObject[] entities, int color)
 Change the color of displayable entities More...
 
unsafe void ChangeRegionFacesColor (string regionName, int allOrUndefined, int color)
 Change the color of the faces of a region More...
 
unsafe void ChangeRegionLayer (string regionName, int layer)
 Change the layer of the region More...
 
unsafe string CreateNewRegion ()
 Create a new region More...
 
unsafe void CreateNewRegionButton ()
 Button to create a new empty region More...
 
unsafe void DeleteAllExistingRegions ()
 Delete all existing regions More...
 
unsafe void DeleteRegion (string regionName)
 Delete a region More...
 
unsafe void DisplayProductBody ()
 Display the product body in the part file More...
 
unsafe string GetOrCreateEmptyRegion (out int created)
 Get or create an empty region More...
 
unsafe void HookupRegionUdoAndBodyForCavityAndCore ()
 Hook up cavity and core region UDO objects with the corresponding sheet bodies More...
 
unsafe void SearchRegionButton ()
 Button to invoke searching region More...
 
unsafe void SetCurrentRegion (string regionName)
 Set the current region More...
 
unsafe void SetupRegionsInfo ()
 Setup the UI data for defining regions More...
 
unsafe void UpdateUndefinedFaces (int changeColor)
 Update the undefined faces More...
 
unsafe void UpdateUnsewnBodiesNameAttribute (NXOpen.TaggedObject unsewFeatureTag, NXOpen.Face[] cavityFaces)
 Update name attribute for the unsew bodies of the cavity and core regions More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe bool CreatePartingLinesToggle [get, set]
 Returns or sets the create parting lines toggle More...
 
unsafe bool CreateRegionsToggle [get, set]
 Returns or sets the create regions toggle More...
 
unsafe NXOpen.NXColor FaceColor [get, set]
 Returns or sets the face color for the selected region faces More...
 
unsafe NXOpen.ScCollector SelectRegionFaces [get]
 Returns the region faces for defining region More...
 
unsafe
NXOpen.Tooling.MWDefineRegionsBuilder.TranslucencyOptionType 
TranslucencyOption [get, set]
 Returns or sets the translucency option for the selected or non-selected region faces More...
 
unsafe int TranslucencyValueScale [get, set]
 Returns or sets the translucency value for the selected or non-selected region faces More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> 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

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

Enumerator
SelectedFaces 

Selected region faces

OtherFaces 

Non-selected region faces

Member Function Documentation

unsafe int NXOpen.Tooling.MWDefineRegionsBuilder.ChangeCurrentRegionName ( string  regionName)
inline

Change the region name for the current region

Created in NX6.0.3

License requirements: None.

Parameters
regionNameregion name
Returns
return status
unsafe void NXOpen.Tooling.MWDefineRegionsBuilder.ChangeEntitiesColor ( NXOpen.TaggedObject[]  entities,
int  color 
)
inline

Change the color of displayable entities

Created in NX6.0.3

License requirements: None.

Parameters
entitiesan array of entities
colorcolor for entities
unsafe void NXOpen.Tooling.MWDefineRegionsBuilder.ChangeRegionFacesColor ( string  regionName,
int  allOrUndefined,
int  color 
)
inline

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
unsafe void NXOpen.Tooling.MWDefineRegionsBuilder.ChangeRegionLayer ( string  regionName,
int  layer 
)
inline

Change the layer of the region

Created in NX6.0.3

License requirements: None.

Parameters
regionNameregion name
layerlayer for region faces
unsafe string NXOpen.Tooling.MWDefineRegionsBuilder.CreateNewRegion ( )
inline

Create a new region

Created in NX6.0.3

License requirements: None.

Returns
new region object created
unsafe void NXOpen.Tooling.MWDefineRegionsBuilder.CreateNewRegionButton ( )
inline

Button to create a new empty region

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.Tooling.MWDefineRegionsBuilder.DeleteAllExistingRegions ( )
inline

Delete all existing regions

Created in NX6.0.3

License requirements: None.

unsafe void NXOpen.Tooling.MWDefineRegionsBuilder.DeleteRegion ( string  regionName)
inline

Delete a region

Created in NX6.0.3

License requirements: None.

Parameters
regionNameregion object to be deleted
unsafe void NXOpen.Tooling.MWDefineRegionsBuilder.DisplayProductBody ( )
inline

Display the product body in the part file

Created in NX6.0.3

License requirements: None.

unsafe string NXOpen.Tooling.MWDefineRegionsBuilder.GetOrCreateEmptyRegion ( out int  created)
inline

Get or create an empty region

Created in NX6.0.3

License requirements: None.

Returns
empty region object
Parameters
createdReturn flag indicating if an empty region UDO is created
unsafe void NXOpen.Tooling.MWDefineRegionsBuilder.HookupRegionUdoAndBodyForCavityAndCore ( )
inline

Hook up cavity and core region UDO objects with the corresponding sheet bodies

Created in NX6.0.3

License requirements: None.

unsafe void NXOpen.Tooling.MWDefineRegionsBuilder.SearchRegionButton ( )
inline

Button to invoke searching region

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.Tooling.MWDefineRegionsBuilder.SetCurrentRegion ( string  regionName)
inline

Set the current region

Created in NX6.0.3

License requirements: None.

Parameters
regionNamecurrent region name
unsafe void NXOpen.Tooling.MWDefineRegionsBuilder.SetupRegionsInfo ( )
inline

Setup the UI data for defining regions

Created in NX6.0.3

License requirements: None.

unsafe void NXOpen.Tooling.MWDefineRegionsBuilder.UpdateUndefinedFaces ( int  changeColor)
inline

Update the undefined faces

Created in NX6.0.3

License requirements: None.

Parameters
changeColorindicator for changing color too
unsafe void NXOpen.Tooling.MWDefineRegionsBuilder.UpdateUnsewnBodiesNameAttribute ( NXOpen.TaggedObject  unsewFeatureTag,
NXOpen.Face[]  cavityFaces 
)
inline

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

Property Documentation

unsafe bool NXOpen.Tooling.MWDefineRegionsBuilder.CreatePartingLinesToggle
getset

Returns or sets the create parting lines toggle

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Tooling.MWDefineRegionsBuilder.CreateRegionsToggle
getset

Returns or sets the create regions toggle

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.NXColor NXOpen.Tooling.MWDefineRegionsBuilder.FaceColor
getset

Returns or sets the face color for the selected region faces

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.ScCollector NXOpen.Tooling.MWDefineRegionsBuilder.SelectRegionFaces
get

Returns the region faces for defining region

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Tooling.MWDefineRegionsBuilder.TranslucencyOptionType NXOpen.Tooling.MWDefineRegionsBuilder.TranslucencyOption
getset

Returns or sets the translucency option for the selected or non-selected region faces

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Tooling.MWDefineRegionsBuilder.TranslucencyValueScale
getset

Returns or sets the translucency value for the selected or non-selected region faces

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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