ViewCollection.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
// C++接口到JA API的头文件
//--------------------------------------------------------------------------
//
// 源文件:
//     ViewCollection.ja
//
// 生成工具:
//     apiwrap
//
// 警告:
//    此文件为自动生成 - 请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <iterator>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/BasePart.hxx>
#include <NXOpen/Display_Background.hxx>
#include <NXOpen/Display_DownloadOfflineRenderingBuilder.hxx>
#include <NXOpen/Display_EnvironmentBuilder.hxx>
#include <NXOpen/Display_ExtractScene.hxx>
#include <NXOpen/Display_GlobalIlluminationBuilder.hxx>
#include <NXOpen/Display_IRayPlusStudioEditorBuilder.hxx>
#include <NXOpen/Display_IRayPlusStudioPreferencesBuilder.hxx>
#include <NXOpen/Display_Image.hxx>
#include <NXOpen/Display_ImageBasedLighting.hxx>
#include <NXOpen/Display_IrayPlusMaterialEditorBuilder.hxx>
#include <NXOpen/Display_IrayPlusSimpleMaterialEditorBuilder.hxx>
#include <NXOpen/Display_IrayPlusStudioAnimationBuilder.hxx>
#include <NXOpen/Display_LightBuilder.hxx>
#include <NXOpen/Display_Lighting.hxx>
#include <NXOpen/Display_NonProportionalZoom.hxx>
#include <NXOpen/Display_RayTracedStudioBuilder.hxx>
#include <NXOpen/Display_RayTracedStudioEditorBuilder.hxx>
#include <NXOpen/Display_RayTracedStudioPreferencesBuilder.hxx>
#include <NXOpen/Display_Reflection.hxx>
#include <NXOpen/Display_SaveImageFileBrowserBuilder.hxx>
#include <NXOpen/Display_Scene.hxx>
#include <NXOpen/Display_Shadows.hxx>
#include <NXOpen/Display_Stage.hxx>
#include <NXOpen/Display_StudioImageCaptureBuilder.hxx>
#include <NXOpen/Display_VisualMaterialEditorBaseBuilder.hxx>
#include <NXOpen/Display_VisualMaterialEditorBuilder.hxx>
#include <NXOpen/Display_VisualMaterialEditorCoatingBuilder.hxx>
#include <NXOpen/Display_VisualMaterialEditorEmissionBuilder.hxx>
#include <NXOpen/Display_VisualMaterialEditorFinishBuilder.hxx>
#include <NXOpen/Display_VisualMaterialEditorSettingsBuilder.hxx>
#include <NXOpen/Display_VisualMaterialEditorTextureSpaceBuilder.hxx>
#include <NXOpen/Display_VisualMaterialEditorTexturesBuilder.hxx>
#include <NXOpen/Display_VisualMaterialEditorTransmissionBuilder.hxx>
#include <NXOpen/Display_VisualMaterialEditorUtilitiesBuilder.hxx>
#include <NXOpen/Display_Wall.hxx>
#include <NXOpen/Gateway_ImageExportBuilder.hxx>
#include <NXOpen/TaggedObjectCollection.hxx>
#include <NXOpen/TaggedObject.hxx>
#include <NXOpen/View.hxx>
#include <NXOpen/libnxopencpp_exports.hxx>
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable:4996)
#endif
#ifdef __GNUC__
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
namespace NXOpen
{
    class ViewCollection;
    class BasePart;
    class View;
    namespace Display
    {
        class Background;
    }
    namespace Display
    {
        class DownloadOfflineRenderingBuilder;
    }
    namespace Display
    {
        class EnvironmentBuilder;
    }
    namespace Display
    {
        class ExtractScene;
    }
    namespace Display
    {
        class GlobalIlluminationBuilder;
    }
    namespace Display
    {
        class IRayPlusStudioEditorBuilder;
    }
namespace Display
    {
        class IRayPlusStudioPreferencesBuilder;
    }
    namespace Display
    {
        class Image;
    }
    namespace Display
    {
        class ImageBasedLighting;
    }
    namespace Display
    {
        class IrayPlusMaterialEditorBuilder;
    }
    namespace Display
    {
        class IrayPlusSimpleMaterialEditorBuilder;
    }
    namespace Display
    {
        class IrayPlusStudioAnimationBuilder;
    }
    namespace Display
    {
        class LightBuilder;
    }
    namespace Display
    {
        class Lighting;
    }
    namespace Display
    {
        class NonProportionalZoom;
    }
    namespace Display
    {
        class RayTracedStudioBuilder;
    }
    namespace Display
    {
        class RayTracedStudioEditorBuilder;
    }
    namespace Display
    {
        class RayTracedStudioPreferencesBuilder;
    }
    namespace Display
    {
        class Reflection;
    }
    namespace Display
    {
        class SaveImageFileBrowserBuilder;
    }
    namespace Display
    {
        class Scene;
    }
    namespace Display
    {
        class Shadows;
    }
    namespace Display
    {
        class Stage;
    }
    namespace Display
    {
        class StudioImageCaptureBuilder;
    }
    namespace Display
    {
        class VisualMaterialEditorBaseBuilder;
    }
    namespace Display
    {
        class VisualMaterialEditorBuilder;
    }
    namespace Display
    {
        class VisualMaterialEditorCoatingBuilder;
    }
    namespace Display
    {
        class VisualMaterialEditorEmissionBuilder;
    }
    namespace Display
    {
        class VisualMaterialEditorFinishBuilder;
    }
    namespace Display
    {
        class VisualMaterialEditorSettingsBuilder;
    }
    namespace Display
    {
        class VisualMaterialEditorTextureSpaceBuilder;
    }
namespace Display
    {
        class VisualMaterialEditorTexturesBuilder;
    }
    namespace Display
    {
        class VisualMaterialEditorTransmissionBuilder;
    }
    namespace Display
    {
        class VisualMaterialEditorUtilitiesBuilder;
    }
    namespace Display
    {
        class Wall;
    }
    namespace Gateway
    {
        class ImageExportBuilder;
    }
    class Light;
    class ViewCollectionImpl;
    class NXOPENCPPEXPORT  ViewCollection : public NXOpen::TaggedObjectCollection
    {
        public:
        struct HighEndRenderImageResults
        {
            public:  int Iterations;
            public:  double Seconds;
            public: HighEndRenderImageResults() :
                Iterations(),
                Seconds()
            {
            }
            public: HighEndRenderImageResults(int iterationsInitial  ,
                    double secondsInitial  ) :
                Iterations(iterationsInitial),
                Seconds(secondsInitial)
            {
            }
        };
        private: ViewCollectionImpl * m_viewcollection_impl;
        private: NXOpen::BasePart* m_owner;
        public: explicit ViewCollection(NXOpen::BasePart *owner);
        public:
        tag_t Tag() const;
        public: ~ViewCollection();
        //lint -sem(NXOpen::ViewCollection::iterator::copy,initializer)
        class iterator : public std::iterator<std::forward_iterator_tag, NXOpen::View *>
        {
        public:
            iterator() : m_context(nullptr), m_current(NULL_TAG)
            {
                // coverity[uninit_member]
            } //lint !e1401 m_state 未初始化

            explicit iterator(NXOpen::ViewCollection *context) : m_context(context), m_current(NULL_TAG)
            {
                // coverity[uninit_member]
            }//lint !e1401 m_state 未初始化

            iterator(const iterator &other): m_context(nullptr), m_current(NULL_TAG)
            {
                copy(other);
            }

            iterator &operator =(const iterator &other)
            {
                if (&other != this)
                    copy(other);
                return *this;
            }

            bool operator ==(const iterator &other) const
            {
                return m_current == other.m_current && m_context == other.m_context;
            }

            bool operator !=(const iterator &other) const
            {
                return !operator == (other);
            }

            NXOPENCPPEXPORT  value_type operator * () const;
            iterator & operator ++()
{
                next();
                return *this;
            }

            iterator operator ++(int)
            {
                iterator tmp(*this);
                ++*this;
                return tmp;
            }
        private:
            void copy(const iterator &other)
            {
                m_context = other.m_context;
                m_current = other.m_current;
                for (int i = 0; i < sizeof(m_state)/sizeof(m_state[0]); i++)
                     m_state[i] = other.m_state[i];
            }
            NXOPENCPPEXPORT  void next();
            NXOpen::ViewCollection *m_context;
            tag_t m_current;
            unsigned int m_state[8];
        };

        iterator begin();
        iterator end()
        {
            return iterator(this);
        }

        public: void Refresh
        (
        );
        public: std::vector<NXOpen::View *> GetActiveViews
        (
        );
        public: std::vector<NXString> GetCustomViews
        (
        );
        public: NXOpen::View * WorkView
        (
        );
        public: bool IsWorkViewExpanded
        (
        );
        public: NXOpen::View * SaveAs
        (
            NXOpen::View * selectedView ,
            const NXString & newViewName ,
            bool copyViewModifications ,
            bool moveViewDependencies 
        );
        NXOpen::View * SaveAs
        (
            NXOpen::View * selectedView ,
            const char * newViewName ,
            bool copyViewModifications ,
            bool moveViewDependencies 
        );
        public: void Save
        (
        );
        public: NXOpen::View * FindObject
        (
            const NXString & journalIdentifier 
        );
        NXOpen::View * FindObject
        (
            const char * journalIdentifier 
        );
        public: void UnexpandWork
        (
        );
        public: void FitAll
        (
        );
        public: void Regenerate
        (
        );
        public: void UpdateDisplay
        (
        );
        public: NXOpen::Display::Scene * CreateScene
        (
            NXOpen::View * view ,
            bool makeReferencedObjects 
        );
        public: NXOpen::Display::Background * CreateBackground
        (
            NXOpen::View * view ,
            bool makeReferencedObjects 
        );
        public: NX_DEPRECATED("Deprecated in NX2406.0.0.  Use NXOpen::ViewCollection::CreateShadowsForDisplayStyle overload instead.") NXOpen::Display::Shadows * CreateShadows
        (
            NXOpen::View * view 
        );
        public: NXOpen::Display::Shadows * CreateShadowsForDisplayStyle
        (
            NXOpen::View * view ,
            NXOpen::View::DisplayStyleType displayStyle 
        );
        public: NXOpen::Display::Image * CreateImage
        (
            NXOpen::View * view 
        );
        public: NXOpen::Display::Stage * CreateStage
        (
            NXOpen::View * view ,
            bool makeReferencedObjects 
        );
        public: NXOpen::Display::Wall * CreateWall
        (
            NXOpen::View * view ,
            NXOpen::Display::Stage::WallType wallType 
        );
        public: NXOpen::Display::Reflection * CreateReflection
        (
            NXOpen::View * view ,
            bool makeReferencedObjects 
        );
        public: NXOpen::Display::Lighting * CreateLighting
        (
            NXOpen::View * view 
        );
        public: NXOpen::Display::LightBuilder * CreateLightBuilder
        (
            NXOpen::Light * light 
        );
        public: NXOpen::Display::ImageBasedLighting * CreateImageBasedLighting
        (
            NXOpen::View * view ,
            bool makeReferencedObjects 
        );
        public: NXOpen::Display::ExtractScene * CreateExtractScene
        (
            NXOpen::View * view 
        );
        public: NXOpen::Display::NonProportionalZoom * CreateNonProportionalZoom
        (
        );
        public: NXOpen::Display::StudioImageCaptureBuilder * CreateStudioImageCaptureBuilder
        (
        );
        public: NXOpen::View * SaveAsPreservingCase
        (
            NXOpen::View * selectedView ,
            const NXString & newViewName ,
            bool copyViewModifications ,
            bool moveViewDependencies 
        );
        NXOpen::View * SaveAsPreservingCase
        (
            NXOpen::View * selectedView ,
            const char * newViewName ,
            bool copyViewModifications ,
            bool moveViewDependencies 
        );
        public: void SaveView
        (
            NXOpen::View * view 
        );
        public: NXOpen::View * CopyViewInPart
        (
            NXOpen::View * view 
        );
        public: NXOpen::Display::RayTracedStudioBuilder * CreateRayTracedStudioBuilder
        (
        );
        public: NXOpen::Display::SaveImageFileBrowserBuilder * CreateSaveImageFileBrowserBuilder
        (
        );
        public: NXOpen::Display::GlobalIlluminationBuilder * CreateGlobalIlluminationBuilder
        (
        );
        public: NXOpen::Display::RayTracedStudioPreferencesBuilder * CreateRayTracedStudioPreferencesBuilder
        (
        );
        public: NX_DEPRECATED("Deprecated in NX1980.0.0.  Use NXOpen::Display::RayTracedStudioPreferencesBuilder instead.") NXOpen::Display::RayTracedStudioEditorBuilder * CreateRayTracedStudioEditorBuilder
        (
        );
        public: NX_DEPRECATED("Deprecated in NX1980.0.0.  Use NXOpen::Display::IRayPlusStudioPreferencesBuilder instead.") NXOpen::Display::IRayPlusStudioEditorBuilder * CreateIrayPlusStudioEditorBuilder
        (
        );
        public: NX_DEPRECATED("Deprecated in NX2312.0.0.  Use NXOpen::ViewCollection::CreateEnvironmentBuilderForDisplayStyle overload instead.") NXOpen::Display::EnvironmentBuilder * CreateEnvironmentBuilder
        (
            NXOpen::View * view ,
            bool makeReferencedObjects 
        );
        public: NXOpen::Display::EnvironmentBuilder * CreateEnvironmentBuilderForDisplayStyle
        (
            NXOpen::View * view ,
            NXOpen::View::DisplayStyleType displayStyle ,
            bool makeReferencedObjects 
        );
        public: NXOpen::Display::IRayPlusStudioPreferencesBuilder * CreateIrayPlusStudioPreferencesBuilder
        (
        );
        public: NXOpen::Display::DownloadOfflineRenderingBuilder * CreateDownloadOfflineRenderingBuilder
        (
        );
        public: NXOpen::Display::IrayPlusStudioAnimationBuilder * CreateIrayPlusStudioAnimationBuilder
        (
        );
        public: NXOpen::Display::IrayPlusSimpleMaterialEditorBuilder * CreateIrayPlusSimpleMaterialEditorBuilder
        (
        );
        public: NXOpen::Display::IrayPlusMaterialEditorBuilder * CreateIrayPlusMaterialEditorBuilder
        (
            const NXString & materialName 
        );
        NXOpen::Display::IrayPlusMaterialEditorBuilder * CreateIrayPlusMaterialEditorBuilder
        (
            const char * materialName 
        );
        public: std::vector<NXOpen::View *> GetDisclosedModelViews
        (
        );
        public: std::vector<NXOpen::View *> GetDisclosedModelViewsAndPurposes
        (
            std::vector<NXString> & disclosurePurposes 
        );
        public: NXOpen::ViewCollection::HighEndRenderImageResults CreateHighEndRenderImage
        (
            const NXString & fileLocation 
        );
        NXOpen::ViewCollection::HighEndRenderImageResults CreateHighEndRenderImage
        (
            const char * fileLocation 
        );
        public: void DestroyHighEndRenderSession
        (
        );
        public: NXOpen::Display::VisualMaterialEditorBuilder * CreateVisualMaterialEditorBuilder
        (
            const NXString & materialName 
        );
        NXOpen::Display::VisualMaterialEditorBuilder * CreateVisualMaterialEditorBuilder
        (
            const char * materialName 
        );
        public: NXOpen::Display::VisualMaterialEditorBaseBuilder * CreateVisualMaterialEditorBaseBuilder
        (
            const NXString & materialName 
        );
        NXOpen::Display::VisualMaterialEditorBaseBuilder * CreateVisualMaterialEditorBaseBuilder
        (
            const char * materialName 
        );
        public: NXOpen::Display::VisualMaterialEditorCoatingBuilder * CreateVisualMaterialEditorCoatingBuilder
        (
            const NXString & materialName 
        );
        NXOpen::Display::VisualMaterialEditorCoatingBuilder * CreateVisualMaterialEditorCoatingBuilder
        (
            const char * materialName 
        );
        public: NXOpen::Display::VisualMaterialEditorEmissionBuilder * CreateVisualMaterialEditorEmissionBuilder
        (
            const NXString & materialName 
        );
        NXOpen::Display::VisualMaterialEditorEmissionBuilder * CreateVisualMaterialEditorEmissionBuilder
        (
            const char * materialName 
        );
        public: NXOpen::Display::VisualMaterialEditorFinishBuilder * CreateVisualMaterialEditorFinishBuilder
        (
            const NXString & materialName 
        );
        NXOpen::Display::VisualMaterialEditorFinishBuilder * CreateVisualMaterialEditorFinishBuilder
        (
            const char * materialName 
        );
        public: NXOpen::Display::VisualMaterialEditorSettingsBuilder * CreateVisualMaterialEditorSettingsBuilder
        (
            const NXString & materialName 
        );
        NXOpen::Display::VisualMaterialEditorSettingsBuilder * CreateVisualMaterialEditorSettingsBuilder
        (
            const char * materialName 
        );
        public: NXOpen::Display::VisualMaterialEditorTextureSpaceBuilder * CreateVisualMaterialEditorTextureSpaceBuilder
        (
            const NXString & materialName 
        );
        NXOpen::Display::VisualMaterialEditorTextureSpaceBuilder * CreateVisualMaterialEditorTextureSpaceBuilder
        (
            const char * materialName 
        );
        public: NXOpen::Display::VisualMaterialEditorTexturesBuilder * CreateVisualMaterialEditorTexturesBuilder
        (
            const NXString & materialName 
        );
        NXOpen::Display::VisualMaterialEditorTexturesBuilder * CreateVisualMaterialEditorTexturesBuilder
        (
            const char * materialName 
        );
        public: NXOpen::Display::VisualMaterialEditorTransmissionBuilder * CreateVisualMaterialEditorTransmissionBuilder
        (
            const NXString & materialName 
        );
        NXOpen::Display::VisualMaterialEditorTransmissionBuilder * CreateVisualMaterialEditorTransmissionBuilder
        (
            const char * materialName 
        );
        public: NXOpen::Display::VisualMaterialEditorUtilitiesBuilder * CreateVisualMaterialEditorUtilitiesBuilder
        (
            const NXString & materialName 
        );
        NXOpen::Display::VisualMaterialEditorUtilitiesBuilder * CreateVisualMaterialEditorUtilitiesBuilder
        (
            const char * materialName 
        );
        public: NXOpen::Gateway::ImageExportBuilder * CreateImageExportBuilder
        (
        );
    }; //lint !e1712 default constructor not defined for class
}
#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