SimBCDisplay Class¶
-
class
NXOpen.CAE.SimBCDisplay¶ Bases:
NXOpen.TaggedObjectRepresents a BC display attributes
New in version NX4.0.0.
Properties¶
| Property | Description |
|---|---|
| DisplayMagnitudeProperty | Returns or sets the neutral name of the property that will control the display |
| DisplayMode | Returns or sets the BC display mode |
| DistValueDisplayFlag | Returns or sets the true/false flag based on whether the distributed value of the BC is displayed in the graphics window |
| DofDisplayFlag | Returns or sets the true/false flag based on whether the dof of the BC is displayed in the graphics window |
| GraphicSymbolDisplayFlag | Returns or sets the true/false flag based on whether the graphic symbol of the BC is displayed in the graphics window |
| GraphicsThreshold | Returns or sets the number of graphic symbols after which the number of symbols in expanded mode will be reduced |
| GraphicsThresholdFlag | Returns or sets the true/false flag based on whether the graphics symbol display is to be simplified in expanded mode |
| HighlightTargets | Returns or sets the flag indicating whether or not highlighting of targets is required |
| NameDisplayFlag | Returns or sets the true/false flag based on whether the name of the BC is displayed in the graphics window |
| NodeIdDisplayFlag | Returns or sets the true/false flag based on whether the node id of the BC is displayed in the graphics window |
| RotateDisplayTextFlag | Returns or sets the true/false flag based on whether the text of the BC is rotated in the graphics window |
| Scale | Returns or sets the BC display scaling factor this option specifies the scale of the graphic symbol relative to the size of the bounding box of the FE model. |
| ShadeGraphicSymbol | Returns or sets the flag indicating whether or not shading of graphic symbols is required |
| SolverCardNameDisplayFlag | Returns or sets the true/false flag based on whether the solver card name of the BC is displayed in the graphics window |
| Tag | Returns the Tag for this object. |
| TextSymbolDisplayFlag | Returns or sets the true/false flag based on whether the text symbol of the BC is displayed in the graphics window |
| Translucency | Returns or sets the BC display translucency factor this option specifies the translucency of the BC display symbol. |
| ValueDisplayFlag | Returns or sets the true/false flag based on whether the value of the BC is displayed in the graphics window |
Methods¶
| Method | Description |
|---|---|
| GetDisplayGrid | Returns the number of sample points for BC display in first and second parametric direction for a face. |
| SetDisplayGrid | Sets the number of sample points for BC display in first and second parametric direction for a face. |
| UpdateDisplay | Updates the display of the BC |
Enumerations¶
| SimBCDisplayMode Enumeration | Used to specify the display mode for the BC |
Property Detail¶
DisplayMagnitudeProperty¶
-
SimBCDisplay.DisplayMagnitudeProperty¶ Returns or sets the neutral name of the property that will control the display
-------------------------------------Getter Method
Signature
DisplayMagnitudePropertyReturns: neutral name of existing property Return type: str New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
DisplayMagnitudePropertyParameters: displayMagnitudeProperty (str) – neutral name of existing property New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
DisplayMode¶
-
SimBCDisplay.DisplayMode¶ Returns or sets the BC display mode
-------------------------------------Getter Method
Signature
DisplayModeReturns: the display mode Return type: NXOpen.CAE.SimBCDisplayModeNew in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
DisplayModeParameters: displayMode ( NXOpen.CAE.SimBCDisplayMode) – the display modeNew in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
DistValueDisplayFlag¶
-
SimBCDisplay.DistValueDisplayFlag¶ Returns or sets the true/false flag based on whether the distributed value of the BC is displayed in the graphics window
-------------------------------------Getter Method
Signature
DistValueDisplayFlagReturns: true when the distributed values are displayed, false otherwise Return type: bool New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
DistValueDisplayFlagParameters: valueFlag (bool) – true when the distributed values should be displayed, false otherwise New in version NX7.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
DofDisplayFlag¶
-
SimBCDisplay.DofDisplayFlag¶ Returns or sets the true/false flag based on whether the dof of the BC is displayed in the graphics window
-------------------------------------Getter Method
Signature
DofDisplayFlagReturns: true when the dof is displayed, false otherwise Return type: bool New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
DofDisplayFlagParameters: dofFlag (bool) – true when the dof should be displayed, false otherwise New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
GraphicSymbolDisplayFlag¶
-
SimBCDisplay.GraphicSymbolDisplayFlag¶ Returns or sets the true/false flag based on whether the graphic symbol of the BC is displayed in the graphics window
-------------------------------------Getter Method
Signature
GraphicSymbolDisplayFlagReturns: true when the graphic symbol is displayed, false otherwise Return type: bool New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
GraphicSymbolDisplayFlagParameters: graphicSymbolFlag (bool) – true when the graphic symbol should be displayed, false otherwise New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
GraphicsThreshold¶
-
SimBCDisplay.GraphicsThreshold¶ Returns or sets the number of graphic symbols after which the number of symbols in expanded mode will be reduced
-------------------------------------Getter Method
Signature
GraphicsThresholdReturns: The number of graphic symbols after which the number of symbols in expanded mode will be reduced Return type: int New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
GraphicsThresholdParameters: threshold (int) – The number of graphic symbols after which the number of symbols in expanded mode will be reduced New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
GraphicsThresholdFlag¶
-
SimBCDisplay.GraphicsThresholdFlag¶ Returns or sets the true/false flag based on whether the graphics symbol display is to be simplified in expanded mode
-------------------------------------Getter Method
Signature
GraphicsThresholdFlagReturns: true when graphics symbol display is to be simplified in expanded mode, false otherwise Return type: bool New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
GraphicsThresholdFlagParameters: graphicsThresholdFlag (bool) – true when graphics symbol display is to be simplified in expanded mode, false otherwise New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
HighlightTargets¶
-
SimBCDisplay.HighlightTargets¶ Returns or sets the flag indicating whether or not highlighting of targets is required
-------------------------------------Getter Method
Signature
HighlightTargetsReturns: true when highlighting is required, false otherwise Return type: bool New in version NX5.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
HighlightTargetsParameters: highlightTargetsFlag (bool) – true when highlighting is required, false otherwise New in version NX5.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
NameDisplayFlag¶
-
SimBCDisplay.NameDisplayFlag¶ Returns or sets the true/false flag based on whether the name of the BC is displayed in the graphics window
-------------------------------------Getter Method
Signature
NameDisplayFlagReturns: true when the name is displayed, false otherwise Return type: bool New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
NameDisplayFlagParameters: nameFlag (bool) – true when the name should be displayed, false otherwise New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
NodeIdDisplayFlag¶
-
SimBCDisplay.NodeIdDisplayFlag¶ Returns or sets the true/false flag based on whether the node id of the BC is displayed in the graphics window
-------------------------------------Getter Method
Signature
NodeIdDisplayFlagReturns: true when the node id is displayed, false otherwise Return type: bool New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
NodeIdDisplayFlagParameters: nodeIdFlag (bool) – true when the node id should be displayed, false otherwise New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
RotateDisplayTextFlag¶
-
SimBCDisplay.RotateDisplayTextFlag¶ Returns or sets the true/false flag based on whether the text of the BC is rotated in the graphics window
-------------------------------------Getter Method
Signature
RotateDisplayTextFlagReturns: true when the text is rotated, false otherwise Return type: bool New in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
RotateDisplayTextFlagParameters: rotatedTextFlag (bool) – true when the text is rotated, false otherwise New in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Scale¶
-
SimBCDisplay.Scale¶ Returns or sets the BC display scaling factor this option specifies the scale of the graphic symbol relative to the size of the bounding box of the FE model.
-------------------------------------Getter Method
Signature
ScaleReturns: 1 is the smallest - 100 is the largest Return type: int New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
ScaleParameters: scale (int) – 1 is the smallest - 100 is the largest New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
ShadeGraphicSymbol¶
-
SimBCDisplay.ShadeGraphicSymbol¶ Returns or sets the flag indicating whether or not shading of graphic symbols is required
-------------------------------------Getter Method
Signature
ShadeGraphicSymbolReturns: true when shading is required, false otherwise Return type: bool New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
ShadeGraphicSymbolParameters: shadeGsymbolFlag (bool) – true when shading is required, false otherwise New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SolverCardNameDisplayFlag¶
-
SimBCDisplay.SolverCardNameDisplayFlag¶ Returns or sets the true/false flag based on whether the solver card name of the BC is displayed in the graphics window
-------------------------------------Getter Method
Signature
SolverCardNameDisplayFlagReturns: true when the solver card name is displayed, false otherwise Return type: bool New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
SolverCardNameDisplayFlagParameters: solverCardNameFlag (bool) – true when the solver card name should be displayed, false otherwise New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
TextSymbolDisplayFlag¶
-
SimBCDisplay.TextSymbolDisplayFlag¶ Returns or sets the true/false flag based on whether the text symbol of the BC is displayed in the graphics window
-------------------------------------Getter Method
Signature
TextSymbolDisplayFlagReturns: true when the text symbol is displayed, false otherwise Return type: bool New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
TextSymbolDisplayFlagParameters: textSymbolFlag (bool) – true when the text symbol should be displayed, false otherwise New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Translucency¶
-
SimBCDisplay.Translucency¶ Returns or sets the BC display translucency factor this option specifies the translucency of the BC display symbol.
-------------------------------------Getter Method
Signature
TranslucencyReturns: 0 is the smallest (opaque) - 100 is the largest (translucent) Return type: int New in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
TranslucencyParameters: translucency (int) – 0 is the smallest (opaque) - 100 is the largest (translucent) New in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
ValueDisplayFlag¶
-
SimBCDisplay.ValueDisplayFlag¶ Returns or sets the true/false flag based on whether the value of the BC is displayed in the graphics window
-------------------------------------Getter Method
Signature
ValueDisplayFlagReturns: true when the value is displayed, false otherwise Return type: bool New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------Setter Method
Signature
ValueDisplayFlagParameters: valueFlag (bool) – true when the value should be displayed, false otherwise New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
Method Detail¶
GetDisplayGrid¶
-
SimBCDisplay.GetDisplayGrid¶ Returns the number of sample points for BC display in first and second parametric direction for a face.
In case of an edge/curve only the first parametric direction applies.
Signature
GetDisplayGrid()Returns: a tuple Return type: A tuple consisting of (numUPoints, numVPoints) numUPoints is a int. number of points in the first parametric direction numVPoints is a int. number of points in the second parametric direction New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
SetDisplayGrid¶
-
SimBCDisplay.SetDisplayGrid¶ Sets the number of sample points for BC display in first and second parametric direction for a face.
In case of an edge/curve only the first parametric direction applies.
Signature
SetDisplayGrid(numUPoints, numVPoints)Parameters: - numUPoints (int) – number of points in the first parametric direction
- numVPoints (int) – number of points in the second parametric direction
New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)