Represents the set of visualization special effect preferences applicable to entire session. More...

Inheritance diagram for NXOpen.Preferences.ViewVisualizationSpecialEffects:

Classes
struct	ColorHLS
	Represents three constituents of a HLS color pattern More...

struct	ColorHSV
	Represents three constituents of a HSV color pattern More...

struct	ColorRGB
	Represents three constituents of a RGB color pattern More...

struct	FogData
	Represents the constituents of fog data More...

Public Types
enum	FogType { Linear, Light, Heavy }
	Describes whether the fog type is selected as linear or light or heavy. More...

Public Member Functions
unsafe void	UpdateFogDisplay (NXOpen.Preferences.ViewVisualizationSpecialEffects.FogData fogData)
	Applies current fog settings to display More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe bool	FogBackgroundColor `[get, set]`
	Returns or sets the use background color flag. More...

unsafe int	FogBackValue `[get, set]`
	Returns or sets the fog back scale value. More...

unsafe NXOpen.Preferences.ViewVisualizationSpecialEffects.ColorHLS	FogColorHLSValue `[get, set]`
	Returns or sets the value of HLS color pattern More...

unsafe NXOpen.Preferences.ViewVisualizationSpecialEffects.ColorHSV	FogColorHSVValue `[get, set]`
	Returns or sets the value of HSV color pattern More...

unsafe NXOpen.Preferences.ViewVisualizationSpecialEffects.ColorRGB	FogColorRGBValue `[get, set]`
	Returns or sets the value of RGB color pattern More...

unsafe int	FogFrontValue `[get, set]`
	Returns or sets the fog front scale value. More...

unsafe int	FogRateValue `[get, set]`
	Returns or sets the fog rate value. More...

unsafe NXOpen.Preferences.ViewVisualizationSpecialEffects.FogType	FogSetting `[get, set]`
	Returns or sets the fog setting type More...

unsafe bool	FogSettingOption `[get, set]`
	Returns or sets the fog option. More...

Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void	initialize ()
	<exclude> More...

Detailed Description

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

Created in NX3.0.0

Member Enumeration Documentation

enum NXOpen.Preferences.ViewVisualizationSpecialEffects.FogType

Describes whether the fog type is selected as linear or light or heavy.

Enumerator

Linear

Linear Fog

Light

Non linear Fog.

Light fog produces a fog effect less pervasive than Heavy fog

Heavy

Non linear Fog

Member Function Documentation

unsafe void NXOpen.Preferences.ViewVisualizationSpecialEffects.UpdateFogDisplay ( NXOpen.Preferences.ViewVisualizationSpecialEffects.FogData fogData )

inline

Applies current fog settings to display

Created in NX3.0.0

License requirements: None.

Parameters

fogData

Property Documentation

unsafe bool NXOpen.Preferences.ViewVisualizationSpecialEffects.FogBackgroundColor

getset

Returns or sets the use background color flag.

If true background color is used as fog color

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Preferences.ViewVisualizationSpecialEffects.FogBackValue

getset

Returns or sets the fog back scale value.

The Back scale defines the point at which fog reaches its maximum.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Preferences.ViewVisualizationSpecialEffects.ColorHLS NXOpen.Preferences.ViewVisualizationSpecialEffects.FogColorHLSValue

getset

Returns or sets the value of HLS color pattern

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Preferences.ViewVisualizationSpecialEffects.ColorHSV NXOpen.Preferences.ViewVisualizationSpecialEffects.FogColorHSVValue

getset

Returns or sets the value of HSV color pattern

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Preferences.ViewVisualizationSpecialEffects.ColorRGB NXOpen.Preferences.ViewVisualizationSpecialEffects.FogColorRGBValue

getset

Returns or sets the value of RGB color pattern

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Preferences.ViewVisualizationSpecialEffects.FogFrontValue

getset

Returns or sets the fog front scale value.

The front scale defines the beginning of fog.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Preferences.ViewVisualizationSpecialEffects.FogRateValue

getset

Returns or sets the fog rate value.

Specifies the rate at which an object fades as the distance in the view increases.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Preferences.ViewVisualizationSpecialEffects.FogType NXOpen.Preferences.ViewVisualizationSpecialEffects.FogSetting

getset

Returns or sets the fog setting type

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Preferences.ViewVisualizationSpecialEffects.FogSettingOption

getset

Returns or sets the fog option.

If true fog settings are available and applied to display

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

Tag NXOpen.Preferences.ViewVisualizationSpecialEffects.Tag

get

Returns the tag of this object.

The documentation for this class was generated from the following file:

Preferences_ViewVisualizationSpecialEffects.cs

Classes

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation