Display_EnvironmentBuilder.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
// C++接口对JA API的头文件
//--------------------------------------------------------------------------
//
// 源文件:
//     Display_EnvironmentBuilder.ja
//
// 生成工具:
//     apiwrap
//
// 警告:
//    本文件由系统自动生成 - 请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/Display_Image.hxx>
#include <NXOpen/Expression.hxx>
#include <NXOpen/Builder.hxx>
#include <NXOpen/View.hxx>
#include <NXOpen/ugmath.hxx>
#include <NXOpen/libnxopencpp_display_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 Display
    {
        class EnvironmentBuilder;
    }
    class Builder;
    class Direction;
    namespace Display
    {
        class Image;
    }
    class Expression;
    class Plane;
    class View;
    namespace Display
    {
        class _EnvironmentBuilderBuilder;
        class EnvironmentBuilderImpl;
        class NXOPENCPP_DISPLAYEXPORT  EnvironmentBuilder : public NXOpen::Builder
        {
            public: enum ImageBlurType
            {
                ImageBlurTypeNone ,
                ImageBlurTypeLow ,
                ImageBlurTypeMedium ,
                ImageBlurTypeHigh
            };

            public: enum ImageUpVectorTypes
            {
                ImageUpVectorTypesAlignWithFloorPlane ,
                ImageUpVectorTypesUserDefined
            };

            public: enum ToneMappingTypes
            {
                ToneMappingTypesSystemScene ,
                ToneMappingTypesUserDefined
            };

            public: enum GroundPlaneTypes
            {
                GroundPlaneTypesYz,
                GroundPlaneTypesXz,
                GroundPlaneTypesXy,
                GroundPlaneTypesUserDefined
            };

            public: enum HdrTypes
            {
                HdrTypesNone,
                HdrTypesLighting1 ,
                HdrTypesLighting2 ,
                HdrTypesLighting3
            };

            public: enum NX_DEPRECATED("在NX2312.0.0中已弃用。请使用NXOpen::Preferences::SessionVisualizationVisual::GlobalFinishType代替。") GlobalFinishType
            {
                GlobalFinishTypeShinyPlastic,
                GlobalFinishTypeClassicSatin,
                GlobalFinishTypeMattePlastic,
                GlobalFinishTypeFlat,
                GlobalFinishTypeUserDefined
            };
            private: EnvironmentBuilderImpl * m_environmentbuilder_impl;
            private: friend class  _EnvironmentBuilderBuilder;
            protected: EnvironmentBuilder();
public: ~EnvironmentBuilder();
            public: NXOpen::Display::Image * Image
            (
            );
            public: void SetImage
            (
                NXOpen::Display::Image * imageBuilder 
            );
            public: NXString ImageFilename
            (
            );
            public: void SetImageFilename
            (
                const NXString & imageFileName 
            );
            void SetImageFilename
            (
                const char * imageFileName 
            );
            public: bool UseEnvironment
            (
            );
            public: void SetUseEnvironment
            (
                bool useIBL 
            );
            public: NXOpen::Expression * SizeExpression
            (
            );
            public: NXOpen::Display::EnvironmentBuilder::ImageUpVectorTypes ImageUpVectorType
            (
            );
            public: void SetImageUpVectorType
            (
                NXOpen::Display::EnvironmentBuilder::ImageUpVectorTypes imageUpVector 
            );
            public: NXOpen::Direction * ImageUpVector
            (
            );
            public: void SetImageUpVector
            (
                NXOpen::Direction * imageUpVector 
            );
            public: double ImageRotation
            (
            );
            public: void SetImageRotation
            (
                double imageRotation 
            );
            public: bool ViewFitToStage
            (
            );
            public: void SetViewFitToStage
            (
                bool viewFitToStage 
            );
            public: bool GroundVisibility
            (
            );
            public: void SetGroundVisibility
            (
                bool groundVisibility 
            );
            public: NXOpen::Display::EnvironmentBuilder::GroundPlaneTypes GroundPlaneType
            (
            );
            public: void SetGroundPlaneType
            (
                NXOpen::Display::EnvironmentBuilder::GroundPlaneTypes planeType 
            );
            public: NXOpen::Plane * SpecifyGroundPlane
            (
            );
            public: void SetSpecifyGroundPlane
            (
                NXOpen::Plane * specifyPlane 
            );
            public: NXOpen::Expression * OffsetExpression
            (
            );
            public: bool GroundReflection
            (
            );
            public: void SetGroundReflection
            (
                bool groundReflection 
            );
            public: double Reflectivity
            (
            );
            public: void SetReflectivity
            (
                double reflectivity 
            );
            public: double LightIntensity
            (
            );
            public: void SetLightIntensity
            (
                double lightIntensity 
            );
            public: double GroundGlossiness
            (
            );
            public: void SetGroundGlossiness
            (
                double groundGlossiness 
            );
            public: std::vector<double> GetGroundReflectionColor
            (
            );
            public: void SetGroundReflectionColor
            (
                const std::vector<double> & groundReflectionColor 
            );
            public: void CommitAndDisplay
            (
                NXOpen::View * view ,
                bool updateIblDisplay ,
                bool updateEnvCubeDisplay 
            );
            public: NXOpen::Display::EnvironmentBuilder::ImageBlurType ImageBlur
            (
            );
            public: void SetImageBlur
            (
                NXOpen::Display::EnvironmentBuilder::ImageBlurType imageBlurr 
            );
            public: bool UseLwrtEnvironment
            (
            );
            public: void SetUseLwrtEnvironment
            (
                bool useLwrtIBL 
            );
            public: bool UseLightsForShadowCatcherInLwrt
            (
            );
            public: void SetUseLightsForShadowCatcherInLwrt
            (
                bool useLightsForShadowCatcherInLwrt 
            );
            public: double LwrtQuality
            (
            );
            public: void SetLwrtQuality
            (
                double lwrtQuality 
            );
            public: double LwrtAngle
            (
            );
            public: void SetLwrtAngle
            (
                double lwrtAngle 
            );
            public: double LwrtIntensity
            (
            );
            public: void SetLwrtIntensity
            (
                double lwrtIntensity 
            );
            public: double ColorSaturation
            (
            );
            public: void SetColorSaturation
            (
                double colorSaturation 
            );
            public: void CommitOffset
            (
                NXOpen::View * view 
            );
            public: void FloorXaxis
            (
            );
            public: void FloorYaxis
            (
            );
            public: void FloorZaxis
            (
            );
            public: void AlignFloorPlane
            (
                NXOpen::Plane * specifyFloorPlane 
            );
            public: bool EnvironmentShadedViewsShowGroundReflection
            (
            );
            public: void SetEnvironmentShadedViewsShowGroundReflection
            (
                bool enableShadedViewsGroundRefl 
            );
            public: int EnvironmentShadedViewsGroundPlane
            (
            );
            public: void SetEnvironmentShadedViewsGroundPlane
            (
                int groundPlane 
            );
            public: NXOpen::Plane * EnvironmentShadedViewsGroundPlaneCustom
            (
            );
            public: void SetEnvironmentShadedViewsGroundPlaneCustom
            (
                NXOpen::Plane * groundPlaneCustom 
            );
            public: NX_DEPRECATED("Deprecated in NX2312.0.0.  Use NXOpen::Preferences::SessionVisualizationVisual::GlobalFinish instead.") int EnvironmentShadedViewsGlobalFinish
            (
            );
            public: NX_DEPRECATED("Deprecated in NX2312.0.0.  Use NXOpen::Preferences::SessionVisualizationVisual::SetGlobalFinish instead.") void SetEnvironmentShadedViewsGlobalFinish
            (
                int globalFinish 
            );
            public: double EnvironmentShadedViewsGroundRefReflectivity
            (
            );
            public: void SetEnvironmentShadedViewsGroundRefReflectivity
            (
                double floorReflectivity 
            );
            public: double EnvironmentShadedViewsGroundPlaneOffset
            (
            );
            public: void SetEnvironmentShadedViewsGroundPlaneOffset
            (
                double planeOffset 
            );
            public: bool EnvironmentShadedViewsFixGroundPlaneOffset
            (
            );
            public: void SetEnvironmentShadedViewsFixGroundPlaneOffset
            (
                bool fixPlaneOffset 
            );
            public: NXOpen::Vector3d ImageUpVectorCoordinate
            (
            );
            public: void SetImageUpVectorCoordinate
            (
                const NXOpen::Vector3d & imageUpVector 
            );
            public: NXOpen::View::DisplayStyleType DisplayStyle
            (
            );
            public: NXOpen::Display::EnvironmentBuilder::HdrTypes Hdr
            (
            );
            public: void SetHdr
            (
                NXOpen::Display::EnvironmentBuilder::HdrTypes hdrType 
            );
        };
    }
}
#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