NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Protected Member Functions | List of all members
NXOpen.CAE.PostColorbarColorParameters Class Reference

This class has the information related to post colorbar color control values. More...

Inheritance diagram for NXOpen.CAE.PostColorbarColorParameters:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Types

enum  Spectrum { Structural, Thermal, GrayScale, StopLight }
 Colorbar spectrum schemes More...
 

Public Member Functions

unsafe int[] GetColorRange ()
 Asks the color range for the colorbar. More...
 
unsafe bool GetCustomOverwriteColor ()
 Asks the custom overwrite color setting for the colorbar. More...
 
unsafe bool GetInvertSpectrum ()
 Asks the colorbar object if the colorbar spectrum is in inverted state or not. More...
 
unsafe
NXOpen.CAE.PostColorbarColorParameters.Spectrum 
GetSpectrum ()
 Gets the spectrum style for the colorbar which is a kind of color scheme used to draw the colorbar scale. More...
 
unsafe void SetColorRange (int[] colorrange)
 Sets the color range for the colorbar. More...
 
unsafe void SetCustomOverwriteColor (bool customoverwritecolor)
 Sets the custom overwrite color setting for the colorbar. More...
 
unsafe void SetInvertSpectrum (bool invertspectrum)
 Sets the the colorbar spectrum to the inverted state. More...
 
unsafe void SetSpectrum (NXOpen.CAE.PostColorbarColorParameters.Spectrum spectrum)
 Sets the spectrum style to the colorbar which sets the color scheme to draw the colorbar scale More...
 
- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new string ToString ()
 Returns a String that represents the current Object. 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...
 

Protected Member Functions

override void FreeResource ()
 Destroys the object More...
 

Additional Inherited Members

- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 

Detailed Description

This class has the information related to post colorbar color control values.

An instance of this class can not be created. To obtain the object use NXOpen.CAE.PostColorbar.GetColorParameters method.

Created in NX1847.0.0

Member Enumeration Documentation

Colorbar spectrum schemes

Enumerator
Structural 
Thermal 
GrayScale 
StopLight 

Member Function Documentation

override void NXOpen.CAE.PostColorbarColorParameters.FreeResource ( )
inlineprotectedvirtual

Destroys the object

Created in NX1847.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe int [] NXOpen.CAE.PostColorbarColorParameters.GetColorRange ( )
inline

Asks the color range for the colorbar.

This contains the color ids applied to the colorbar to draw.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Returns
unsafe bool NXOpen.CAE.PostColorbarColorParameters.GetCustomOverwriteColor ( )
inline

Asks the custom overwrite color setting for the colorbar.

This indicates if custom colors have been applied on the colorbar or not.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Returns
unsafe bool NXOpen.CAE.PostColorbarColorParameters.GetInvertSpectrum ( )
inline

Asks the colorbar object if the colorbar spectrum is in inverted state or not.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Returns
unsafe NXOpen.CAE.PostColorbarColorParameters.Spectrum NXOpen.CAE.PostColorbarColorParameters.GetSpectrum ( )
inline

Gets the spectrum style for the colorbar which is a kind of color scheme used to draw the colorbar scale.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Returns
unsafe void NXOpen.CAE.PostColorbarColorParameters.SetColorRange ( int[]  colorrange)
inline

Sets the color range for the colorbar.

This assigns the color ids to be applied to colorbar and postview.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
colorrange
unsafe void NXOpen.CAE.PostColorbarColorParameters.SetCustomOverwriteColor ( bool  customoverwritecolor)
inline

Sets the custom overwrite color setting for the colorbar.

If this is true then custom colors will be applied to the colorbar and postview.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
customoverwritecolor
unsafe void NXOpen.CAE.PostColorbarColorParameters.SetInvertSpectrum ( bool  invertspectrum)
inline

Sets the the colorbar spectrum to the inverted state.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
invertspectrum
unsafe void NXOpen.CAE.PostColorbarColorParameters.SetSpectrum ( NXOpen.CAE.PostColorbarColorParameters.Spectrum  spectrum)
inline

Sets the spectrum style to the colorbar which sets the color scheme to draw the colorbar scale

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
spectrum

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