NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions
NXOpen::Preferences::ViewVisualizationSpecialEffects Class Reference

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

List of all members.

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.
int FogBackValue ()
 Returns the fog back scale value.
NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorHLS FogColorHLSValue ()
 Returns the value of HLS color pattern
Created in NX3.0.0.
NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorHSV FogColorHSVValue ()
 Returns the value of HSV color pattern
Created in NX3.0.0.
NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorRGB FogColorRGBValue ()
 Returns the value of RGB color pattern
Created in NX3.0.0.
int FogFrontValue ()
 Returns the fog front scale value.
int FogRateValue ()
 Returns the fog rate value.
NXOpen::Preferences::ViewVisualizationSpecialEffects::FogType FogSetting ()
 Returns the fog setting type
Created in NX3.0.0.
bool FogSettingOption ()
 Returns the fog option.
void SetFogBackgroundColor (bool fogBackgroundColor)
 Sets the use background color flag.
void SetFogBackValue (int fogBackValue)
 Sets the fog back scale value.
void SetFogColorHLSValue (const NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorHLS &fogColorHlsValue)
 Sets the value of HLS color pattern
Created in NX3.0.0.
void SetFogColorHSVValue (const NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorHSV &fogColorHsvValue)
 Sets the value of HSV color pattern
Created in NX3.0.0.
void SetFogColorRGBValue (const NXOpen::Preferences::ViewVisualizationSpecialEffects::ColorRGB &fogColorRgbValue)
 Sets the value of RGB color pattern
Created in NX3.0.0.
void SetFogFrontValue (int fogFrontValue)
 Sets the fog front scale value.
void SetFogRateValue (int fogRateValue)
 Sets the fog rate value.
void SetFogSetting (NXOpen::Preferences::ViewVisualizationSpecialEffects::FogType fogSetting)
 Sets the fog setting type
Created in NX3.0.0.
void SetFogSettingOption (bool fogSettingOption)
 Sets the fog option.
tag_t Tag () const
 Returns the tag of this object.
void UpdateFogDisplay (const NXOpen::Preferences::ViewVisualizationSpecialEffects::FogData &fogData)
 Applies current fog settings to display
Created in NX3.0.0.

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 View

Created in NX3.0.0.


Member Enumeration Documentation

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

Returns the use background color flag.

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

License requirements : None

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

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



License requirements : None

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



License requirements : None

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



License requirements : None

Returns the fog front scale value.

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

License requirements : None

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

Returns the fog setting type
Created in NX3.0.0.



License requirements : None

Returns the fog option.

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

License requirements : None

Sets the use background color flag.

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

License requirements : None

Parameters:
fogBackgroundColorfog background color

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:
fogBackValuefog back value

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



License requirements : None

Parameters:
fogColorHlsValuefog color hls value

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



License requirements : None

Parameters:
fogColorHsvValuefog color hsv value

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



License requirements : None

Parameters:
fogColorRgbValuefog color rgb value

Sets the fog front scale value.

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

License requirements : None

Parameters:
fogFrontValuefog front value

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:
fogRateValuefog rate value

Sets the fog setting type
Created in NX3.0.0.



License requirements : None

Parameters:
fogSettingfog setting

Sets the fog option.

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

License requirements : None

Parameters:
fogSettingOptionfog setting option

Returns the tag of this object.

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



License requirements : None

Parameters:
fogDatafog data

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