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

Inheritance diagram for NXOpen::CAE::PostColorbarColorParameters:

Public Types
enum	Spectrum { SpectrumStructural, SpectrumThermal, SpectrumGrayScale, SpectrumStopLight }
	Colorbar spectrum schemes. More...

Public Member Functions
std::vector< int >	GetColorRange ()
	Asks the color range for the colorbar. More...

bool	GetCustomOverwriteColor ()
	Asks the custom overwrite color setting for the colorbar. More...

bool	GetInvertSpectrum ()
	Asks the colorbar object if the colorbar spectrum is in inverted state or not. More...

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...

void	SetColorRange (const std::vector< int > &colorrange)
	Sets the color range for the colorbar. More...

void	SetCustomOverwriteColor (bool customoverwritecolor)
	Sets the custom overwrite color setting for the colorbar. More...

void	SetInvertSpectrum (bool invertspectrum)
	Sets the the colorbar spectrum to the inverted state. More...

void	SetSpectrum (NXOpen::CAE::PostColorbarColorParameters::Spectrum spectrum)
	Sets the spectrum style to the colorbar which sets the color scheme to draw the colorbar scale Created in NX1847.0.0. More...

virtual	~PostColorbarColorParameters ()
	Destroys the object Created in NX1847.0.0. More...

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	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

enum NXOpen::CAE::PostColorbarColorParameters::Spectrum

Colorbar spectrum schemes.

Enumerator
SpectrumStructural	structural
SpectrumThermal	thermal
SpectrumGrayScale	gray scale
SpectrumStopLight	stop light

Constructor & Destructor Documentation

virtual NXOpen::CAE::PostColorbarColorParameters::~PostColorbarColorParameters ( )

virtual

Destroys the object
Created in NX1847.0.0.

License requirements : None

Member Function Documentation

std::vector<int> NXOpen::CAE::PostColorbarColorParameters::GetColorRange ( )

Asks the color range for the colorbar.

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

Returns: 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")

bool NXOpen::CAE::PostColorbarColorParameters::GetCustomOverwriteColor ( )

Asks the custom overwrite color setting for the colorbar.

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

Returns: 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")

bool NXOpen::CAE::PostColorbarColorParameters::GetInvertSpectrum ( )

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

Returns: 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")

NXOpen::CAE::PostColorbarColorParameters::Spectrum NXOpen::CAE::PostColorbarColorParameters::GetSpectrum ( )

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

Returns: 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")

void NXOpen::CAE::PostColorbarColorParameters::SetColorRange ( const std::vector< int > & colorrange )

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 colorrange

void NXOpen::CAE::PostColorbarColorParameters::SetCustomOverwriteColor ( bool customoverwritecolor )

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 customoverwritecolor

void NXOpen::CAE::PostColorbarColorParameters::SetInvertSpectrum ( bool invertspectrum )

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 invertspectrum

void NXOpen::CAE::PostColorbarColorParameters::SetSpectrum ( NXOpen::CAE::PostColorbarColorParameters::Spectrum spectrum )

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 spectrum

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

CAE_PostColorbarColorParameters.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation