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

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 { FogTypeLinear, FogTypeLight, FogTypeHeavy }
	Describes whether the fog type is selected as linear or light or heavy. More...

Public Member Functions
bool	FogBackgroundColor ()
	Returns the use background color flag. More...

int	FogBackValue ()
	Returns the fog back scale value. More...

NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorHLS	FogColorHLSValue ()
	Returns the value of HLS color pattern Created in NX3.0.0. More...

NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorHSV	FogColorHSVValue ()
	Returns the value of HSV color pattern Created in NX3.0.0. More...

NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorRGB	FogColorRGBValue ()
	Returns the value of RGB color pattern Created in NX3.0.0. More...

int	FogFrontValue ()
	Returns the fog front scale value. More...

int	FogRateValue ()
	Returns the fog rate value. More...

NXOpen::Preferences::ViewVisualizationSpecialEffects::FogType	FogSetting ()
	Returns the fog setting type Created in NX3.0.0. More...

bool	FogSettingOption ()
	Returns the fog option. More...

void	SetFogBackgroundColor (bool fogBackgroundColor)
	Sets the use background color flag. More...

void	SetFogBackValue (int fogBackValue)
	Sets the fog back scale value. More...

void	SetFogColorHLSValue (const NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorHLS &fogColorHlsValue)
	Sets the value of HLS color pattern Created in NX3.0.0. More...

void	SetFogColorHSVValue (const NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorHSV &fogColorHsvValue)
	Sets the value of HSV color pattern Created in NX3.0.0. More...

void	SetFogColorRGBValue (const NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorRGB &fogColorRgbValue)
	Sets the value of RGB color pattern Created in NX3.0.0. More...

void	SetFogFrontValue (int fogFrontValue)
	Sets the fog front scale value. More...

void	SetFogRateValue (int fogRateValue)
	Sets the fog rate value. More...

void	SetFogSetting (NXOpen::Preferences::ViewVisualizationSpecialEffects::FogType fogSetting)
	Sets the fog setting type Created in NX3.0.0. More...

void	SetFogSettingOption (bool fogSettingOption)
	Sets the fog option. More...

tag_t	Tag () const
	Returns the tag of this object. More...

void	UpdateFogDisplay (const NXOpen::Preferences::ViewVisualizationSpecialEffects::FogData &fogData)
	Applies current fog settings to display Created in NX3.0.0. 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

FogTypeLinear

Linear Fog.

FogTypeLight

Non linear Fog.

Light fog produces a fog effect less pervasive than Heavy fog

FogTypeHeavy

Non linear Fog.

Member Function Documentation

bool NXOpen::Preferences::ViewVisualizationSpecialEffects::FogBackgroundColor ( )

Returns the use background color flag.

If true background color is used as fog color
Created in NX3.0.0.

License requirements : None

int NXOpen::Preferences::ViewVisualizationSpecialEffects::FogBackValue ( )

Returns the fog back scale value.

The Back scale defines the point at which fog reaches its maximum.
Created in NX3.0.0.

License requirements : None

NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorHLS NXOpen::Preferences::ViewVisualizationSpecialEffects::FogColorHLSValue ( )

Returns the value of HLS color pattern
Created in NX3.0.0.

License requirements : None

NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorHSV NXOpen::Preferences::ViewVisualizationSpecialEffects::FogColorHSVValue ( )

Returns the value of HSV color pattern
Created in NX3.0.0.

License requirements : None

NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorRGB NXOpen::Preferences::ViewVisualizationSpecialEffects::FogColorRGBValue ( )

Returns the value of RGB color pattern
Created in NX3.0.0.

License requirements : None

int NXOpen::Preferences::ViewVisualizationSpecialEffects::FogFrontValue ( )

Returns the fog front scale value.

The front scale defines the beginning of fog.
Created in NX3.0.0.

License requirements : None

int NXOpen::Preferences::ViewVisualizationSpecialEffects::FogRateValue ( )

Returns 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 : None

NXOpen::Preferences::ViewVisualizationSpecialEffects::FogType NXOpen::Preferences::ViewVisualizationSpecialEffects::FogSetting ( )

Returns the fog setting type
Created in NX3.0.0.

License requirements : None

bool NXOpen::Preferences::ViewVisualizationSpecialEffects::FogSettingOption ( )

Returns the fog option.

If true fog settings are available and applied to display
Created in NX3.0.0.

License requirements : None

void NXOpen::Preferences::ViewVisualizationSpecialEffects::SetFogBackgroundColor ( bool fogBackgroundColor )

Sets the use background color flag.

If true background color is used as fog color
Created in NX3.0.0.

License requirements : None

Parameters

fogBackgroundColor fog background color

void NXOpen::Preferences::ViewVisualizationSpecialEffects::SetFogBackValue ( int fogBackValue )

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 : None

Parameters

fogBackValue fog back value

void NXOpen::Preferences::ViewVisualizationSpecialEffects::SetFogColorHLSValue ( const NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorHLS & fogColorHlsValue )

Sets the value of HLS color pattern
Created in NX3.0.0.

License requirements : None

Parameters

fogColorHlsValue fog color hls value

void NXOpen::Preferences::ViewVisualizationSpecialEffects::SetFogColorHSVValue ( const NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorHSV & fogColorHsvValue )

Sets the value of HSV color pattern
Created in NX3.0.0.

License requirements : None

Parameters

fogColorHsvValue fog color hsv value

void NXOpen::Preferences::ViewVisualizationSpecialEffects::SetFogColorRGBValue ( const NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorRGB & fogColorRgbValue )

Sets the value of RGB color pattern
Created in NX3.0.0.

License requirements : None

Parameters

fogColorRgbValue fog color rgb value

void NXOpen::Preferences::ViewVisualizationSpecialEffects::SetFogFrontValue ( int fogFrontValue )

Sets the fog front scale value.

The front scale defines the beginning of fog.
Created in NX3.0.0.

License requirements : None

Parameters

fogFrontValue fog front value

void NXOpen::Preferences::ViewVisualizationSpecialEffects::SetFogRateValue ( int fogRateValue )

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 : None

Parameters

fogRateValue fog rate value

void NXOpen::Preferences::ViewVisualizationSpecialEffects::SetFogSetting ( NXOpen::Preferences::ViewVisualizationSpecialEffects::FogType fogSetting )

Sets the fog setting type
Created in NX3.0.0.

License requirements : None

Parameters

fogSetting fog setting

void NXOpen::Preferences::ViewVisualizationSpecialEffects::SetFogSettingOption ( bool fogSettingOption )

Sets the fog option.

If true fog settings are available and applied to display
Created in NX3.0.0.

License requirements : None

Parameters

fogSettingOption fog setting option

tag_t NXOpen::Preferences::ViewVisualizationSpecialEffects::Tag ( ) const

Returns the tag of this object.

void NXOpen::Preferences::ViewVisualizationSpecialEffects::UpdateFogDisplay ( const NXOpen::Preferences::ViewVisualizationSpecialEffects::FogData & fogData )

Applies current fog settings to display
Created in NX3.0.0.

License requirements : None

Parameters

fogData fog data

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

Preferences_ViewVisualizationSpecialEffects.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation