NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAE::ModelDisplayBuilder Class Reference

This class provides Model Display Data Support
To create a new instance of this class, use CAE::CaePart::CreateModelDisplayBuilder
Default values. More...

Inheritance diagram for NXOpen::CAE::ModelDisplayBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  ElemQualPass { ElemQualPassShaded, ElemQualPassWireframe }
 specifies display style for elements which pass the element quality check More...
enum  ElmClrBasis {
  ElmClrBasisDefault, ElmClrBasisPhysicalPropertyTable, ElmClrBasisMaterialPropertyTable, ElmClrBasisElemCollContainer,
  ElmClrBasisElemColl, ElmClrBasisElemQualityCheck
}
 Indicates element color basis. More...
enum  ElmDispQuality { ElmDispQualityCoarse, ElmDispQualityMedium, ElmDispQualityFine }
 Indicates element display quality. More...
enum  FreeEdgeFont {
  FreeEdgeFontSolid, FreeEdgeFontDashed, FreeEdgeFontPhantom, FreeEdgeFontCenterline,
  FreeEdgeFontDotted, FreeEdgeFontLongDashed, FreeEdgeFontDottedDashed
}
 specifies the object font for geometry free edges
Created in NX7.5.2. More...
enum  FreeEdgeMarker {
  FreeEdgeMarkerNone, FreeEdgeMarkerPlus, FreeEdgeMarkerDot, FreeEdgeMarkerAsterisk,
  FreeEdgeMarkerCircle, FreeEdgeMarkerPoundsign, FreeEdgeMarkerCross, FreeEdgeMarkerSquare,
  FreeEdgeMarkerTriangle, FreeEdgeMarkerDiamond, FreeEdgeMarkerCenterLine
}
 specifies the marker for endpoints of geometry free edges
Created in NX7.5.2. More...
enum  FreeEdgeWidth { FreeEdgeWidthThin, FreeEdgeWidthNormal, FreeEdgeWidthThick }
 specifies object width for display for geometry free edges
Created in NX7.5.2. More...
enum  NodeMarkerType { NodeMarkerTypeNone, NodeMarkerTypeDot, NodeMarkerTypeAsterisk }
 Indicates node marker display symbol type. More...
enum  NodeUnattachedMarkerType { NodeUnattachedMarkerTypeNone, NodeUnattachedMarkerTypeDot, NodeUnattachedMarkerTypeAsterisk }
 Indicates unattached node marker display symbol type. More...

Public Member Functions

NXOpen::CAE::ModelDisplayBuilder::ElmClrBasis ElementColorCycler ()
 Returns the element color cycler basis
Created in NX7.5.0.
NXOpen::CAE::ModelDisplayBuilder::ElmDispQuality ElementDisplayQuality ()
 Returns the element display quality setting
Created in NX7.5.0.
bool ElementSelectInternal ()
 Returns the element select internal switch
Created in NX7.5.0.
bool ElementShadedEdgeDisplay ()
 Returns the display element shaded edge visibility setting.
NXOpen::NXColorElemQualFailColor ()
 Returns the element quality check failing element color
Created in NX8.0.0.
NXOpen::NXColorElemQualFailShadedBorderColor ()
 Returns the element quality check failing shaded element border color
Created in NX8.0.0.
NXOpen::NXColorElemQualPassColor ()
 Returns the element quality check passing element color
Created in NX8.0.0.
int ElemQualPassTranslucency ()
 Returns the element quality check passing element translucency.
NXOpen::CAE::ModelDisplayBuilder::ElemQualPass ElemQualPassType ()
 Returns the element quality check passing element display type
Created in NX8.0.0.
bool GeomDisplayFreeEdges ()
 Returns the geometry display free edges switch
Created in NX7.5.0.
NXOpen::NXColorGeomFreeEdgeColor ()
 Returns the geometry display free edges color
Created in NX7.5.2.
NXOpen::CAE::ModelDisplayBuilder::FreeEdgeMarker GeomFreeEdgeEndMarker ()
 Returns the marker for endpoints of geometry free edges
Created in NX7.5.2.
NXOpen::CAE::ModelDisplayBuilder::FreeEdgeFont GeomFreeEdgeFont ()
 Returns the geometry free edge font
Created in NX7.5.2.
NXOpen::CAE::ModelDisplayBuilder::FreeEdgeWidth GeomFreeEdgeLineWidth ()
 Returns the geometry free edge line width
Created in NX7.5.2.
NXOpen::NXColorNodeColor ()
 Returns the node color
Created in NX7.5.0.
NXOpen::CAE::ModelDisplayBuilder::NodeMarkerType NodeMarker ()
 Returns the node marker display symbol type
Created in NX7.5.0.
bool NodeSelectInternal ()
 Returns the node select internal switch
Created in NX7.5.0.
NXOpen::CAE::ModelDisplayBuilder::NodeUnattachedMarkerType NodeUnattachedMarker ()
 Returns the unattached node marker display symbol type
Created in NX7.5.0.
void SetColorsOnMeshes ()
 This method will set the colors from the current element color cycler on all of the meshes in the model.
void SetElementColorCycler (NXOpen::CAE::ModelDisplayBuilder::ElmClrBasis elementColorCycler)
 Sets the element color cycler basis
Created in NX7.5.0.
void SetElementDisplayQuality (NXOpen::CAE::ModelDisplayBuilder::ElmDispQuality elementDisplayQuality)
 Sets the element display quality setting
Created in NX7.5.0.
void SetElementSelectInternal (bool elementSelectInternal)
 Sets the element select internal switch
Created in NX7.5.0.
void SetElementShadedEdgeDisplay (bool visibility)
 Sets the display element shaded edge visibility setting.
void SetElemQualFailColor (NXOpen::NXColor *elemQualFailColor)
 Sets the element quality check failing element color
Created in NX8.0.0.
void SetElemQualFailShadedBorderColor (NXOpen::NXColor *elemQualFailShadedBorderColor)
 Sets the element quality check failing shaded element border color
Created in NX8.0.0.
void SetElemQualPassColor (NXOpen::NXColor *elemQualPassColor)
 Sets the element quality check passing element color
Created in NX8.0.0.
void SetElemQualPassTranslucency (int elemQualPassTranslucency)
 Sets the element quality check passing element translucency.
void SetElemQualPassType (NXOpen::CAE::ModelDisplayBuilder::ElemQualPass elemQualPassType)
 Sets the element quality check passing element display type
Created in NX8.0.0.
void SetGeomDisplayFreeEdges (bool geomDisplayFreeEdges)
 Sets the geometry display free edges switch
Created in NX7.5.0.
void SetGeomFreeEdgeColor (NXOpen::NXColor *geomFreeEdgeColor)
 Sets the geometry display free edges color
Created in NX7.5.2.
void SetGeomFreeEdgeEndMarker (NXOpen::CAE::ModelDisplayBuilder::FreeEdgeMarker freeEdgeEndpointMarker)
 Sets the marker for endpoints of geometry free edges
Created in NX7.5.2.
void SetGeomFreeEdgeFont (NXOpen::CAE::ModelDisplayBuilder::FreeEdgeFont freeEdgeFont)
 Sets the geometry free edge font
Created in NX7.5.2.
void SetGeomFreeEdgeLineWidth (NXOpen::CAE::ModelDisplayBuilder::FreeEdgeWidth freeEdgeWidth)
 Sets the geometry free edge line width
Created in NX7.5.2.
void SetNodeColor (NXOpen::NXColor *nodeColor)
 Sets the node color
Created in NX7.5.0.
void SetNodeMarker (NXOpen::CAE::ModelDisplayBuilder::NodeMarkerType nodeMarker)
 Sets the node marker display symbol type
Created in NX7.5.0.
void SetNodeSelectInternal (bool nodeSelectInternal)
 Sets the node select internal switch
Created in NX7.5.0.
void SetNodeUnattachedMarker (NXOpen::CAE::ModelDisplayBuilder::NodeUnattachedMarkerType nodeUnattachedMarker)
 Sets the unattached node marker display symbol type
Created in NX7.5.0.

Detailed Description

This class provides Model Display Data Support
To create a new instance of this class, use CAE::CaePart::CreateModelDisplayBuilder
Default values.

Property Value

ElemQualFailColor

186

ElemQualFailShadedBorderColor

130

ElemQualPassColor

50

ElemQualPassTranslucency

0

ElemQualPassType

Shaded

ElementColorCycler

Default

ElementDisplayQuality

Fine

ElementSelectInternal

1

GeomDisplayFreeEdges

0

GeomFreeEdgeColor

186

GeomFreeEdgeEndMarker

Circle

GeomFreeEdgeFont

Solid

GeomFreeEdgeLineWidth

Thick

NodeMarker

None

NodeSelectInternal

1

NodeUnattachedMarker

Asterisk


Created in NX7.5.0.


Member Enumeration Documentation

specifies display style for elements which pass the element quality check

Enumerator:
ElemQualPassShaded 

Draw passing elements shaded.

ElemQualPassWireframe 

Draw passing elements wireframe.

Indicates element color basis.

Enumerator:
ElmClrBasisDefault 

Default.

ElmClrBasisPhysicalPropertyTable 

Physical Property Table.

ElmClrBasisMaterialPropertyTable 

Material Property Table.

ElmClrBasisElemCollContainer 

Mesh Collector Property Table.

ElmClrBasisElemColl 

Mesh Property Table.

ElmClrBasisElemQualityCheck 

Element Quality Check.

Indicates element display quality.

Enumerator:
ElmDispQualityCoarse 

Coarse.

ElmDispQualityMedium 

Medium.

ElmDispQualityFine 

Fine.

specifies the object font for geometry free edges
Created in NX7.5.2.


Enumerator:
FreeEdgeFontSolid 

Solid font.

FreeEdgeFontDashed 

Dashed font.

FreeEdgeFontPhantom 

Phantom font.

FreeEdgeFontCenterline 

Centerline font.

FreeEdgeFontDotted 

Dotted font.

FreeEdgeFontLongDashed 

Long dashed font.

FreeEdgeFontDottedDashed 

Dotted dashed font.

specifies the marker for endpoints of geometry free edges
Created in NX7.5.2.


Enumerator:
FreeEdgeMarkerNone 

No marker.

FreeEdgeMarkerPlus 

Plus marker.

FreeEdgeMarkerDot 

Dot marker.

FreeEdgeMarkerAsterisk 

Asterisk marker.

FreeEdgeMarkerCircle 

Circle marker.

FreeEdgeMarkerPoundsign 

Pound sign marker.

FreeEdgeMarkerCross 

Cross marker.

FreeEdgeMarkerSquare 

Square marker.

FreeEdgeMarkerTriangle 

Triangle marker.

FreeEdgeMarkerDiamond 

Diamond marker.

FreeEdgeMarkerCenterLine 

Center line marker.

specifies object width for display for geometry free edges
Created in NX7.5.2.


Enumerator:
FreeEdgeWidthThin 

Thin.

FreeEdgeWidthNormal 

Normal.

FreeEdgeWidthThick 

Thick.

Indicates node marker display symbol type.

Enumerator:
NodeMarkerTypeNone 

None.

NodeMarkerTypeDot 

Dot.

NodeMarkerTypeAsterisk 

Asterisk.

Indicates unattached node marker display symbol type.

Enumerator:
NodeUnattachedMarkerTypeNone 

None.

NodeUnattachedMarkerTypeDot 

Dot.

NodeUnattachedMarkerTypeAsterisk 

Asterisk.


Member Function Documentation

Returns the element color cycler basis
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the element display quality setting
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the element select internal switch
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the display element shaded edge visibility setting.

After setting the element shaded edge visibility setting, you must call DisplayableObject::RedisplayObject in order for the change to take effect.
Created in NX8.0.1.

License requirements : nx_masterfem ("Finite Element Modeling")

Returns the element quality check failing element color
Created in NX8.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the element quality check failing shaded element border color
Created in NX8.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the element quality check passing element color
Created in NX8.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the element quality check passing element translucency.

The range is 0-100.
Created in NX8.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Returns the element quality check passing element display type
Created in NX8.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the geometry display free edges switch
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the geometry display free edges color
Created in NX7.5.2.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the marker for endpoints of geometry free edges
Created in NX7.5.2.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the geometry free edge font
Created in NX7.5.2.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the geometry free edge line width
Created in NX7.5.2.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the node color
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the node marker display symbol type
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the node select internal switch
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Returns the unattached node marker display symbol type
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

This method will set the colors from the current element color cycler on all of the meshes in the model.


Created in NX7.5.1.

License requirements : nx_masterfem ("Finite Element Modeling")

Sets the element color cycler basis
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
elementColorCyclerelementcolorcycler

Sets the element display quality setting
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
elementDisplayQualityelementdisplayquality
void NXOpen::CAE::ModelDisplayBuilder::SetElementSelectInternal ( bool  elementSelectInternal)

Sets the element select internal switch
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
elementSelectInternalelementselectinternal

Sets the display element shaded edge visibility setting.

After setting the element shaded edge visibility setting, you must call DisplayableObject::RedisplayObject in order for the change to take effect.
Created in NX8.0.1.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
visibilityvisibility

Sets the element quality check failing element color
Created in NX8.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
elemQualFailColorelemqualfailcolor

Sets the element quality check failing shaded element border color
Created in NX8.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
elemQualFailShadedBorderColorelemqualfailshadedbordercolor

Sets the element quality check passing element color
Created in NX8.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
elemQualPassColorelemqualpasscolor
void NXOpen::CAE::ModelDisplayBuilder::SetElemQualPassTranslucency ( int  elemQualPassTranslucency)

Sets the element quality check passing element translucency.

The range is 0-100.
Created in NX8.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
elemQualPassTranslucencyelemqualpasstranslucency

Sets the element quality check passing element display type
Created in NX8.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
elemQualPassTypeelemqualpasstype
void NXOpen::CAE::ModelDisplayBuilder::SetGeomDisplayFreeEdges ( bool  geomDisplayFreeEdges)

Sets the geometry display free edges switch
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
geomDisplayFreeEdgesgeomdisplayfreeedges

Sets the geometry display free edges color
Created in NX7.5.2.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
geomFreeEdgeColorgeomfreeedgecolor

Sets the marker for endpoints of geometry free edges
Created in NX7.5.2.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
freeEdgeEndpointMarkerfreeedgeendpointmarker

Sets the geometry free edge font
Created in NX7.5.2.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
freeEdgeFontfreeedgefont

Sets the geometry free edge line width
Created in NX7.5.2.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
freeEdgeWidthfreeedgewidth

Sets the node color
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
nodeColornodecolor

Sets the node marker display symbol type
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
nodeMarkernodemarker

Sets the node select internal switch
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
nodeSelectInternalnodeselectinternal

Sets the unattached node marker display symbol type
Created in NX7.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters:
nodeUnattachedMarkernodeunattachedmarker

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