SimBCDisplay Class¶
-
class
NXOpen.CAE.
SimBCDisplay
¶ Bases:
NXOpen.TaggedObject
Represents 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 |
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 |
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
DisplayMagnitudeProperty()
Returns: 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
DisplayMagnitudeProperty(displayMagnitudeProperty)
Parameters: 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
DisplayMode()
Returns: the display mode Return type: NXOpen.CAE.SimBCDisplayMode
New in version NX4.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)
-------------------------------------
Setter Method
Signature
DisplayMode(displayMode)
Parameters: 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
DistValueDisplayFlag()
Returns: 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
DistValueDisplayFlag(valueFlag)
Parameters: 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
DofDisplayFlag()
Returns: 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
DofDisplayFlag(dofFlag)
Parameters: 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
GraphicSymbolDisplayFlag()
Returns: 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
GraphicSymbolDisplayFlag(graphicSymbolFlag)
Parameters: 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
GraphicsThreshold()
Returns: 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
GraphicsThreshold(threshold)
Parameters: 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
GraphicsThresholdFlag()
Returns: 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
GraphicsThresholdFlag(graphicsThresholdFlag)
Parameters: 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
HighlightTargets()
Returns: 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
HighlightTargets(highlightTargetsFlag)
Parameters: 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
NameDisplayFlag()
Returns: 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
NameDisplayFlag(nameFlag)
Parameters: 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
NodeIdDisplayFlag()
Returns: 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
NodeIdDisplayFlag(nodeIdFlag)
Parameters: 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”)
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
Scale()
Returns: 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
Scale(scale)
Parameters: 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
ShadeGraphicSymbol()
Returns: 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
ShadeGraphicSymbol(shadeGsymbolFlag)
Parameters: 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
SolverCardNameDisplayFlag()
Returns: 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
SolverCardNameDisplayFlag(solverCardNameFlag)
Parameters: 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
TextSymbolDisplayFlag()
Returns: 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
TextSymbolDisplayFlag(textSymbolFlag)
Parameters: 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”)
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
ValueDisplayFlag()
Returns: 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
ValueDisplayFlag(valueFlag)
Parameters: 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”)