NXOpen::CAE::SimBCDisplay Class Reference

Represents a BC display attributes. More...

Inheritance diagram for NXOpen::CAE::SimBCDisplay:

Public Types
enum	Mode { ModeCollapse, ModeExpand, ModeOffset }
	Used to specify the display mode for the BC. More...

Public Member Functions
NXString	DisplayMagnitudeProperty ()
	Returns the neutral name of the property that will control the display Created in NX7.5.0. More...
NXOpen::CAE::SimBCDisplay::Mode	DisplayMode ()
	Returns the BC display mode Created in NX4.0.0. More...
bool	DistValueDisplayFlag ()
	Returns the true/false flag based on whether the distributed value of the BC is displayed in the graphics window Created in NX7.5.0. More...
bool	DofDisplayFlag ()
	Returns the true/false flag based on whether the dof of the BC is displayed in the graphics window Created in NX4.0.0. More...
void	GetDisplayGrid (int *numUPoints, int *numVPoints)
	Returns the number of sample points for BC display in first and second parametric direction for a face. More...
int	GraphicsThreshold ()
	Returns the number of graphic symbols after which the number of symbols in expanded mode will be reduced Created in NX8.5.0. More...
bool	GraphicsThresholdFlag ()
	Returns the true/false flag based on whether the graphics symbol display is to be simplified in expanded mode Created in NX8.5.0. More...
bool	GraphicSymbolDisplayFlag ()
	Returns the true/false flag based on whether the graphic symbol of the BC is displayed in the graphics window Created in NX4.0.0. More...
bool	HighlightTargets ()
	Returns the flag indicating whether or not highlighting of targets is required Created in NX5.0.0. More...
bool	NameDisplayFlag ()
	Returns the true/false flag based on whether the name of the BC is displayed in the graphics window Created in NX4.0.0. More...
bool	NodeIdDisplayFlag ()
	Returns the true/false flag based on whether the node id of the BC is displayed in the graphics window Created in NX4.0.0. More...
bool	RotateDisplayTextFlag ()
	Returns the true/false flag based on whether the text of the BC is rotated in the graphics window Created in NX11.0.0. More...
int	Scale ()
	Returns 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. More...
void	SetDisplayGrid (int numUPoints, int numVPoints)
	Sets the number of sample points for BC display in first and second parametric direction for a face. More...
void	SetDisplayMagnitudeProperty (const NXString &displayMagnitudeProperty)
	Sets the neutral name of the property that will control the display Created in NX7.5.0. More...
void	SetDisplayMagnitudeProperty (const char *displayMagnitudeProperty)
	Sets the neutral name of the property that will control the display Created in NX7.5.0. More...
void	SetDisplayMode (NXOpen::CAE::SimBCDisplay::Mode displayMode)
	Sets the BC display mode Created in NX4.0.0. More...
void	SetDistValueDisplayFlag (bool valueFlag)
	Sets the true/false flag based on whether the distributed value of the BC is displayed in the graphics window Created in NX7.5.0. More...
void	SetDofDisplayFlag (bool dofFlag)
	Sets the true/false flag based on whether the dof of the BC is displayed in the graphics window Created in NX4.0.0. More...
void	SetGraphicsThreshold (int threshold)
	Sets the number of graphic symbols after which the number of symbols in expanded mode will be reduced Created in NX8.5.0. More...
void	SetGraphicsThresholdFlag (bool graphicsThresholdFlag)
	Sets the true/false flag based on whether the graphics symbol display is to be simplified in expanded mode Created in NX8.5.0. More...
void	SetGraphicSymbolDisplayFlag (bool graphicSymbolFlag)
	Sets the true/false flag based on whether the graphic symbol of the BC is displayed in the graphics window Created in NX4.0.0. More...
void	SetHighlightTargets (bool highlightTargetsFlag)
	Sets the flag indicating whether or not highlighting of targets is required Created in NX5.0.0. More...
void	SetNameDisplayFlag (bool nameFlag)
	Sets the true/false flag based on whether the name of the BC is displayed in the graphics window Created in NX4.0.0. More...
void	SetNodeIdDisplayFlag (bool nodeIdFlag)
	Sets the true/false flag based on whether the node id of the BC is displayed in the graphics window Created in NX4.0.0. More...
void	SetRotateDisplayTextFlag (bool rotatedTextFlag)
	Sets the true/false flag based on whether the text of the BC is rotated in the graphics window Created in NX11.0.0. More...
void	SetScale (int scale)
	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. More...
void	SetShadeGraphicSymbol (bool shadeGsymbolFlag)
	Sets the flag indicating whether or not shading of graphic symbols is required Created in NX4.0.0. More...
void	SetSolverCardNameDisplayFlag (bool solverCardNameFlag)
	Sets the true/false flag based on whether the solver card name of the BC is displayed in the graphics window Created in NX4.0.0. More...
void	SetTextSymbolDisplayFlag (bool textSymbolFlag)
	Sets the true/false flag based on whether the text symbol of the BC is displayed in the graphics window Created in NX4.0.0. More...
void	SetTranslucency (int translucency)
	Sets the BC display translucency factor this option specifies the translucency of the BC display symbol. More...
void	SetValueDisplayFlag (bool valueFlag)
	Sets the true/false flag based on whether the value of the BC is displayed in the graphics window Created in NX4.0.0. More...
bool	ShadeGraphicSymbol ()
	Returns the flag indicating whether or not shading of graphic symbols is required Created in NX4.0.0. More...
bool	SolverCardNameDisplayFlag ()
	Returns the true/false flag based on whether the solver card name of the BC is displayed in the graphics window Created in NX4.0.0. More...
bool	TextSymbolDisplayFlag ()
	Returns the true/false flag based on whether the text symbol of the BC is displayed in the graphics window Created in NX4.0.0. More...
int	Translucency ()
	Returns the BC display translucency factor this option specifies the translucency of the BC display symbol. More...
void	UpdateDisplay ()
	Updates the display of the BC. More...
bool	ValueDisplayFlag ()
	Returns the true/false flag based on whether the value of the BC is displayed in the graphics window Created in NX4.0.0. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a BC display attributes.

Created in NX4.0.0.

Member Enumeration Documentation

enum NXOpen::CAE::SimBCDisplay::Mode

Used to specify the display mode for the BC.

Enumerator
ModeCollapse	Set a collapsed display mode.
ModeExpand	Set an expanded display mode.
ModeOffset	Set an offset display mode. Draw the edge BC display using an offset line along the BC target locations

Member Function Documentation

NXString NXOpen::CAE::SimBCDisplay::DisplayMagnitudeProperty

(

)

Returns the neutral name of the property that will control the display
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

NXOpen::CAE::SimBCDisplay::Mode NXOpen::CAE::SimBCDisplay::DisplayMode

(

)

Returns the BC display mode
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

bool NXOpen::CAE::SimBCDisplay::DistValueDisplayFlag

(

)

Returns the true/false flag based on whether the distributed value of the BC is displayed in the graphics window
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

bool NXOpen::CAE::SimBCDisplay::DofDisplayFlag

(

)

Returns the true/false flag based on whether the dof of the BC is displayed in the graphics window
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

void NXOpen::CAE::SimBCDisplay::GetDisplayGrid	(	int *	numUPoints,
		int *	numVPoints
	)

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.

Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

numUPoints	number of points in the first parametric direction
numVPoints	number of points in the second parametric direction

int NXOpen::CAE::SimBCDisplay::GraphicsThreshold

(

)

Returns the number of graphic symbols after which the number of symbols in expanded mode will be reduced
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

bool NXOpen::CAE::SimBCDisplay::GraphicsThresholdFlag

(

)

Returns the true/false flag based on whether the graphics symbol display is to be simplified in expanded mode
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

bool NXOpen::CAE::SimBCDisplay::GraphicSymbolDisplayFlag

(

)

Returns the true/false flag based on whether the graphic symbol of the BC is displayed in the graphics window
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

bool NXOpen::CAE::SimBCDisplay::HighlightTargets

(

)

Returns the flag indicating whether or not highlighting of targets is required
Created in NX5.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

bool NXOpen::CAE::SimBCDisplay::NameDisplayFlag

(

)

Returns the true/false flag based on whether the name of the BC is displayed in the graphics window
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

bool NXOpen::CAE::SimBCDisplay::NodeIdDisplayFlag

(

)

Returns the true/false flag based on whether the node id of the BC is displayed in the graphics window
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

bool NXOpen::CAE::SimBCDisplay::RotateDisplayTextFlag

(

)

Returns the true/false flag based on whether the text of the BC is rotated in the graphics window
Created in NX11.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

int NXOpen::CAE::SimBCDisplay::Scale

(

)

Returns 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.

Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

void NXOpen::CAE::SimBCDisplay::SetDisplayGrid	(	int	numUPoints,
		int	numVPoints
	)

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.

Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

numUPoints	number of points in the first parametric direction
numVPoints	number of points in the second parametric direction

void NXOpen::CAE::SimBCDisplay::SetDisplayMagnitudeProperty

(

const NXString &

displayMagnitudeProperty

)

Sets the neutral name of the property that will control the display
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

displayMagnitudeProperty

neutral name of existing property

void NXOpen::CAE::SimBCDisplay::SetDisplayMagnitudeProperty

(

const char *

displayMagnitudeProperty

)

Sets the neutral name of the property that will control the display
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

displayMagnitudeProperty

neutral name of existing property

void NXOpen::CAE::SimBCDisplay::SetDisplayMode

(

NXOpen::CAE::SimBCDisplay::Mode

displayMode

)

Sets the BC display mode
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

displayMode

the display mode

void NXOpen::CAE::SimBCDisplay::SetDistValueDisplayFlag

(

bool

valueFlag

)

Sets the true/false flag based on whether the distributed value of the BC is displayed in the graphics window
Created in NX7.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

valueFlag

true when the distributed values should be displayed, false otherwise

void NXOpen::CAE::SimBCDisplay::SetDofDisplayFlag

(

bool

dofFlag

)

Sets the true/false flag based on whether the dof of the BC is displayed in the graphics window
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

dofFlag

true when the dof should be displayed, false otherwise

void NXOpen::CAE::SimBCDisplay::SetGraphicsThreshold

(

int

threshold

)

Sets the number of graphic symbols after which the number of symbols in expanded mode will be reduced
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

threshold

The number of graphic symbols after which the number of symbols in expanded mode will be reduced

void NXOpen::CAE::SimBCDisplay::SetGraphicsThresholdFlag

(

bool

graphicsThresholdFlag

)

Sets the true/false flag based on whether the graphics symbol display is to be simplified in expanded mode
Created in NX8.5.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

graphicsThresholdFlag

true when graphics symbol display is to be simplified in expanded mode, false otherwise

void NXOpen::CAE::SimBCDisplay::SetGraphicSymbolDisplayFlag

(

bool

graphicSymbolFlag

)

Sets the true/false flag based on whether the graphic symbol of the BC is displayed in the graphics window
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

graphicSymbolFlag

true when the graphic symbol should be displayed, false otherwise

void NXOpen::CAE::SimBCDisplay::SetHighlightTargets

(

bool

highlightTargetsFlag

)

Sets the flag indicating whether or not highlighting of targets is required
Created in NX5.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

highlightTargetsFlag

true when highlighting is required, false otherwise

void NXOpen::CAE::SimBCDisplay::SetNameDisplayFlag

(

bool

nameFlag

)

Sets the true/false flag based on whether the name of the BC is displayed in the graphics window
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

nameFlag

true when the name should be displayed, false otherwise

void NXOpen::CAE::SimBCDisplay::SetNodeIdDisplayFlag

(

bool

nodeIdFlag

)

Sets the true/false flag based on whether the node id of the BC is displayed in the graphics window
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

nodeIdFlag

true when the node id should be displayed, false otherwise

void NXOpen::CAE::SimBCDisplay::SetRotateDisplayTextFlag

(

bool

rotatedTextFlag

)

Sets the true/false flag based on whether the text of the BC is rotated in the graphics window
Created in NX11.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

rotatedTextFlag

true when the text is rotated, false otherwise

void NXOpen::CAE::SimBCDisplay::SetScale

(

int

scale

)

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.

Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

scale

1 is the smallest - 100 is the largest

void NXOpen::CAE::SimBCDisplay::SetShadeGraphicSymbol

(

bool

shadeGsymbolFlag

)

Sets the flag indicating whether or not shading of graphic symbols is required
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

shadeGsymbolFlag

true when shading is required, false otherwise

void NXOpen::CAE::SimBCDisplay::SetSolverCardNameDisplayFlag

(

bool

solverCardNameFlag

)

Sets the true/false flag based on whether the solver card name of the BC is displayed in the graphics window
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

solverCardNameFlag

true when the solver card name should be displayed, false otherwise

void NXOpen::CAE::SimBCDisplay::SetTextSymbolDisplayFlag

(

bool

textSymbolFlag

)

Sets the true/false flag based on whether the text symbol of the BC is displayed in the graphics window
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

textSymbolFlag

true when the text symbol should be displayed, false otherwise

void NXOpen::CAE::SimBCDisplay::SetTranslucency

(

int

translucency

)

Sets the BC display translucency factor this option specifies the translucency of the BC display symbol.

Created in NX11.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

translucency

0 is the smallest (opaque) - 100 is the largest (translucent)

void NXOpen::CAE::SimBCDisplay::SetValueDisplayFlag

(

bool

valueFlag

)

Sets the true/false flag based on whether the value of the BC is displayed in the graphics window
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

valueFlag

true when the value should be displayed, false otherwise

bool NXOpen::CAE::SimBCDisplay::ShadeGraphicSymbol

(

)

Returns the flag indicating whether or not shading of graphic symbols is required
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

bool NXOpen::CAE::SimBCDisplay::SolverCardNameDisplayFlag

(

)

Returns the true/false flag based on whether the solver card name of the BC is displayed in the graphics window
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

bool NXOpen::CAE::SimBCDisplay::TextSymbolDisplayFlag

(

)

Returns the true/false flag based on whether the text symbol of the BC is displayed in the graphics window
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

int NXOpen::CAE::SimBCDisplay::Translucency

(

)

Returns the BC display translucency factor this option specifies the translucency of the BC display symbol.

Created in NX11.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

void NXOpen::CAE::SimBCDisplay::UpdateDisplay

(

)

Updates the display of the BC.

Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

bool NXOpen::CAE::SimBCDisplay::ValueDisplayFlag

(

)

Returns the true/false flag based on whether the value of the BC is displayed in the graphics window
Created in NX4.0.0.

License requirements : nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

---

The documentation for this class was generated from the following file:

• CAE_SimBCDisplay.hxx