Fields_DisplayPropertiesBuilder.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
// 用于JA API的C++接口头文件
//--------------------------------------------------------------------------
//
// 源文件:
//     Fields_DisplayPropertiesBuilder.ja
//
// 生成工具:
//     apiwrap
//
// 警告:
//    此文件为自动生成 - 请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/Expression.hxx>
#include <NXOpen/Builder.hxx>
#include <NXOpen/libnxopencpp_fields_exports.hxx>
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable:4996)
#endif
#ifdef __GNUC__
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
namespace NXOpen
{
    namespace Fields
    {
        class DisplayPropertiesBuilder;
    }
    class Builder;
    class Expression;
    class NXColor;
    namespace Fields
    {
        class _DisplayPropertiesBuilderBuilder;
        class DisplayPropertiesBuilderImpl;
        class NXOPENCPP_FIELDSEXPORT  DisplayPropertiesBuilder : public NXOpen::Builder
        {
            public: enum LineFontEnum
            {
                LineFontEnumSolid,
                LineFontEnumDashed,
                LineFontEnumPhantom,
                LineFontEnumCenterline,
                LineFontEnumDotted,
                LineFontEnumLongDashed,
                LineFontEnumDottedDashed,
                LineFontEnumEight,
                LineFontEnumNine,
                LineFontEnumTen,
                LineFontEnumEleven
            };

public: enum LineWidthEnum
            {
                LineWidthEnumNormal ,
                LineWidthEnumThick ,
                LineWidthEnumThin ,
                LineWidthEnumOne  = 5,
                LineWidthEnumTwo ,
                LineWidthEnumThree ,
                LineWidthEnumFour ,
                LineWidthEnumFive ,
                LineWidthEnumSix ,
                LineWidthEnumSeven ,
                LineWidthEnumEight ,
                LineWidthEnumNine
            };

            public: enum IndepDomDispType
            {
                IndepDomDispTypeNormal ,
                IndepDomDispTypePoint ,
                IndepDomDispTypePlusSign ,
                IndepDomDispTypeAsterisk ,
                IndepDomDispTypeCircle ,
                IndepDomDispTypePoundSign ,
                IndepDomDispTypeCross ,
                IndepDomDispTypeSquare ,
                IndepDomDispTypeTriangle ,
                IndepDomDispTypeDiamond ,
                IndepDomDispTypeCenterline ,
                IndepDomDispTypeHide
            };

            public: enum DispResolutionEnum
            {
                DispResolutionEnumCoarse ,
                DispResolutionEnumStandard ,
                DispResolutionEnumFine ,
                DispResolutionEnumExtraFine ,
                DispResolutionEnumSuperFine ,
                DispResolutionEnumUltraFine ,
                DispResolutionEnumUserSpecified
            };

            public: enum HeteroTblDispOptionEnum
            {
                HeteroTblDispOptionEnumShowAverageValue ,
                HeteroTblDispOptionEnumPrimaryVarValues ,
                HeteroTblDispOptionEnumShow1StValue ,
                HeteroTblDispOptionEnumShowLastValue ,
                HeteroTblDispOptionEnumShowMinimumValue ,
                HeteroTblDispOptionEnumShowMaximumValue ,
                HeteroTblDispOptionEnumHide
            };

            public: enum DepLabelValueEnum
            {
                DepLabelValueEnumNone ,
                DepLabelValueEnumMinimumMaximum ,
                DepLabelValueEnumMaximum ,
                DepLabelValueEnumMinimum ,
                DepLabelValueEnumAll
            };

            public: enum DepDispTypeEnum
            {
                DepDispTypeEnumSymbol ,
                DepDispTypeEnumSurface ,
                DepDispTypeEnumSurfaceEdges ,
                DepDispTypeEnumHide
            };

            public: enum DepDomColorEnum
            {
                DepDomColorEnumInherit ,
                DepDomColorEnumSpecified ,
                DepDomColorEnumSpectrum
            };

            public: enum ValuesEnum
            {
                ValuesEnumHide ,
                ValuesEnumPoint ,
                ValuesEnumPlusSign ,
                ValuesEnumAsterisk ,
                ValuesEnumCircle ,
                ValuesEnumPoundSign ,
                ValuesEnumCross ,
                ValuesEnumSquare ,
                ValuesEnumTriangle ,
                ValuesEnumDiamond ,
                ValuesEnumCenterline
            };

            public: enum TblPointTypeEnum
            {
                TblPointTypeEnumHide ,
                TblPointTypeEnumShow
            };

            public: enum ValueRange
            {
                ValueRangeAuto ,
                ValueRangeSpecified
            };

            public: enum ScalarType
            {
                ScalarTypeHide ,
                ScalarTypeMag
            };

            public: enum ComplexScalarType
            {
                ComplexScalarTypeMag ,
                ComplexScalarTypeReal ,
                ComplexScalarTypeImaginary ,
                ComplexScalarTypePhase
            };

            public: enum ComplexVectorType
            {
                ComplexVectorTypeXReal ,
                ComplexVectorTypeYReal ,
                ComplexVectorTypeZReal ,
                ComplexVectorTypeXImaginary ,
                ComplexVectorTypeYImaginary ,
                ComplexVectorTypeZImaginary
            };

            public: enum VectorType
            {
                VectorTypeX ,
                VectorTypeY ,
                VectorTypeZ ,
                VectorTypeMag
            };

            public: enum Legacy3DType
            {
                Legacy3DTypeX ,
                Legacy3DTypeY ,
                Legacy3DTypeZ
            };

            public: enum TensorType
            {
                TensorTypeXx ,
                TensorTypeYy ,
                TensorTypeZz ,
                TensorTypeXy ,
                TensorTypeYz ,
                TensorTypeZx ,
                TensorTypeMean ,
                TensorTypeMidPrncpl ,
                TensorTypeMinPrncpl ,
                TensorTypeMaxPrncpl ,
                TensorTypeOctahedral ,
                TensorTypeVonMises
            };

public: enum BalStrainType
            {
                BalStrainTypeXx ,
                BalStrainTypeYy ,
                BalStrainTypeZz ,
                BalStrainTypeXy ,
                BalStrainTypeYz ,
                BalStrainTypeZx ,
                BalStrainTypeOffSetXX ,
                BalStrainTypeOffSetYY ,
                BalStrainTypeOffSetZZ ,
                BalStrainTypeOffSetXY ,
                BalStrainTypeOffSetYZ ,
                BalStrainTypeOffSetZX
            };

            public: enum FieldQuantityType
            {
                FieldQuantityTypeType0 ,
                FieldQuantityTypeType1 ,
                FieldQuantityTypeType2 ,
                FieldQuantityTypeType3 ,
                FieldQuantityTypeType4 ,
                FieldQuantityTypeType5 ,
                FieldQuantityTypeType6 ,
                FieldQuantityTypeType7 ,
                FieldQuantityTypeType8 ,
                FieldQuantityTypeType9 ,
                FieldQuantityTypeType10 ,
                FieldQuantityTypeType11 ,
                FieldQuantityTypeType12 ,
                FieldQuantityTypeType13 ,
                FieldQuantityTypeType14 ,
                FieldQuantityTypeType15
            };

            public: enum LegendPos
            {
                LegendPosHide ,
                LegendPosLeft ,
                LegendPosRight
            };
            private: DisplayPropertiesBuilderImpl * m_displaypropertiesbuilder_impl;
            private: friend class  _DisplayPropertiesBuilderBuilder;
            protected: DisplayPropertiesBuilder();
            public: ~DisplayPropertiesBuilder();
            public: int Layer
            (
            );
            public: void SetLayer
            (
                int layer 
            );
            public: NXOpen::NXColor * BasicColor
            (
            );
            public: void SetBasicColor
            (
                NXOpen::NXColor * basicColor 
            );
            public: NXOpen::Fields::DisplayPropertiesBuilder::LineFontEnum LineFont
            (
            );
            public: void SetLineFont
            (
                NXOpen::Fields::DisplayPropertiesBuilder::LineFontEnum lineFont 
            );
            public: NXOpen::Fields::DisplayPropertiesBuilder::LineWidthEnum LineWidth
            (
            );
            public: void SetLineWidth
            (
                NXOpen::Fields::DisplayPropertiesBuilder::LineWidthEnum lineWidth 
            );
            public: int Translucency
            (
            );
            public: void SetTranslucency
            (
                int translucency 
            );
            public: bool PartiallyShaded
            (
            );
            public: void SetPartiallyShaded
            (
                bool partiallyShaded 
            );
            public: bool FaceAnalysis
            (
            );
            public: void SetFaceAnalysis
            (
                bool faceAnalysis 
            );
            public: NXOpen::Fields::DisplayPropertiesBuilder::IndepDomDispType IndepDispType
            (
            );
            public: void SetIndepDispType
            (
                NXOpen::Fields::DisplayPropertiesBuilder::IndepDomDispType indepDispType 
            );
            public: NXOpen::Fields::DisplayPropertiesBuilder::DispResolutionEnum DisplayResolution
            (
            );
            public: void SetDisplayResolution
            (
                NXOpen::Fields::DisplayPropertiesBuilder::DispResolutionEnum displayResolution 
            );
            public: NXOpen::NXColor * AxisColor
            (
            );
            public: void SetAxisColor
            (
                NXOpen::NXColor * axisColor 
            );
            public: bool ShowAxis
            (
            );
            public: void SetShowAxis
            (
                bool showAxis 
            );
            public: NXOpen::NXColor * LabelColor
            (
            );
            public: void SetLabelColor
            (
                NXOpen::NXColor * labelColor 
            );
            public: bool ShowLabels
            (
            );
            public: void SetShowLabels
            (
                bool showLabels 
            );
            public: bool ShowMapTopo
            (
            );
            public: void SetShowMapTopo
            (
                bool showMapTopo 
            );
            public: NXOpen::Fields::DisplayPropertiesBuilder::DepLabelValueEnum DepLabelValues
            (
            );
            public: void SetDepLabelValues
            (
                NXOpen::Fields::DisplayPropertiesBuilder::DepLabelValueEnum depLabelValues 
            );
            public: NXOpen::Fields::DisplayPropertiesBuilder::HeteroTblDispOptionEnum HeteroTblDispOption
            (
            );
            public: void SetHeteroTblDispOption
            (
                NXOpen::Fields::DisplayPropertiesBuilder::HeteroTblDispOptionEnum hetTblValDispOption 
            );
            public: double TblHetPrimaryValue
            (
            );
            public: void SetTblHetPrimaryValue
            (
                double hetTblValue 
            );
            public: NXOpen::Fields::DisplayPropertiesBuilder::DepDispTypeEnum DepDispType
            (
            );
            public: void SetDepDispType
            (
                NXOpen::Fields::DisplayPropertiesBuilder::DepDispTypeEnum depDispType 
            );
            public: double DummyScale
            (
            );
            public: void SetDummyScale
            (
                double dummyScale 
            );
            public: double DepSymbolSize
            (
            );
            public: void SetDepSymbolSize
            (
                double depSymbolSize 
            );
            public: double SurfaceOffset
            (
            );
            public: void SetSurfaceOffset
            (
                double surfaceOffset 
            );
            public: NXOpen::Fields::DisplayPropertiesBuilder::DepDomColorEnum DepDomColor
            (
            );
            public: void SetDepDomColor
            (
                NXOpen::Fields::DisplayPropertiesBuilder::DepDomColorEnum depDomColor 
            );
            public: NXOpen::NXColor * DepSelColor
            (
            );
            public: void SetDepSelColor
            (
                NXOpen::NXColor * depSelColor 
            );
            public: int SpectrumLevels
            (
            );
            public: void SetSpectrumLevels
            (
                int spectrumLevels 
            );
            public: NXOpen::NXColor * UndefValueColor
            (
            );
            public: void SetUndefValueColor
            (
                NXOpen::NXColor * undefValueColor 
            );
            public: NX_DEPRECATED("Deprecated in NX12.0.0.  Table independent domain display no longer modifies the file and is included only to enable old journals to function without modification NXOpen::Fields::DisplayPropertiesBuilder::ShowSrcTblVals can be used to control source table values, but independent table values display is deprecated.") NXOpen::Fields::DisplayPropertiesBuilder::ValuesEnum TblIndepPtType
            (
            );
            public: NX_DEPRECATED("Deprecated in NX12.0.0.  Table Independent variable display no longer modifies the file and is included only to enable old journals to function without modification. NXOpen::Fields::DisplayPropertiesBuilder::ShowSrcTblVals can be used to show source table values, but independent table values display is deprecated.") void SetTblIndepPtType
            (
                NXOpen::Fields::DisplayPropertiesBuilder::ValuesEnum tblIndepPtType 
            );
            public: NX_DEPRECATED("Deprecated in NX12.0.0.  This function is deprecated. Table independent domain is no longer displayable so this property has no meaning. Dependent domain color can be obtained using NXOpen::Fields::DisplayPropertiesBuilder::DepSelColor.") NXOpen::NXColor * TblIndepColor
            (
            );
            public: NX_DEPRECATED("Deprecated in NX12.0.0.  This function is deprecated. Table independent domain is no longer displayable, so this function has no meaning. Table dependent domain color can be set using NXOpen::Fields::DisplayPropertiesBuilder::DepSelColor.") void SetTblIndepColor
            (
                NXOpen::NXColor * tblIndepColor 
            );
            public: NX_DEPRECATED("Deprecated in NX12.0.0.  To show source table dependent values use NXOpen::Fields::DisplayPropertiesBuilder::ShowSrcTblVals to show source table values.") NXOpen::Fields::DisplayPropertiesBuilder::TblPointTypeEnum TblDepPtType
            (
            );
            public: NX_DEPRECATED("Deprecated in NX12.0.0.  Source table display no longer uses symbols, so this function has no meaning. Table values are only on or off; to show source table values use NXOpen::Fields::DisplayPropertiesBuilder::ShowSrcTblVals to show source table values.") void SetTblDepPtType
            (
                NXOpen::Fields::DisplayPropertiesBuilder::TblPointTypeEnum tblDepPtType 
            );
            public: double TblDepSymbolSize
            (
            );
            public: void SetTblDepSymbolSize
            (
                double tblDepSymbolSize 
            );
            public: NX_DEPRECATED("Deprecated in NX12.0.0.  This function is deprecated, Tbl dependent Color can be chosen using NXOpen::Fields::DisplayPropertiesBuilder::DepDomColor.") NXOpen::Fields::DisplayPropertiesBuilder::DepDomColorEnum TblDepDomColor
            (
            );
            public: NX_DEPRECATED("Deprecated in NX12.0.0.  This function is deprecated, Tbl dependent Color can be chosen using NXOpen::Fields::DisplayPropertiesBuilder::DepDomColor.") void SetTblDepDomColor
            (
                NXOpen::Fields::DisplayPropertiesBuilder::DepDomColorEnum depDomColor 
            );
            public: NX_DEPRECATED("Deprecated in NX12.0.0.  This function is deprecated, Tbl dependent Color can be obtained using NXOpen::Fields::DisplayPropertiesBuilder::DepSelColor.") NXOpen::NXColor * TblDepColor
            (
            );
            public: NX_DEPRECATED("Deprecated in NX12.0.0.  This function is deprecated, Tbl dependent Color can be set using NXOpen::Fields::DisplayPropertiesBuilder::DepSelColor.") void SetTblDepColor
            (
                NXOpen::NXColor * tblDepColor 
            );
            public: NXOpen::Fields::DisplayPropertiesBuilder::DepLabelValueEnum TblDepLabelValues
            (
            );
            public: void SetTblDepLabelValues
            (
                NXOpen::Fields::DisplayPropertiesBuilder::DepLabelValueEnum tblDepLabelValues 
            );
            public: bool ShowName
            (
            );
            public: void SetShowName
            (
                bool showName 
            );
            public: bool ShowDescription
            (
            );
            public: void SetShowDescription
            (
                bool showDescription 
            );
            public: bool ShowDefaultVal
            (
            );
            public: void SetShowDefaultVal
            (
                bool showDefaultVal 
            );
            public: NXOpen::Fields::DisplayPropertiesBuilder::LegendPos LegendPosition
            (
            );
            public: void SetLegendPosition
            (
                NXOpen::Fields::DisplayPropertiesBuilder::LegendPos legendPosition 
            );
            public: NXOpen::Fields::DisplayPropertiesBuilder::ValueRange Range
            (
            );
            public: void SetRange
            (
                NXOpen::Fields::DisplayPropertiesBuilder::ValueRange range 
            );
            public: double RangeMin
            (
            );
            public: void SetRangeMin
            (
                double rangeMin 
            );
            public: double RangeMax
            (
            );
            public: void SetRangeMax
            (
                double rangeMax 
            );
            public: bool ShowUnderflowValues
            (
            );
            public: void SetShowUnderflowValues
            (
                bool showUnderflow 
            );
            public: NXOpen::NXColor * UnderflowColor
            (
            );
            public: void SetUnderflowColor
            (
                NXOpen::NXColor * underflowColor 
            );
            public: NXOpen::NXColor * OverflowColor
            (
            );
            public: void SetOverflowColor
            (
                NXOpen::NXColor * overflowColor 
            );
            public: bool ShowOverflowValues
            (
            );
            public: void SetShowOverflowValues
            (
                bool showOverflow 
            );
            public: NXOpen::Expression * PrimaryVar
            (
            );
            public: int XNum
            (
            );
            public: void SetXNum
            (
                int xNum 
            );
            public: NXOpen::Expression * XMin
            (
            );
            public: NXOpen::Expression * XMax
            (
            );
            public: int YNum
            (
            );
            public: void SetYNum
            (
                int yNum 
            );
            public: NXOpen::Expression * YMin
            (
            );
            public: NXOpen::Expression * YMax
            (
            );
            public: int ZNum
            (
            );
            public: void SetZNum
            (
                int zNum 
            );
            public: NXOpen::Expression * ZMin
            (
            );
            public: NXOpen::Expression * ZMax
            (
            );
            public: NXOpen::Fields::DisplayPropertiesBuilder::FieldQuantityType FieldQuantity
            (
            );
            public: void SetFieldQuantity
            (
                NXOpen::Fields::DisplayPropertiesBuilder::FieldQuantityType fieldQuantity 
            );
            public: double DepCalcSymblSize
            (
            );
            public: void SetDepCalcSymblSize
            (
                double depCalcSymblSize 
            );
            public: bool ShowSrcTblVals
            (
            );
            public: void SetShowSrcTblVals
            (
                bool showSrcTblVals 
            );
            public: double DepRangeMax
            (
            );
            public: void SetDepRangeMax
            (
                double depRangeMax 
            );
            public: double DepRangeMin
            (
            );
            public: void SetDepRangeMin
            (
                double depRangeMin 
            );
            public: bool ShowUndefValues
            (
            );
            public: void SetShowUndefValues
            (
                bool showUndefValues 
            );
            public: NXOpen::Fields::DisplayPropertiesBuilder::DepDispTypeEnum TblDepDispType
            (
            );
            public: void SetTblDepDispType
            (
                NXOpen::Fields::DisplayPropertiesBuilder::DepDispTypeEnum tblDepDispType 
            );
            public: double TblSurfaceOffset
            (
            );
            public: void SetTblSurfaceOffset
            (
                double tblDepSurfaceOffset 
            );
        };
    }
}
#ifdef _MSC_VER
#pragma warning(pop)
#endif
#ifdef __GNUC__
#ifndef NX_NO_GCC_DEPRECATION_WARNINGS
#pragma GCC diagnostic warning "-Wdeprecated-declarations"
#endif
#endif
#undef EXPORTLIBRARY