DisplayModification Class

class NXOpen.DisplayModification

Bases: NXOpen.TransientObject

Represents changes to the display characteristics of an object.

Input to this class can be PSM facet objects.

New in version NX3.0.0.

Properties

Property Description
ApplyToAllFaces Returns or sets the apply to all faces flag.
ApplyToOwningParts Returns or sets the flag to apply display changes to Owning Parts.
FaceAnalysisMode Returns or sets the face analysis mode flag.
KnotDisplayState Returns or sets the flag for knot display.
NewColor Returns or sets a new color for objects which will be modified.
NewFont Returns or sets a new font (line style) for objects which will be modified
NewLayer Returns or sets a new layer for objects which will be modified.
NewTranslucency Returns or sets a new translucency value for objects which will be modified.
NewWidth Returns or sets a new line width for objects which will be modified
PartiallyShaded Returns or sets the partial shading flag.
PoleDisplayState Returns or sets the flag for pole display.

Methods

Method Description
Apply Apply this display modification to a set of objects
Dispose Free resources associated with the instance.
GetNewGrid Get grid count for objects which will be modified.
SetNewGrid Set a new grid count for objects which will be modified.

Property Detail

ApplyToAllFaces

DisplayModification.ApplyToAllFaces

Returns or sets the apply to all faces flag.

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

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

Getter Method

Signature ApplyToAllFaces

Returns:true to apply the modification to all faces
Return type:bool

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature ApplyToAllFaces

Parameters:apply (bool) – true to apply the modification to all faces

New in version NX3.0.0.

License requirements: None.

ApplyToOwningParts

DisplayModification.ApplyToOwningParts

Returns or 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.

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

Getter Method

Signature ApplyToOwningParts

Returns:true to apply the display property changes to the owning parts
Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature ApplyToOwningParts

Parameters:apply (bool) – true to apply the display property changes to the owning parts

New in version NX7.5.0.

License requirements: None.

FaceAnalysisMode

DisplayModification.FaceAnalysisMode

Returns or sets the face analysis mode flag.

Only applies to faces.

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

Getter Method

Signature FaceAnalysisMode

Returns:true to enable face analysis mode
Return type:bool

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature FaceAnalysisMode

Parameters:on (bool) – true to enable face analysis mode

New in version NX3.0.0.

License requirements: None.

KnotDisplayState

DisplayModification.KnotDisplayState

Returns or sets the flag for knot display.

Only applies to b-spline.

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

Getter Method

Signature KnotDisplayState

Returns:true to enable knot display
Return type:bool

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature KnotDisplayState

Parameters:on (bool) – true to enable knot display

New in version NX5.0.0.

License requirements: None.

NewColor

DisplayModification.NewColor

Returns or sets a new color for objects which will be modified.

This is in the range from 1 to 216.

To convert an RGB value to an NX color index, use UF_DISP_ask_closest_color. To convert a color name to an NX color index, use UF_DISP_ask_closest_color_in_displayed_part or UF_DISP_ask_closest_color_in_part. For unmanaged C++, use these functions directly. Otherwise, use the corresponding wrapper methods of class NXOpen.UF.UFDisp.

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

Getter Method

Signature NewColor

Returns:new color value in the range 1-216
Return type:int

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature NewColor

Parameters:newColor (int) – new color value

New in version NX3.0.0.

License requirements: None.

NewFont

DisplayModification.NewFont

Returns or sets a new font (line style) for objects which will be modified

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

Getter Method

Signature NewFont

Returns:new font
Return type:NXOpen.DisplayableObjectObjectFont

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature NewFont

Parameters:newFont (NXOpen.DisplayableObjectObjectFont) – new font

New in version NX3.0.0.

License requirements: None.

NewLayer

DisplayModification.NewLayer

Returns or sets a new layer for objects which will be modified.

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

Getter Method

Signature NewLayer

Returns:new layer, must be a valid layer number
Return type:int

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature NewLayer

Parameters:layer (int) – new layer, must be a valid layer number

New in version NX3.0.0.

License requirements: None.

NewTranslucency

DisplayModification.NewTranslucency

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

Only applies to faces.

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

Getter Method

Signature NewTranslucency

Returns:new translucency value in the range 0 to 100
Return type:int

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature NewTranslucency

Parameters:translucency (int) – new translucency value in the range 0 to 100

New in version NX3.0.0.

License requirements: None.

NewWidth

DisplayModification.NewWidth

Returns or sets a new line width for objects which will be modified

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

Getter Method

Signature NewWidth

Returns:new line width
Return type:NXOpen.DisplayableObjectObjectWidth

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature NewWidth

Parameters:newWidth (NXOpen.DisplayableObjectObjectWidth) – new line width

New in version NX3.0.0.

License requirements: None.

PartiallyShaded

DisplayModification.PartiallyShaded

Returns or sets the partial shading flag.

Only applies to faces.

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

Getter Method

Signature PartiallyShaded

Returns:true for partial shading on
Return type:bool

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature PartiallyShaded

Parameters:on (bool) – true for partial shading on

New in version NX3.0.0.

License requirements: None.

PoleDisplayState

DisplayModification.PoleDisplayState

Returns or sets the flag for pole display.

Only applies to b-spline.

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

Getter Method

Signature PoleDisplayState

Returns:true to enable pole display
Return type:bool

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature PoleDisplayState

Parameters:on (bool) – true to enable pole display

New in version NX5.0.0.

License requirements: None.

Method Detail

Apply

DisplayModification.Apply

Apply this display modification to a set of objects

Signature Apply(objects)

Parameters:objects (list of NXOpen.DisplayableObject) – objects to be modified

New in version NX3.0.0.

License requirements: None.

Dispose

DisplayModification.Dispose

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.

Signature Dispose()

New in version NX3.0.0.

License requirements: None.

GetNewGrid

DisplayModification.GetNewGrid

Get grid count for objects which will be modified.

Only applies to faces.

Signature GetNewGrid()

Returns:a tuple
Return type:A tuple consisting of (uGrid, vGrid) uGrid is a int. number of grid lines in the u direction vGrid is a int. number of grid lines in the v direction

New in version NX3.0.0.

License requirements: None.

SetNewGrid

DisplayModification.SetNewGrid

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

Signature SetNewGrid(uGrid, vGrid)

Parameters:
  • uGrid (int) – number of grid lines in the u direction
  • vGrid (int) – number of grid lines in the v direction

New in version NX3.0.0.

License requirements: None.