ViewVisualizationSpecialEffects Class¶
-
class
NXOpen.Preferences.
ViewVisualizationSpecialEffects
¶ Bases:
object
Represents the set of visualization special effect preferences applicable to entire session.
Mainly sets fog preferences. Fog is the ability to display close objects in shades that are different than those of distant objects resulting in a display that shows which geometry is closest to the viewer and which is furthest.
To obtain an instance of this class, refer to
NXOpen.View
New in version NX3.0.0.
Properties¶
Property | Description |
---|---|
FogBackValue | Returns or sets the fog back scale value. |
FogBackgroundColor | Returns or sets the use background color flag. |
FogColorHLSValue | Returns or sets the value of HLS color pattern |
FogColorHSVValue | Returns or sets the value of HSV color pattern |
FogColorRGBValue | Returns or sets the value of RGB color pattern |
FogFrontValue | Returns or sets the fog front scale value. |
FogRateValue | Returns or sets the fog rate value. |
FogSetting | Returns or sets the fog setting type |
FogSettingOption | Returns or sets the fog option. |
Methods¶
Method | Description |
---|---|
UpdateFogDisplay | Applies current fog settings to display |
Enumerations¶
ViewVisualizationSpecialEffectsFogType Enumeration | Describes whether the fog type is selected as linear or light or heavy. |
Structs¶
ViewVisualizationSpecialEffectsColorHLS_Struct Struct | Represents three constituents of a HLS color pattern |
ViewVisualizationSpecialEffectsColorHSV_Struct Struct | Represents three constituents of a HSV color pattern |
ViewVisualizationSpecialEffectsColorRGB_Struct Struct | Represents three constituents of a RGB color pattern |
ViewVisualizationSpecialEffectsFogData_Struct Struct | Represents the constituents of fog data |
Property Detail¶
FogBackValue¶
-
ViewVisualizationSpecialEffects.
FogBackValue
¶ Returns or sets the fog back scale value.
The Back scale defines the point at which fog reaches its maximum.
-------------------------------------
Getter Method
Signature
FogBackValue()
Returns: Return type: int New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FogBackValue(fogBackValue)
Parameters: fogBackValue (int) – New in version NX3.0.0.
License requirements: None.
FogBackgroundColor¶
-
ViewVisualizationSpecialEffects.
FogBackgroundColor
¶ Returns or sets the use background color flag.
If true background color is used as fog color
-------------------------------------
Getter Method
Signature
FogBackgroundColor()
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FogBackgroundColor(fogBackgroundColor)
Parameters: fogBackgroundColor (bool) – New in version NX3.0.0.
License requirements: None.
FogColorHLSValue¶
-
ViewVisualizationSpecialEffects.
FogColorHLSValue
¶ Returns or sets the value of HLS color pattern
-------------------------------------
Getter Method
Signature
FogColorHLSValue()
Returns: Return type: NXOpen.Preferences.ViewVisualizationSpecialEffectsColorHLS_Struct
New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FogColorHLSValue(fogColorHlsValue)
Parameters: fogColorHlsValue ( NXOpen.Preferences.ViewVisualizationSpecialEffectsColorHLS_Struct
) –New in version NX3.0.0.
License requirements: None.
FogColorHSVValue¶
-
ViewVisualizationSpecialEffects.
FogColorHSVValue
¶ Returns or sets the value of HSV color pattern
-------------------------------------
Getter Method
Signature
FogColorHSVValue()
Returns: Return type: NXOpen.Preferences.ViewVisualizationSpecialEffectsColorHSV_Struct
New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FogColorHSVValue(fogColorHsvValue)
Parameters: fogColorHsvValue ( NXOpen.Preferences.ViewVisualizationSpecialEffectsColorHSV_Struct
) –New in version NX3.0.0.
License requirements: None.
FogColorRGBValue¶
-
ViewVisualizationSpecialEffects.
FogColorRGBValue
¶ Returns or sets the value of RGB color pattern
-------------------------------------
Getter Method
Signature
FogColorRGBValue()
Returns: Return type: NXOpen.Preferences.ViewVisualizationSpecialEffectsColorRGB_Struct
New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FogColorRGBValue(fogColorRgbValue)
Parameters: fogColorRgbValue ( NXOpen.Preferences.ViewVisualizationSpecialEffectsColorRGB_Struct
) –New in version NX3.0.0.
License requirements: None.
FogFrontValue¶
-
ViewVisualizationSpecialEffects.
FogFrontValue
¶ Returns or sets the fog front scale value.
The front scale defines the beginning of fog.
-------------------------------------
Getter Method
Signature
FogFrontValue()
Returns: Return type: int New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FogFrontValue(fogFrontValue)
Parameters: fogFrontValue (int) – New in version NX3.0.0.
License requirements: None.
FogRateValue¶
-
ViewVisualizationSpecialEffects.
FogRateValue
¶ Returns or sets the fog rate value.
Specifies the rate at which an object fades as the distance in the view increases.
-------------------------------------
Getter Method
Signature
FogRateValue()
Returns: Return type: int New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FogRateValue(fogRateValue)
Parameters: fogRateValue (int) – New in version NX3.0.0.
License requirements: None.
FogSetting¶
-
ViewVisualizationSpecialEffects.
FogSetting
¶ Returns or sets the fog setting type
-------------------------------------
Getter Method
Signature
FogSetting()
Returns: Return type: NXOpen.Preferences.ViewVisualizationSpecialEffectsFogType
New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FogSetting(fogSetting)
Parameters: fogSetting ( NXOpen.Preferences.ViewVisualizationSpecialEffectsFogType
) –New in version NX3.0.0.
License requirements: None.
FogSettingOption¶
-
ViewVisualizationSpecialEffects.
FogSettingOption
¶ Returns or sets the fog option.
If true fog settings are available and applied to display
-------------------------------------
Getter Method
Signature
FogSettingOption()
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FogSettingOption(fogSettingOption)
Parameters: fogSettingOption (bool) – New in version NX3.0.0.
License requirements: None.
Method Detail¶
UpdateFogDisplay¶
-
ViewVisualizationSpecialEffects.
UpdateFogDisplay
¶ Applies current fog settings to display
Signature
UpdateFogDisplay(fogData)
Parameters: fogData ( NXOpen.Preferences.ViewVisualizationSpecialEffectsFogData_Struct
) –New in version NX3.0.0.
License requirements: None.