NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions
NXOpen::DisplayManager Class Reference

Manages the display and changes to it
To obtain an instance of this class, refer to Session

Created in NX3.0.0. More...

List of all members.

Classes

struct  J3dColor
 3d interface color definition More...
struct  J3dData
 3d interface structure More...
struct  J3dMaterial
 3d interface material definition More...

Public Types

enum  LayerSetting { LayerSettingMoveObjectsToWorkLayer, LayerSettingChangeLayerToSelectable, LayerSettingInvalid }
 Represents the layer settings when the objects to show are in invisible layers. More...
enum  ShowHideScope { ShowHideScopeAnyInAssembly, ShowHideScopeWorkPartAndOccurrence }
 Controls the scope for the show hide operation. More...
enum  ShowHideType {
  ShowHideTypeAll, ShowHideTypeGeometry, ShowHideTypeBodies, ShowHideTypeComponents,
  ShowHideTypeSolidBodies, ShowHideTypeSheetBodies, ShowHideTypeFacetedBodies, ShowHideTypePolygonBodies,
  ShowHideTypeDatums, ShowHideTypePoints, ShowHideTypeDatumAxes, ShowHideTypeDatumPlanes,
  ShowHideTypeDatumPlaneGrids, ShowHideTypeEntitySelectionPlanes, ShowHideTypeCsys, ShowHideTypeSketches,
  ShowHideTypeCurves, ShowHideTypeInfiniteLines, ShowHideTypeDraftingAnnotations, ShowHideTypeDraftingDimensions,
  ShowHideTypeDraftingNotes, ShowHideTypeDraftingSymbols, ShowHideTypeDraftingGdt, ShowHideTypePmi,
  ShowHideTypePmiDimensions, ShowHideTypePmiNotes, ShowHideTypePmiSymbols, ShowHideTypePmiGdt,
  ShowHideTypeAssemblyConstraints, ShowHideTypePmiGeometry, ShowHideTypeCaeEntities, ShowHideTypeMeshes,
  ShowHideTypeMesh0d, ShowHideTypeMesh1d, ShowHideTypeMesh2d, ShowHideTypeMesh3d
}
 Controls the type of object to show or hide. More...

Public Member Functions

void BlankObjects (const std::vector< NXOpen::DisplayableObject * > &objects)
 Blank a set of displayable objects
Created in NX3.0.0.
std::vector
< NXOpen::DisplayManager::J3dData
GetJ3dData ()
 Returns the list of displayable entities along with display information for each entity in the displayed part.
bool GetJ3dGeometry (NXOpen::DisplayableObject *eid, double tolerance, bool wireframe, std::vector< double > &points, std::vector< double > &normals, std::vector< int > &pointsPerStrip)
 Returns polygon/vector information for an entity.
int HideByType (NXOpen::DisplayManager::ShowHideType type, NXOpen::DisplayManager::ShowHideScope scope)
 Hides a set of objects by type.
void MakeUpToDate ()
 Ensures that previously invoked display operations are complete.
NXOpen::DisplayModificationNewDisplayModification ()
 Constructs a new DisplayModification object.
void ShowAdjacent (const std::vector< NXOpen::DisplayableObject * > &objects)
 Display objects adjacent to a set of displayable objects(CAE::CAEFace , CAE::CAEEdge ).
int ShowByType (NXOpen::DisplayManager::ShowHideType type, NXOpen::DisplayManager::ShowHideScope scope)
 Shows a set of objects by type.
void ShowObjects (const std::vector< NXOpen::DisplayableObject * > &objects, NXOpen::DisplayManager::LayerSetting layerSetting)
 Unblank a set of displayable objects considering the following layer settings if the objects are in invisible layers.
void ShowOnly (const std::vector< NXOpen::DisplayableObject * > &objects)
 Show a set of displayable objects.
tag_t Tag () const
 Returns the tag of this object.
void UnblankObjects (const std::vector< NXOpen::DisplayableObject * > &objects)
 Unblank a set of displayable objects
Created in NX3.0.0.

Detailed Description

Manages the display and changes to it
To obtain an instance of this class, refer to Session

Created in NX3.0.0.



Member Enumeration Documentation

Represents the layer settings when the objects to show are in invisible layers.

Enumerator:
LayerSettingMoveObjectsToWorkLayer 

Move the objects to work layer if they are in invisible layer.

LayerSettingChangeLayerToSelectable 

Change the layer to selectable if it is invisible.

LayerSettingInvalid 

Last value, should not be used.

Controls the scope for the show hide operation.

See ShowByType and HideByType

Enumerator:
ShowHideScopeAnyInAssembly 

Show and hide objects from the entire displayed part.

ShowHideScopeWorkPartAndOccurrence 

Show and hide objects only from the work part and its children.

Controls the type of object to show or hide.

See ShowByType and HideByType

Enumerator:
ShowHideTypeAll 

Show or hide all of the following objects.

ShowHideTypeGeometry 

Show or hide all geometry objects.

This includes all bodies, components, and datums

ShowHideTypeBodies 

Show or hide all bodies.

This includes solid, sheet, and facetted bodies

ShowHideTypeComponents 

Show or hide components.

ShowHideTypeSolidBodies 

Show or hide solid bodies.

ShowHideTypeSheetBodies 

Show or hide sheet bodies.

ShowHideTypeFacetedBodies 

Show or hide faceted bodies.

ShowHideTypePolygonBodies 

Show or hide polygon bodies.

ShowHideTypeDatums 

Show or hide Datums i.e Coordinate Systems Datum Axes, Datum Planes, Datum Plane Grids, Points.

ShowHideTypePoints 

Show or hide points.

ShowHideTypeDatumAxes 

Show or hide datum axes.

ShowHideTypeDatumPlanes 

Show or hide datum planes.

ShowHideTypeDatumPlaneGrids 

Show or hide datum plane grids.

ShowHideTypeEntitySelectionPlanes 

Show or hide entity selection planes.

ShowHideTypeCsys 

Show or hide coordinate systems.

ShowHideTypeSketches 

Show or hide sketches.

ShowHideTypeCurves 

Show or hide curves.

ShowHideTypeInfiniteLines 

Show or hide infinite lines.

ShowHideTypeDraftingAnnotations 

Show or hide all drafting types.

This includes drafting notes, dimensions, symbols and gdt

ShowHideTypeDraftingDimensions 

Show or hide drafting dimensions.

ShowHideTypeDraftingNotes 

Show or hide drafting notes.

ShowHideTypeDraftingSymbols 

Show or hide drafting symbols.

ShowHideTypeDraftingGdt 

Show or hide drafting gdt.

ShowHideTypePmi 

Show or hide all pmi types.

This includes pmi notes, dimensions, symbols and gdt

ShowHideTypePmiDimensions 

Show or hide pmi dimensions.

ShowHideTypePmiNotes 

Show or hide pmi notes.

ShowHideTypePmiSymbols 

Show or hide pmi symbols.

ShowHideTypePmiGdt 

Show or hide pmi gdt.

ShowHideTypeAssemblyConstraints 

Show or hide assembly constraints.

ShowHideTypePmiGeometry 

Show or hide pmi geometry.

ShowHideTypeCaeEntities 

cae entities

ShowHideTypeMeshes 

meshes

ShowHideTypeMesh0d 

mesh0d

ShowHideTypeMesh1d 

mesh1d

ShowHideTypeMesh2d 

mesh2d

ShowHideTypeMesh3d 

mesh3d


Member Function Documentation

void NXOpen::DisplayManager::BlankObjects ( const std::vector< NXOpen::DisplayableObject * > &  objects)

Blank a set of displayable objects
Created in NX3.0.0.



License requirements : None

Parameters:
objectsobjects

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

Returns:
Array of entities and display data
Created in NX5.0.0.

License requirements : None
bool NXOpen::DisplayManager::GetJ3dGeometry ( NXOpen::DisplayableObject eid,
double  tolerance,
bool  wireframe,
std::vector< double > &  points,
std::vector< double > &  normals,
std::vector< int > &  pointsPerStrip 
)

Returns polygon/vector information for an entity.

Returns:
true if vector data produced
Created in NX5.0.0.

License requirements : None
Parameters:
eidentity to tesselate
toleranceadjustment factor for tesselation tolerance
wireframeif true generates wireframe solids
pointspolygon/vector points
normalspolygon normals
pointsPerStrippoints for each triangle strip

Hides a set of objects by type.

Returns:
The number of objects hidden
Created in NX5.0.0.

License requirements : None
Parameters:
typeThe type of object to hide
scopeThe scope for the show hide operation

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.


Created in NX3.0.0.

License requirements : None

Constructs a new DisplayModification object.

Returns:
The new DisplayModification instance
Created in NX3.0.0.

License requirements : None
void NXOpen::DisplayManager::ShowAdjacent ( const std::vector< NXOpen::DisplayableObject * > &  objects)

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

If CAE::CAEFace selected, display all it's neighbouring faces and associated edges. If CAE::CAEEdge selected, display it's associated faces and their associated edges.
Created in NX5.0.0.

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

Parameters:
objectsobjects

Shows a set of objects by type.

Returns:
The number of objects shown
Created in NX5.0.0.

License requirements : None
Parameters:
typeThe type of object to show
scopeThe scope for the show hide operation
void NXOpen::DisplayManager::ShowObjects ( const std::vector< NXOpen::DisplayableObject * > &  objects,
NXOpen::DisplayManager::LayerSetting  layerSetting 
)

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

  1. DisplayManager::LayerSettingMoveObjectsToWorkLayer - The objects will be moved to work layer before unblanking the objects if they are in invisible layer.
  2. DisplayManager::LayerSettingChangeLayerToSelectable - The objects layer will be changed to selectable if the layer is invisible


Created in NX5.0.2.

License requirements : None

Parameters:
objectsobjects
layerSettingLayer setting option
void NXOpen::DisplayManager::ShowOnly ( const std::vector< NXOpen::DisplayableObject * > &  objects)

Show a set of displayable objects.

The objects selectable are: Curve , Point , CAE::MeshPoint , CSYS, Plane , Mesh, CAE::CAEBody , CAE::CAEFace , Load, Constraint and Simulation Object
Created in NX5.0.0.

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

Parameters:
objectsobjects
tag_t NXOpen::DisplayManager::Tag ( ) const

Returns the tag of this object.

void NXOpen::DisplayManager::UnblankObjects ( const std::vector< NXOpen::DisplayableObject * > &  objects)

Unblank a set of displayable objects
Created in NX3.0.0.



License requirements : None

Parameters:
objectsobjects

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