ModelDisplayBuilder Class¶
-
class
NXOpen.CAE.
ModelDisplayBuilder
¶ Bases:
NXOpen.Builder
This class provides Model Display Data Support
To create a new instance of this class, use
NXOpen.CAE.CaePart.CreateModelDisplayBuilder
Default values.
Property Value ElemMaterialDisplayLaminateColor 181 ElemMaterialDisplayNoMaterialColor 130 ElemQualFailColor 186 ElemQualFailShadedBorderColor 130 ElemQualPassColor 50 ElemQualPassTranslucency 0 ElemQualPassType Shaded ElementColorCycler Default ElementDisplayQuality Fine ElementSelectInternal 1 GeomDisplayFreeEdges 0 GeomDisplayStitchedEdges 0 GeomFreeEdgeColor 186 GeomFreeEdgeEndMarker Circle GeomFreeEdgeFont Solid GeomFreeEdgeLineWidth Thick GeomStitchedEdgeColor 186 GeomStitchedEdgeEndMarker Circle GeomStitchedEdgeFont Solid GeomStitchedEdgeLineWidth Thick NodeMarker None NodeSelectInternal 1 NodeUnattachedMarker Asterisk New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
ElemMaterialDisplayLaminateColor | Returns or sets the element material laminate element color |
ElemMaterialDisplayNoMaterialColor | Returns or sets the element material no material element color |
ElemQualFailColor | Returns or sets the element quality check failing element color |
ElemQualFailShadedBorderColor | Returns or sets the element quality check failing shaded element border color |
ElemQualPassColor | Returns or sets the element quality check passing element color |
ElemQualPassTranslucency | Returns or sets the element quality check passing element translucency. |
ElemQualPassType | Returns or sets the element quality check passing element display type |
ElementColorCycler | Returns or sets the element color cycler basis |
ElementDisplayQuality | Returns or sets the element display quality setting |
ElementSelectInternal | Returns or sets the element select internal switch |
GeomDisplayFreeEdges | Returns or sets the geometry display free edges switch |
GeomDisplayStitchedEdges | Returns or sets the geometry display stitched edges switch |
GeomFreeEdgeColor | Returns or sets the geometry display free edges color |
GeomFreeEdgeEndMarker | Returns or sets the marker for endpoints of geometry free edges |
GeomFreeEdgeFont | Returns or sets the geometry free edge font |
GeomFreeEdgeLineWidth | Returns or sets the geometry free edge line width |
GeomStitchedEdgeColor | Returns or sets the geometry display stitched edges color |
GeomStitchedEdgeEndMarker | Returns or sets the marker for endpoints of geometry stitched edges |
GeomStitchedEdgeFont | Returns or sets the geometry stitched edge font |
GeomStitchedEdgeLineWidth | Returns or sets the geometry stitched edge line width |
NodeColor | Returns or sets the node color |
NodeDisplayMode | Returns or sets the node display mode type |
NodeMarker | Returns or sets the node marker display symbol type |
NodeMeshShowHideOption | Returns or sets the nodes to include for meshes in the show and hide commands |
NodeSelectInternal | Returns or sets the node select internal switch |
NodeUnattachedMarker | Returns or sets the unattached node marker display symbol type |
Tag | Returns the Tag for this object. |
UnattachedNodesInBoundingBoxRatio | Returns or sets the include unattached nodes in fit switch |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
SetColorsOnMeshes | This method will set the colors from the current element color cycler on all of the meshes in the model. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ModelDisplayBuilderElemQualPass Enumeration | specifies display style for elements which pass the element quality check |
ModelDisplayBuilderElmClrBasis Enumeration | Indicates element color basis. |
ModelDisplayBuilderElmDispQuality Enumeration | Indicates element display quality. |
ModelDisplayBuilderFreeEdgeFont Enumeration | specifies the object font for geometry free edges |
ModelDisplayBuilderFreeEdgeMarker Enumeration | specifies the marker for endpoints of geometry free edges |
ModelDisplayBuilderFreeEdgeWidth Enumeration | specifies object width for display for geometry free edges |
ModelDisplayBuilderNodeDisplayModeType Enumeration | Indicates node display mode type. |
ModelDisplayBuilderNodeMarkerType Enumeration | Indicates node marker display symbol type. |
ModelDisplayBuilderNodeMeshShowHideOptionType Enumeration | Indicates which nodes to include for meshes in show and hide commands. |
ModelDisplayBuilderNodeUnattachedMarkerType Enumeration | Indicates unattached node marker display symbol type. |
ModelDisplayBuilderStitchedEdgeFont Enumeration | specifies the object font for geometry free edges |
ModelDisplayBuilderStitchedEdgeMarker Enumeration | specifies the marker for endpoints of geometry free edges |
ModelDisplayBuilderStitchedEdgeWidth Enumeration | specifies object width for display for geometry stitched edges |
Property Detail¶
ElemMaterialDisplayLaminateColor¶
-
ModelDisplayBuilder.
ElemMaterialDisplayLaminateColor
¶ Returns or sets the element material laminate element color
-------------------------------------
Getter Method
Signature
ElemMaterialDisplayLaminateColor()
Returns: Return type: Id New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
ElemMaterialDisplayLaminateColor(elemMaterialDisplayLaminateColor)
Parameters: elemMaterialDisplayLaminateColor (Id) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
ElemMaterialDisplayNoMaterialColor¶
-
ModelDisplayBuilder.
ElemMaterialDisplayNoMaterialColor
¶ Returns or sets the element material no material element color
-------------------------------------
Getter Method
Signature
ElemMaterialDisplayNoMaterialColor()
Returns: Return type: Id New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
ElemMaterialDisplayNoMaterialColor(elemMaterialDisplayNoMaterialColor)
Parameters: elemMaterialDisplayNoMaterialColor (Id) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
ElemQualFailColor¶
-
ModelDisplayBuilder.
ElemQualFailColor
¶ Returns or sets the element quality check failing element color
-------------------------------------
Getter Method
Signature
ElemQualFailColor()
Returns: Return type: Id New in version NX8.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
ElemQualFailColor(elemQualFailColor)
Parameters: elemQualFailColor (Id) – New in version NX8.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
ElemQualFailShadedBorderColor¶
-
ModelDisplayBuilder.
ElemQualFailShadedBorderColor
¶ Returns or sets the element quality check failing shaded element border color
-------------------------------------
Getter Method
Signature
ElemQualFailShadedBorderColor()
Returns: Return type: Id New in version NX8.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
ElemQualFailShadedBorderColor(elemQualFailShadedBorderColor)
Parameters: elemQualFailShadedBorderColor (Id) – New in version NX8.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
ElemQualPassColor¶
-
ModelDisplayBuilder.
ElemQualPassColor
¶ Returns or sets the element quality check passing element color
-------------------------------------
Getter Method
Signature
ElemQualPassColor()
Returns: Return type: Id New in version NX8.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
ElemQualPassColor(elemQualPassColor)
Parameters: elemQualPassColor (Id) – New in version NX8.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
ElemQualPassTranslucency¶
-
ModelDisplayBuilder.
ElemQualPassTranslucency
¶ Returns or sets the element quality check passing element translucency.
The range is 0-100.
-------------------------------------
Getter Method
Signature
ElemQualPassTranslucency()
Returns: Return type: int New in version NX8.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
ElemQualPassTranslucency(elemQualPassTranslucency)
Parameters: elemQualPassTranslucency (int) – New in version NX8.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
ElemQualPassType¶
-
ModelDisplayBuilder.
ElemQualPassType
¶ Returns or sets the element quality check passing element display type
-------------------------------------
Getter Method
Signature
ElemQualPassType()
Returns: Return type: NXOpen.CAE.ModelDisplayBuilderElemQualPass
New in version NX8.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
ElemQualPassType(elemQualPassType)
Parameters: elemQualPassType ( NXOpen.CAE.ModelDisplayBuilderElemQualPass
) –New in version NX8.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
ElementColorCycler¶
-
ModelDisplayBuilder.
ElementColorCycler
¶ Returns or sets the element color cycler basis
-------------------------------------
Getter Method
Signature
ElementColorCycler()
Returns: Return type: NXOpen.CAE.ModelDisplayBuilderElmClrBasis
New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
ElementColorCycler(elementColorCycler)
Parameters: elementColorCycler ( NXOpen.CAE.ModelDisplayBuilderElmClrBasis
) –New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
ElementDisplayQuality¶
-
ModelDisplayBuilder.
ElementDisplayQuality
¶ Returns or sets the element display quality setting
-------------------------------------
Getter Method
Signature
ElementDisplayQuality()
Returns: Return type: NXOpen.CAE.ModelDisplayBuilderElmDispQuality
New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
ElementDisplayQuality(elementDisplayQuality)
Parameters: elementDisplayQuality ( NXOpen.CAE.ModelDisplayBuilderElmDispQuality
) –New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
ElementSelectInternal¶
-
ModelDisplayBuilder.
ElementSelectInternal
¶ Returns or sets the element select internal switch
-------------------------------------
Getter Method
Signature
ElementSelectInternal()
Returns: Return type: bool New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
ElementSelectInternal(elementSelectInternal)
Parameters: elementSelectInternal (bool) – New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
GeomDisplayFreeEdges¶
-
ModelDisplayBuilder.
GeomDisplayFreeEdges
¶ Returns or sets the geometry display free edges switch
-------------------------------------
Getter Method
Signature
GeomDisplayFreeEdges()
Returns: Return type: bool New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
GeomDisplayFreeEdges(geomDisplayFreeEdges)
Parameters: geomDisplayFreeEdges (bool) – New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
GeomDisplayStitchedEdges¶
-
ModelDisplayBuilder.
GeomDisplayStitchedEdges
¶ Returns or sets the geometry display stitched edges switch
-------------------------------------
Getter Method
Signature
GeomDisplayStitchedEdges()
Returns: Return type: bool New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
GeomDisplayStitchedEdges(geomDisplayStitchedEdges)
Parameters: geomDisplayStitchedEdges (bool) – New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
GeomFreeEdgeColor¶
-
ModelDisplayBuilder.
GeomFreeEdgeColor
¶ Returns or sets the geometry display free edges color
-------------------------------------
Getter Method
Signature
GeomFreeEdgeColor()
Returns: Return type: Id New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
GeomFreeEdgeColor(geomFreeEdgeColor)
Parameters: geomFreeEdgeColor (Id) – New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
GeomFreeEdgeEndMarker¶
-
ModelDisplayBuilder.
GeomFreeEdgeEndMarker
¶ Returns or sets the marker for endpoints of geometry free edges
-------------------------------------
Getter Method
Signature
GeomFreeEdgeEndMarker()
Returns: Return type: NXOpen.CAE.ModelDisplayBuilderFreeEdgeMarker
New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
GeomFreeEdgeEndMarker(freeEdgeEndpointMarker)
Parameters: freeEdgeEndpointMarker ( NXOpen.CAE.ModelDisplayBuilderFreeEdgeMarker
) –New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
GeomFreeEdgeFont¶
-
ModelDisplayBuilder.
GeomFreeEdgeFont
¶ Returns or sets the geometry free edge font
-------------------------------------
Getter Method
Signature
GeomFreeEdgeFont()
Returns: Return type: NXOpen.CAE.ModelDisplayBuilderFreeEdgeFont
New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
GeomFreeEdgeFont(freeEdgeFont)
Parameters: freeEdgeFont ( NXOpen.CAE.ModelDisplayBuilderFreeEdgeFont
) –New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
GeomFreeEdgeLineWidth¶
-
ModelDisplayBuilder.
GeomFreeEdgeLineWidth
¶ Returns or sets the geometry free edge line width
-------------------------------------
Getter Method
Signature
GeomFreeEdgeLineWidth()
Returns: Return type: NXOpen.CAE.ModelDisplayBuilderFreeEdgeWidth
New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
GeomFreeEdgeLineWidth(freeEdgeWidth)
Parameters: freeEdgeWidth ( NXOpen.CAE.ModelDisplayBuilderFreeEdgeWidth
) –New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
GeomStitchedEdgeColor¶
-
ModelDisplayBuilder.
GeomStitchedEdgeColor
¶ Returns or sets the geometry display stitched edges color
-------------------------------------
Getter Method
Signature
GeomStitchedEdgeColor()
Returns: Return type: Id New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
GeomStitchedEdgeColor(geomStitchedEdgeColor)
Parameters: geomStitchedEdgeColor (Id) – New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
GeomStitchedEdgeEndMarker¶
-
ModelDisplayBuilder.
GeomStitchedEdgeEndMarker
¶ Returns or sets the marker for endpoints of geometry stitched edges
-------------------------------------
Getter Method
Signature
GeomStitchedEdgeEndMarker()
Returns: Return type: NXOpen.CAE.ModelDisplayBuilderStitchedEdgeMarker
New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
GeomStitchedEdgeEndMarker(geomStitchedEdgeEndpointMarker)
Parameters: geomStitchedEdgeEndpointMarker ( NXOpen.CAE.ModelDisplayBuilderStitchedEdgeMarker
) –New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
GeomStitchedEdgeFont¶
-
ModelDisplayBuilder.
GeomStitchedEdgeFont
¶ Returns or sets the geometry stitched edge font
-------------------------------------
Getter Method
Signature
GeomStitchedEdgeFont()
Returns: Return type: NXOpen.CAE.ModelDisplayBuilderStitchedEdgeFont
New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
GeomStitchedEdgeFont(geomStitchedEdgeFont)
Parameters: geomStitchedEdgeFont ( NXOpen.CAE.ModelDisplayBuilderStitchedEdgeFont
) –New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
GeomStitchedEdgeLineWidth¶
-
ModelDisplayBuilder.
GeomStitchedEdgeLineWidth
¶ Returns or sets the geometry stitched edge line width
-------------------------------------
Getter Method
Signature
GeomStitchedEdgeLineWidth()
Returns: Return type: NXOpen.CAE.ModelDisplayBuilderStitchedEdgeWidth
New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
GeomStitchedEdgeLineWidth(geomStitchedEdgeWidth)
Parameters: geomStitchedEdgeWidth ( NXOpen.CAE.ModelDisplayBuilderStitchedEdgeWidth
) –New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
NodeColor¶
-
ModelDisplayBuilder.
NodeColor
¶ Returns or sets the node color
-------------------------------------
Getter Method
Signature
NodeColor()
Returns: Return type: Id New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
NodeColor(nodeColor)
Parameters: nodeColor (Id) – New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
NodeDisplayMode¶
-
ModelDisplayBuilder.
NodeDisplayMode
¶ Returns or sets the node display mode type
-------------------------------------
Getter Method
Signature
NodeDisplayMode()
Returns: Return type: NXOpen.CAE.ModelDisplayBuilderNodeDisplayModeType
New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
NodeDisplayMode(nodeDisplayMode)
Parameters: nodeDisplayMode ( NXOpen.CAE.ModelDisplayBuilderNodeDisplayModeType
) –New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
NodeMarker¶
-
ModelDisplayBuilder.
NodeMarker
¶ Returns or sets the node marker display symbol type
-------------------------------------
Getter Method
Signature
NodeMarker()
Returns: Return type: NXOpen.CAE.ModelDisplayBuilderNodeMarkerType
New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
NodeMarker(nodeMarker)
Parameters: nodeMarker ( NXOpen.CAE.ModelDisplayBuilderNodeMarkerType
) –New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
NodeMeshShowHideOption¶
-
ModelDisplayBuilder.
NodeMeshShowHideOption
¶ Returns or sets the nodes to include for meshes in the show and hide commands
-------------------------------------
Getter Method
Signature
NodeMeshShowHideOption()
Returns: Return type: NXOpen.CAE.ModelDisplayBuilderNodeMeshShowHideOptionType
New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
NodeMeshShowHideOption(nodeMeshShowHideOption)
Parameters: nodeMeshShowHideOption ( NXOpen.CAE.ModelDisplayBuilderNodeMeshShowHideOptionType
) –New in version NX9.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
NodeSelectInternal¶
-
ModelDisplayBuilder.
NodeSelectInternal
¶ Returns or sets the node select internal switch
-------------------------------------
Getter Method
Signature
NodeSelectInternal()
Returns: Return type: bool New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
NodeSelectInternal(nodeSelectInternal)
Parameters: nodeSelectInternal (bool) – New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
NodeUnattachedMarker¶
-
ModelDisplayBuilder.
NodeUnattachedMarker
¶ Returns or sets the unattached node marker display symbol type
-------------------------------------
Getter Method
Signature
NodeUnattachedMarker()
Returns: Return type: NXOpen.CAE.ModelDisplayBuilderNodeUnattachedMarkerType
New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
NodeUnattachedMarker(nodeUnattachedMarker)
Parameters: nodeUnattachedMarker ( NXOpen.CAE.ModelDisplayBuilderNodeUnattachedMarkerType
) –New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
UnattachedNodesInBoundingBoxRatio¶
-
ModelDisplayBuilder.
UnattachedNodesInBoundingBoxRatio
¶ Returns or sets the include unattached nodes in fit switch
-------------------------------------
Getter Method
Signature
UnattachedNodesInBoundingBoxRatio()
Returns: Return type: float New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
UnattachedNodesInBoundingBoxRatio(unattachedNodesInBoundingBoxRatio)
Parameters: unattachedNodesInBoundingBoxRatio (float) – New in version NX10.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
Method Detail¶
SetColorsOnMeshes¶
-
ModelDisplayBuilder.
SetColorsOnMeshes
¶ This method will set the colors from the current element color cycler on all of the meshes in the model.
Signature
SetColorsOnMeshes()
New in version NX7.5.1.
License requirements: nx_masterfem (“Finite Element Modeling”)
Validate¶
-
ModelDisplayBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.