public interface ViewVisualizationSpecialEffects extends Remote
View
Modifier and Type | Interface and Description |
---|---|
static class |
ViewVisualizationSpecialEffects.ColorHLS
Represents three constituents of a HLS color pattern
|
static class |
ViewVisualizationSpecialEffects.ColorHSV
Represents three constituents of a HSV color pattern
|
static class |
ViewVisualizationSpecialEffects.ColorRGB
Represents three constituents of a RGB color pattern
|
static class |
ViewVisualizationSpecialEffects.FogData
Represents the constituents of fog data
|
static class |
ViewVisualizationSpecialEffects.FogType
Describes whether the fog type is selected as linear or light or heavy.
|
Modifier and Type | Method and Description |
---|---|
boolean |
fogBackgroundColor()
Returns the use background color flag.
|
int |
fogBackValue()
Returns the fog back scale value.
|
ViewVisualizationSpecialEffects.ColorHLS |
fogColorHLSValue()
Returns the value of HLS color pattern
License requirements: None. |
ViewVisualizationSpecialEffects.ColorHSV |
fogColorHSVValue()
Returns the value of HSV color pattern
License requirements: None. |
ViewVisualizationSpecialEffects.ColorRGB |
fogColorRGBValue()
Returns the value of RGB color pattern
License requirements: None. |
int |
fogFrontValue()
Returns the fog front scale value.
|
int |
fogRateValue()
Returns the fog rate value.
|
ViewVisualizationSpecialEffects.FogType |
fogSetting()
Returns the fog setting type
License requirements: None. |
boolean |
fogSettingOption()
Returns the fog option.
|
void |
setFogBackgroundColor(boolean fogBackgroundColor)
Sets the use background color flag.
|
void |
setFogBackValue(int fogBackValue)
Sets the fog back scale value.
|
void |
setFogColorHLSValue(ViewVisualizationSpecialEffects.ColorHLS fogColorHlsValue)
Sets the value of HLS color pattern
License requirements: None. |
void |
setFogColorHSVValue(ViewVisualizationSpecialEffects.ColorHSV fogColorHsvValue)
Sets the value of HSV color pattern
License requirements: None. |
void |
setFogColorRGBValue(ViewVisualizationSpecialEffects.ColorRGB fogColorRgbValue)
Sets the value of RGB color pattern
License requirements: None. |
void |
setFogFrontValue(int fogFrontValue)
Sets the fog front scale value.
|
void |
setFogRateValue(int fogRateValue)
Sets the fog rate value.
|
void |
setFogSetting(ViewVisualizationSpecialEffects.FogType fogSetting)
Sets the fog setting type
License requirements: None. |
void |
setFogSettingOption(boolean fogSettingOption)
Sets the fog option.
|
void |
updateFogDisplay(ViewVisualizationSpecialEffects.FogData fogData)
Applies current fog settings to display
License requirements: None. |
boolean fogSettingOption() throws NXException, RemoteException
NXException
RemoteException
void setFogSettingOption(boolean fogSettingOption) throws NXException, RemoteException
fogSettingOption
- NXException
RemoteException
ViewVisualizationSpecialEffects.FogType fogSetting() throws NXException, RemoteException
NXException
RemoteException
void setFogSetting(ViewVisualizationSpecialEffects.FogType fogSetting) throws NXException, RemoteException
fogSetting
- NXException
RemoteException
boolean fogBackgroundColor() throws NXException, RemoteException
NXException
RemoteException
void setFogBackgroundColor(boolean fogBackgroundColor) throws NXException, RemoteException
fogBackgroundColor
- NXException
RemoteException
ViewVisualizationSpecialEffects.ColorRGB fogColorRGBValue() throws NXException, RemoteException
NXException
RemoteException
void setFogColorRGBValue(ViewVisualizationSpecialEffects.ColorRGB fogColorRgbValue) throws NXException, RemoteException
fogColorRgbValue
- NXException
RemoteException
ViewVisualizationSpecialEffects.ColorHSV fogColorHSVValue() throws NXException, RemoteException
NXException
RemoteException
void setFogColorHSVValue(ViewVisualizationSpecialEffects.ColorHSV fogColorHsvValue) throws NXException, RemoteException
fogColorHsvValue
- NXException
RemoteException
ViewVisualizationSpecialEffects.ColorHLS fogColorHLSValue() throws NXException, RemoteException
NXException
RemoteException
void setFogColorHLSValue(ViewVisualizationSpecialEffects.ColorHLS fogColorHlsValue) throws NXException, RemoteException
fogColorHlsValue
- NXException
RemoteException
int fogFrontValue() throws NXException, RemoteException
NXException
RemoteException
void setFogFrontValue(int fogFrontValue) throws NXException, RemoteException
fogFrontValue
- NXException
RemoteException
int fogBackValue() throws NXException, RemoteException
NXException
RemoteException
void setFogBackValue(int fogBackValue) throws NXException, RemoteException
fogBackValue
- NXException
RemoteException
int fogRateValue() throws NXException, RemoteException
NXException
RemoteException
void setFogRateValue(int fogRateValue) throws NXException, RemoteException
fogRateValue
- NXException
RemoteException
void updateFogDisplay(ViewVisualizationSpecialEffects.FogData fogData) throws NXException, RemoteException
fogData
- NXException
RemoteException
Copyright 2016 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.