NX Open C++ Reference Guide
Public Member Functions
NXOpen::DisplayModification Class Reference

Represents changes to the display characteristics of an object
Created in NX3.0.0. More...

Inheritance diagram for NXOpen::DisplayModification:
NXOpen::TransientObject

List of all members.

Public Member Functions

void Apply (const std::vector< NXOpen::DisplayableObject * > &objects)
 Apply this display modification to a set of objects
Created in NX3.0.0.
bool ApplyToAllFaces ()
 Returns the apply to all faces flag.
bool ApplyToOwningParts ()
 Returns the flag to apply display changes to Owning Parts.
bool FaceAnalysisMode ()
 Returns the face analysis mode flag.
void GetNewGrid (int *uGrid, int *vGrid)
 Get grid count for objects which will be modified.
bool KnotDisplayState ()
 Returns the flag for knot display.
int NewColor ()
 Returns a new color for objects which will be modified.
NXOpen::DisplayableObject::ObjectFont NewFont ()
 Returns a new font (line style) for objects which will be modified
Created in NX3.0.0.
int NewLayer ()
 Returns a new layer for objects which will be modified.
int NewTranslucency ()
 Returns a new translucency value for objects which will be modified.
NXOpen::DisplayableObject::ObjectWidth NewWidth ()
 Returns a new line width for objects which will be modified
Created in NX3.0.0.
bool PartiallyShaded ()
 Returns the partial shading flag.
bool PoleDisplayState ()
 Returns the flag for pole display.
void SetApplyToAllFaces (bool apply)
 Sets the apply to all faces flag.
void SetApplyToOwningParts (bool apply)
 Sets the flag to apply display changes to Owning Parts.
void SetFaceAnalysisMode (bool on)
 Sets the face analysis mode flag.
void SetKnotDisplayState (bool on)
 Sets the flag for knot display.
void SetNewColor (int newColor)
 Sets a new color for objects which will be modified.
void SetNewFont (NXOpen::DisplayableObject::ObjectFont newFont)
 Sets a new font (line style) for objects which will be modified
Created in NX3.0.0.
void SetNewGrid (int uGrid, int vGrid)
 Set a new grid count for objects which will be modified.
void SetNewLayer (int layer)
 Sets a new layer for objects which will be modified.
void SetNewTranslucency (int translucency)
 Sets a new translucency value for objects which will be modified.
void SetNewWidth (NXOpen::DisplayableObject::ObjectWidth newWidth)
 Sets a new line width for objects which will be modified
Created in NX3.0.0.
void SetPartiallyShaded (bool on)
 Sets the partial shading flag.
void SetPoleDisplayState (bool on)
 Sets the flag for pole display.
virtual ~DisplayModification ()
 Free resources associated with the instance.

Detailed Description

Represents changes to the display characteristics of an object
Created in NX3.0.0.



Constructor & Destructor Documentation

Free resources associated with the instance.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX3.0.0.

License requirements : None


Member Function Documentation

void NXOpen::DisplayModification::Apply ( const std::vector< NXOpen::DisplayableObject * > &  objects)

Apply this display modification to a set of objects
Created in NX3.0.0.



License requirements : None

Parameters:
objectsobjects to be modified

Returns the apply to all faces flag.

Specifies whether the modification should apply to all faces of any bodies to which this is applied.
Created in NX3.0.0.

License requirements : None

Returns the flag to apply display changes to Owning Parts.

Specifies whether the display modifications should apply to the owning parts of the selected objects.
Created in NX7.5.0.

License requirements : None

Returns the face analysis mode flag.

Only applies to faces.
Created in NX3.0.0.

License requirements : None

void NXOpen::DisplayModification::GetNewGrid ( int *  uGrid,
int *  vGrid 
)

Get grid count for objects which will be modified.

Only applies to faces.
Created in NX3.0.0.

License requirements : None

Parameters:
uGridnumber of grid lines in the u direction
vGridnumber of grid lines in the v direction

Returns the flag for knot display.

Only applies to b-spline.
Created in NX5.0.0.

License requirements : None

Returns a new color for objects which will be modified.

This is in the range from 1 to 216.
The methods in NXOpen.UF.UFObj can be used to convert RGB values to the NX color index.


Created in NX3.0.0.

License requirements : None

Returns a new font (line style) for objects which will be modified
Created in NX3.0.0.



License requirements : None

Returns a new layer for objects which will be modified.


Created in NX3.0.0.

License requirements : None

Returns a new translucency value for objects which will be modified.

Only applies to faces.
Created in NX3.0.0.

License requirements : None

Returns a new line width for objects which will be modified
Created in NX3.0.0.



License requirements : None

Returns the partial shading flag.

Only applies to faces.
Created in NX3.0.0.

License requirements : None

Returns the flag for pole display.

Only applies to b-spline.
Created in NX5.0.0.

License requirements : None

Sets the apply to all faces flag.

Specifies whether the modification should apply to all faces of any bodies to which this is applied.
Created in NX3.0.0.

License requirements : None

Parameters:
applytrue to apply the modification to all faces

Sets the flag to apply display changes to Owning Parts.

Specifies whether the display modifications should apply to the owning parts of the selected objects.
Created in NX7.5.0.

License requirements : None

Parameters:
applytrue to apply the display property changes to the owning parts

Sets the face analysis mode flag.

Only applies to faces.
Created in NX3.0.0.

License requirements : None

Parameters:
ontrue to enable face analysis mode

Sets the flag for knot display.

Only applies to b-spline.
Created in NX5.0.0.

License requirements : None

Parameters:
ontrue to enable knot display

Sets a new color for objects which will be modified.

This is in the range from 1 to 216.
The methods in NXOpen.UF.UFObj can be used to convert RGB values to the NX color index.


Created in NX3.0.0.

License requirements : None

Parameters:
newColornew color value

Sets a new font (line style) for objects which will be modified
Created in NX3.0.0.



License requirements : None

Parameters:
newFontnew font
void NXOpen::DisplayModification::SetNewGrid ( int  uGrid,
int  vGrid 
)

Set a new grid count for objects which will be modified.


Created in NX3.0.0.

License requirements : None

Parameters:
uGridnumber of grid lines in the u direction
vGridnumber of grid lines in the v direction

Sets a new layer for objects which will be modified.


Created in NX3.0.0.

License requirements : None

Parameters:
layernew layer, must be a valid layer number

Sets a new translucency value for objects which will be modified.

Only applies to faces.
Created in NX3.0.0.

License requirements : None

Parameters:
translucencynew translucency value in the range 0 to 100

Sets a new line width for objects which will be modified
Created in NX3.0.0.



License requirements : None

Parameters:
newWidthnew line width

Sets the partial shading flag.

Only applies to faces.
Created in NX3.0.0.

License requirements : None

Parameters:
ontrue for partial shading on

Sets the flag for pole display.

Only applies to b-spline.
Created in NX5.0.0.

License requirements : None

Parameters:
ontrue to enable pole display

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