DisplayManager Class

class NXOpen.DisplayManager

Bases: object

Represents an object to manage display settings.

Input to this class can be PSM facet objects. To obtain an instance of this class, refer to NXOpen.Session

New in version NX3.0.0.

Properties

Property Description
FacetCacheMemoryLevel Returns or sets the memory level of the display facet cache system.

Methods

Method Description
BlankObjects Blank a set of displayable objects.
GetJ3dData Returns the list of displayable entities along with display information for each entity in the displayed part.
GetJ3dGeometry Returns polygon/vector information for an entity
GetShowableHideableTypes Returns an array of all Registered ShowHideType strings.
HideByType Hides a set of objects by type.
MakeUpToDate Ensures that previously invoked display operations are complete.
NewDisplayModification Constructs a new NXOpen.DisplayModification object.
ShowAdjacent Display objects adjacent to a set of displayable objects(NXOpen.CAE.CAEFace, NXOpen.CAE.CAEEdge).
ShowByType Shows a set of objects by type.
ShowNodesRelatedToDisplayedElements Display all nodes related to displayed elements.
ShowObjects Unblank a set of displayable objects considering the following layer settings if the objects are in invisible layers.
ShowOnly Show a set of displayable objects.
UnblankObjects Unblank a set of displayable objects.

Enumerations

DisplayManagerFacetCacheMemoryLevelType Enumeration Facet cache memory level.
DisplayManagerLayerSetting Enumeration Represents the layer settings when the objects to show are in invisible layers
DisplayManagerShowHideScope Enumeration Controls the scope for the show hide operation.
DisplayManagerShowHideType Enumeration Controls the type of object to show or hide.

Structs

DisplayManagerJ3dColor_Struct Struct 3d interface color definition
DisplayManagerJ3dData_Struct Struct 3d interface structure
DisplayManagerJ3dMaterial_Struct Struct 3d interface material definition

Property Detail

FacetCacheMemoryLevel

DisplayManager.FacetCacheMemoryLevel

Returns or sets the memory level of the display facet cache system.

Facet cache memory level is used to manage the memory footprint of the display facet cache. Higher memory level implies higher memory footprint.

Facet caching can be turned off by setting the memory level to NXOpen.DisplayManagerFacetCacheMemoryLevelType.None. For all other memory levels, the display system will attempt to perform periodic cleanup if it detects that NX is experiencing memory pressure. The extent of cleanup depends on the memory level. Lower memory level indicates that more cleanup is desired to keep loweer memory footprint. Note that low memory level can slow down rendering performance due to absence of facet data in the facet cache.

-------------------------------------

Getter Method

Signature FacetCacheMemoryLevel

Returns:
Return type:NXOpen.DisplayManagerFacetCacheMemoryLevelType

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FacetCacheMemoryLevel

Parameters:memoryLevel (NXOpen.DisplayManagerFacetCacheMemoryLevelType) –

New in version NX10.0.0.

License requirements: None.

Method Detail

BlankObjects

DisplayManager.BlankObjects

Blank a set of displayable objects.

You may want to use NXOpen.View.FitAfterShowOrHide() after using this method. Some displayable objects are not valid for this method and, if found in the objects input, will be ignored. These include face and edge objects of solid bodies.

Signature BlankObjects(objects)

Parameters:objects (list of NXOpen.DisplayableObject) –

New in version NX3.0.0.

License requirements: None.

GetJ3dData

DisplayManager.GetJ3dData

Returns the list of displayable entities along with display information for each entity in the displayed part.

Signature GetJ3dData()

Returns:Array of entities and display data
Return type:list of NXOpen.DisplayManagerJ3dData_Struct

New in version NX5.0.0.

License requirements: None.

GetJ3dGeometry

DisplayManager.GetJ3dGeometry

Returns polygon/vector information for an entity

Signature GetJ3dGeometry(eid, tolerance, wireframe)

Parameters:
  • eid (NXOpen.DisplayableObject) – entity to tesselate
  • tolerance (float) – adjustment factor for tesselation tolerance
  • wireframe (bool) – if true generates wireframe solids
Returns:

a tuple
Return type:

A tuple consisting of (vectors, points, normals, pointsPerStrip) vectors is a bool. true if vector data produced points is a list of float. polygon/vector points normals is a list of float. polygon normals pointsPerStrip is a list of int. points for each triangle strip

New in version NX5.0.0.

License requirements: None.

GetShowableHideableTypes

DisplayManager.GetShowableHideableTypes

Returns an array of all Registered ShowHideType strings.

Signature GetShowableHideableTypes()

Returns:Registered ShowHideType strings.
Return type:list of str

New in version NX9.0.0.

License requirements: None.

HideByType

DisplayManager.HideByType

Overloaded method HideByType

  • HideByType(type, scope)
  • HideByType(type, scope)

-------------------------------------

Hides a set of objects by type. You may want to use NXOpen.View.FitAfterShowOrHide() after using this method.

Signature HideByType(type, scope)

Parameters:
Returns:

The number of objects hidden
Return type:

int

New in version NX5.0.0.

Deprecated since version NX9.0.0: Use NXOpen.DisplayManager.HideByType() that takes a string type instead. To find all registered ShowHideType string use NXOpen.DisplayManager.GetShowableHideableTypes()

License requirements: None.

-------------------------------------

Hides a set of objects by type. You may want to use NXOpen.View.FitAfterShowOrHide() after using this method.

Signature HideByType(type, scope)

Parameters:
Returns:

The number of objects hidden
Return type:

int

New in version NX9.0.0.

License requirements: None.

-------------------------------------

MakeUpToDate

DisplayManager.MakeUpToDate

Ensures that previously invoked display operations are complete.

Called only by NXOpen applications that directly invoke Windows, MFC, or Motif functions to display dialogs. This function is not needed when NXOpen dialogs are used.

Signature MakeUpToDate()

New in version NX3.0.0.

License requirements: None.

NewDisplayModification

DisplayManager.NewDisplayModification

Constructs a new NXOpen.DisplayModification object.

Signature NewDisplayModification()

Returns:The new DisplayModification instance
Return type:NXOpen.DisplayModification

New in version NX3.0.0.

License requirements: None.

ShowAdjacent

DisplayManager.ShowAdjacent

Display objects adjacent to a set of displayable objects(NXOpen.CAE.CAEFace, NXOpen.CAE.CAEEdge).

If NXOpen.CAE.CAEFace selected, display all it’s neighbouring faces and associated edges. If NXOpen.CAE.CAEEdge selected, display it’s associated faces and their associated edges.

Signature ShowAdjacent(objects)

Parameters:objects (list of NXOpen.DisplayableObject) –

New in version NX5.0.0.

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

ShowByType

DisplayManager.ShowByType

Overloaded method ShowByType

  • ShowByType(type, scope)
  • ShowByType(type, scope)

-------------------------------------

Shows a set of objects by type. You may want to use NXOpen.View.FitAfterShowOrHide() after using this method.

Signature ShowByType(type, scope)

Parameters:
Returns:

The number of objects shown
Return type:

int

New in version NX5.0.0.

Deprecated since version NX9.0.0: Use NXOpen.DisplayManager.ShowByType() that takes a string type instead.

License requirements: None.

-------------------------------------

Shows a set of objects by type. You may want to use NXOpen.View.FitAfterShowOrHide() after using this method.

Signature ShowByType(type, scope)

Parameters:
Returns:

The number of objects shown
Return type:

int

New in version NX9.0.0.

License requirements: None.

-------------------------------------

ShowNodesRelatedToDisplayedElements

DisplayManager.ShowNodesRelatedToDisplayedElements

Display all nodes related to displayed elements.

This function will do nothing if NXOpen.CAE.ModelDisplayBuilder has the node display mode set to NXOpen.CAE.ModelDisplayBuilderNodeDisplayModeType.Implicit

Signature ShowNodesRelatedToDisplayedElements(includeInteriorNodes)

Parameters:includeInteriorNodes (bool) –

New in version NX8.5.0.

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

ShowObjects

DisplayManager.ShowObjects

Unblank a set of displayable objects considering the following layer settings if the objects are in invisible layers.

  1. NXOpen.DisplayManagerLayerSetting.MoveObjectsToWorkLayer - The objects will be moved to work layer before unblanking the objects if they are in invisible layer.
  2. NXOpen.DisplayManagerLayerSetting.ChangeLayerToSelectable - The objects layer will be changed to selectable if the layer is invisible

Signature ShowObjects(objects, layerSetting)

Parameters:

New in version NX5.0.2.

License requirements: None.

ShowOnly

DisplayManager.ShowOnly

Show a set of displayable objects.

The objects selectable are: NXOpen.Curve, NXOpen.Point, NXOpen.CAE.MeshPoint, CSYS, NXOpen.Plane, Mesh, NXOpen.CAE.CAEBody, NXOpen.CAE.CAEFace, Load, Constraint and Simulation Object. You may want to use NXOpen.View.FitAfterShowOrHide() after using this method.

Signature ShowOnly(objects)

Parameters:objects (list of NXOpen.DisplayableObject) –

New in version NX5.0.0.

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

UnblankObjects

DisplayManager.UnblankObjects

Unblank a set of displayable objects.

You may want to use NXOpen.View.FitAfterShowOrHide() after using this method. Some displayable objects are not valid for this method and, if found in the objects input, will be ignored. These include face and edge objects of solid bodies.

Signature UnblankObjects(objects)

Parameters:objects (list of NXOpen.DisplayableObject) –

New in version NX3.0.0.

License requirements: None.