NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::ViewDependentDisplayManager Class Reference

Represents all view dependent display operations
To obtain an instance of this class, refer to NXOpen::View

Created in NX5.0.0. More...

Public Types

enum  Font {
  FontInvisible, FontSolid, FontDashed, FontPhantom,
  FontCenterline, FontDotted, FontLongDashed, FontDottedDashed,
  FontObject
}
 specifies the font for wireframe edits
Created in NX5.0.0. More...
 
enum  PartialShading { PartialShadingNoChange, PartialShadingOriginal, PartialShadingNo, PartialShadingYes }
 specifies the partial shading options for shading edits
Created in NX5.0.0. More...
 
enum  Translucency { TranslucencyNoChange, TranslucencyOriginal, TranslucencyYes }
 specifies the translucency options for shading edits
Created in NX5.0.0. More...
 
enum  Width {
  WidthNormal, WidthThick, WidthThin, WidthObject,
  WidthOne = 5, WidthTwo, WidthThree, WidthFour,
  WidthFive, WidthSix, WidthSeven, WidthEight,
  WidthNine
}
 specifies the width for wireframe edits
Created in NX5.0.0. More...
 

Public Member Functions

void ApplySegmentEdit (NXOpen::DisplayableObject *object, NXOpen::NXColor *color, NXOpen::ViewDependentDisplayManager::Font font, NXOpen::ViewDependentDisplayManager::Width width, const std::vector< double > &segmentStart, const std::vector< double > &segmentEnd)
 Applies a wireframe edit to specified objects in a view. More...
 
void ApplySegmentEdit (NXOpen::DisplayableObject *object, NXOpen::ViewDependentDisplayManager::Font font, NXOpen::ViewDependentDisplayManager::Width width, const std::vector< double > &segmentStart, const std::vector< double > &segmentEnd)
 Applies a wireframe edit to specified objects in a view when the color is the original color
Created in NX6.0.3. More...
 
void ApplyShadeEdit (NXOpen::NXColor *shadeColor, NXOpen::ViewDependentDisplayManager::PartialShading partialShading, NXOpen::ViewDependentDisplayManager::Translucency translucencyOption, int translucencyScale, const std::vector< NXOpen::DisplayableObject * > &objects)
 Applies a shading edit to specified faces and/or bodies in a view. More...
 
void ApplyShadeEdit (NXOpen::ViewDependentDisplayManager::PartialShading partialShading, NXOpen::ViewDependentDisplayManager::Translucency translucencyOption, int translucencyScale, const std::vector< NXOpen::DisplayableObject * > &objects)
 Applies a shading edit to specified faces and/or bodies in a view when shade color is original color
Created in NX6.0.3. More...
 
void ApplyWireframeEdit (NXOpen::NXColor *color, NXOpen::ViewDependentDisplayManager::Font font, NXOpen::ViewDependentDisplayManager::Width width, const std::vector< NXOpen::DisplayableObject * > &objects)
 Applies a wireframe edit to specified objects in a view. More...
 
void ApplyWireframeEdit (NXOpen::ViewDependentDisplayManager::Font font, NXOpen::ViewDependentDisplayManager::Width width, const std::vector< NXOpen::DisplayableObject * > &objects)
 Applies a wireframe edit to specified objects in a view when the color is the original color
Created in NX6.0.3. More...
 
void Erase (const std::vector< NXOpen::DisplayableObject * > &objects)
 Erases specified objects in a view. More...
 
void MoveToModel (const std::vector< NXOpen::DisplayableObject * > &objects)
 Moves view objects to model. More...
 
void MoveToView (const std::vector< NXOpen::DisplayableObject * > &objects)
 Moves model objects to view. More...
 
void RemoveAllEdits ()
 Removes all edits and erasures from all objects in a view. More...
 
void RemoveEdit (const std::vector< NXOpen::DisplayableObject * > &objects)
 Removes edits from specified objects in a view. More...
 
void RemoveErasure (const std::vector< NXOpen::DisplayableObject * > &objects)
 Removes erasures from specified objects in a view. More...
 
void RemoveErasureOnObjectAndSubobjects (const std::vector< NXOpen::DisplayableObject * > &objects, bool removeFromSubObjects)
 Removes erasures from specified objects and optional subobjects in a view. More...
 
void SetBackground (const std::vector< NXOpen::DisplayableObject * > &objects)
 Sets visibility of background objects. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents all view dependent display operations
To obtain an instance of this class, refer to NXOpen::View

Created in NX5.0.0.


Member Enumeration Documentation

specifies the font for wireframe edits
Created in NX5.0.0.


Enumerator
FontInvisible 

invisible

FontSolid 

solid

FontDashed 

dashed

FontPhantom 

phantom

FontCenterline 

centerline

FontDotted 

dotted

FontLongDashed 

long dashed

FontDottedDashed 

dotted dashed

FontObject 

object

specifies the partial shading options for shading edits
Created in NX5.0.0.


Enumerator
PartialShadingNoChange 

no change

PartialShadingOriginal 

original

PartialShadingNo 

no

PartialShadingYes 

yes

specifies the translucency options for shading edits
Created in NX5.0.0.


Enumerator
TranslucencyNoChange 

no change

TranslucencyOriginal 

original

TranslucencyYes 

yes

specifies the width for wireframe edits
Created in NX5.0.0.


Enumerator
WidthNormal 

normal

WidthThick 

thick

WidthThin 

thin

WidthObject 

object

WidthOne 

one

WidthTwo 

two

WidthThree 

three

WidthFour 

four

WidthFive 

five

WidthSix 

six

WidthSeven 

seven

WidthEight 

eight

WidthNine 

nine

Member Function Documentation

void NXOpen::ViewDependentDisplayManager::ApplySegmentEdit ( NXOpen::DisplayableObject object,
NXOpen::NXColor color,
NXOpen::ViewDependentDisplayManager::Font  font,
NXOpen::ViewDependentDisplayManager::Width  width,
const std::vector< double > &  segmentStart,
const std::vector< double > &  segmentEnd 
)

Applies a wireframe edit to specified objects in a view.


Created in NX5.0.0.

License requirements : None

Parameters
objectobject
colorcolor
fontfont
widthwidth
segmentStartThe length of the segment_start and segment_end arrays must match.
segmentEndThe length of the segment_start and segment_end arrays must match.
void NXOpen::ViewDependentDisplayManager::ApplySegmentEdit ( NXOpen::DisplayableObject object,
NXOpen::ViewDependentDisplayManager::Font  font,
NXOpen::ViewDependentDisplayManager::Width  width,
const std::vector< double > &  segmentStart,
const std::vector< double > &  segmentEnd 
)

Applies a wireframe edit to specified objects in a view when the color is the original color
Created in NX6.0.3.



License requirements : None

Parameters
objectobject
fontfont
widthwidth
segmentStartThe length of the segment_start and segment_end arrays must match.
segmentEndThe length of the segment_start and segment_end arrays must match.
void NXOpen::ViewDependentDisplayManager::ApplyShadeEdit ( NXOpen::NXColor shadeColor,
NXOpen::ViewDependentDisplayManager::PartialShading  partialShading,
NXOpen::ViewDependentDisplayManager::Translucency  translucencyOption,
int  translucencyScale,
const std::vector< NXOpen::DisplayableObject * > &  objects 
)

Applies a shading edit to specified faces and/or bodies in a view.


Created in NX5.0.0.

License requirements : None

Parameters
shadeColorshade color
partialShadingpartial shading
translucencyOptiontranslucency option
translucencyScalenew translucency value in the range 0 to 100
objectsobjects
void NXOpen::ViewDependentDisplayManager::ApplyShadeEdit ( NXOpen::ViewDependentDisplayManager::PartialShading  partialShading,
NXOpen::ViewDependentDisplayManager::Translucency  translucencyOption,
int  translucencyScale,
const std::vector< NXOpen::DisplayableObject * > &  objects 
)

Applies a shading edit to specified faces and/or bodies in a view when shade color is original color
Created in NX6.0.3.



License requirements : None

Parameters
partialShadingpartial shading
translucencyOptiontranslucency option
translucencyScalenew translucency value in the range 0 to 100
objectsobjects
void NXOpen::ViewDependentDisplayManager::ApplyWireframeEdit ( NXOpen::NXColor color,
NXOpen::ViewDependentDisplayManager::Font  font,
NXOpen::ViewDependentDisplayManager::Width  width,
const std::vector< NXOpen::DisplayableObject * > &  objects 
)

Applies a wireframe edit to specified objects in a view.


Created in NX5.0.0.

License requirements : None

Parameters
colorcolor
fontfont
widthwidth
objectsobjects
void NXOpen::ViewDependentDisplayManager::ApplyWireframeEdit ( NXOpen::ViewDependentDisplayManager::Font  font,
NXOpen::ViewDependentDisplayManager::Width  width,
const std::vector< NXOpen::DisplayableObject * > &  objects 
)

Applies a wireframe edit to specified objects in a view when the color is the original color
Created in NX6.0.3.



License requirements : None

Parameters
fontfont
widthwidth
objectsobjects
void NXOpen::ViewDependentDisplayManager::Erase ( const std::vector< NXOpen::DisplayableObject * > &  objects)

Erases specified objects in a view.


Created in NX5.0.0.

License requirements : None

Parameters
objectsobjects
void NXOpen::ViewDependentDisplayManager::MoveToModel ( const std::vector< NXOpen::DisplayableObject * > &  objects)

Moves view objects to model.


Created in NX5.0.0.

License requirements : None

Parameters
objectsobjects
void NXOpen::ViewDependentDisplayManager::MoveToView ( const std::vector< NXOpen::DisplayableObject * > &  objects)

Moves model objects to view.


Created in NX5.0.0.

License requirements : None

Parameters
objectsobjects
void NXOpen::ViewDependentDisplayManager::RemoveAllEdits ( )

Removes all edits and erasures from all objects in a view.


Created in NX5.0.0.

License requirements : None

void NXOpen::ViewDependentDisplayManager::RemoveEdit ( const std::vector< NXOpen::DisplayableObject * > &  objects)

Removes edits from specified objects in a view.


Created in NX5.0.0.

License requirements : None

Parameters
objectsobjects
void NXOpen::ViewDependentDisplayManager::RemoveErasure ( const std::vector< NXOpen::DisplayableObject * > &  objects)

Removes erasures from specified objects in a view.


Deprecated:
Deprecated in NX11.0.0. Use NXOpen::ViewDependentDisplayManager::RemoveErasureOnObjectAndSubobjects instead.


Created in NX5.0.0.

License requirements : None

Parameters
objectsobjects
void NXOpen::ViewDependentDisplayManager::RemoveErasureOnObjectAndSubobjects ( const std::vector< NXOpen::DisplayableObject * > &  objects,
bool  removeFromSubObjects 
)

Removes erasures from specified objects and optional subobjects in a view.


Created in NX11.0.0.

License requirements : None

Parameters
objectsobjects
removeFromSubObjectsremovefromsubobjects
void NXOpen::ViewDependentDisplayManager::SetBackground ( const std::vector< NXOpen::DisplayableObject * > &  objects)

Sets visibility of background objects.


Created in NX5.0.0.

License requirements : None

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

Returns the tag of this object.


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