PointCollection.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
//  JA API的C++接口头文件
//--------------------------------------------------------------------------
//
//  源文件:
//     PointCollection.ja
//
//  生成工具:
//     apiwrap
//
//  警告:
//    此文件为自动生成，请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <iterator>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/TaggedObjectCollection.hxx>
#include <NXOpen/SmartObject.hxx>
#include <NXOpen/TaggedObject.hxx>
#include <NXOpen/type.hxx>
#include <NXOpen/ugmath.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 PointCollection;
    class BasePart;
    class Point;
    namespace Annotations
    {
        class Annotation;
    }
    namespace CAE
    {
        class CAEFace;
    }
    class CartesianCoordinateSystem;
    class CoordinateSystem;
    class Direction;
    class Expression;
    class IBaseCurve;
    class IBasePlane;
    class IParameterizedSurface;
    class ISurface;
    class Offset;
    namespace Routing
    {
        class IRoutePosition;
    }
    namespace Routing
    {
        class Port;
    }
    class ScCollector;
    class Scalar;
    class TaggedObject;
    class View;
    class Xform;
    class PointCollectionImpl;
    class NXOPENCPPEXPORT  PointCollection : public NXOpen::TaggedObjectCollection
    {
        public: enum AlongCurveOption
        {
            AlongCurveOptionDistance,
            AlongCurveOptionPercent
        };

        public: enum PointOnCurveLocationOption
        {
            PointOnCurveLocationOptionParameter,
            PointOnCurveLocationOptionPercentParameter,
            PointOnCurveLocationOptionArcLength,
            PointOnCurveLocationOptionPercentArcLength
        };

        public: enum ShipCoordinatesXdirectiontype
        {
            ShipCoordinatesXdirectiontypeForward ,
            ShipCoordinatesXdirectiontypeAft
        };

        public: enum ShipCoordinatesYdirectiontype
        {
            ShipCoordinatesYdirectiontypePort ,
            ShipCoordinatesYdirectiontypeStarboard
        };

        public: enum ShipCoordinatesZdirectiontype
        {
            ShipCoordinatesZdirectiontypeAbove ,
            ShipCoordinatesZdirectiontypeBelow
        };
        private: PointCollectionImpl * m_pointcollection_impl;
        private: NXOpen::BasePart* m_owner;
        public: explicit PointCollection(NXOpen::BasePart *owner);
        public:
        tag_t Tag() const;
        public: ~PointCollection();
        //lint -sem(NXOpen::PointCollection::iterator::copy,initializer)
        class iterator : public std::iterator<std::forward_iterator_tag, NXOpen::Point *>
        {
        public:
            iterator() : m_context(nullptr), m_current(NULL_TAG)
            {
                // coverity[uninit_member]
            } //lint !e1401 m_state is not initialized

            explicit iterator(NXOpen::PointCollection *context) : m_context(context), m_current(NULL_TAG)
            {
                // coverity[uninit_member]
            }//lint !e1401 m_state is not initialized

            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::PointCollection *m_context;
            tag_t m_current;
            unsigned int m_state[8];
        };

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

        public: NXOpen::Point * CreatePoint
        (
            const NXOpen::Point3d & coordinates 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::Offset * offset  ,
            NXOpen::Point * offsetPoint ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::IParameterizedSurface * face  ,
            NXOpen::Scalar * scalarU ,
            NXOpen::Scalar * scalarV ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::View * view  ,
            NXOpen::IBaseCurve * edgeCurve1 ,
            NXOpen::IBaseCurve * edgeCurve2 ,
            const NXOpen::Point3d & helpPt ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::IBaseCurve * edgeCurve ,
            NXOpen::Scalar * scalarT ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::IBaseCurve * edgeCurve ,
            NXOpen::Scalar * scalarT ,
            NXOpen::PointCollection::PointOnCurveLocationOption locationOption ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::IBaseCurve * edgeCurve ,
            NXOpen::Scalar * scalarT ,
            NXOpen::SmartObject::UpdateOption updateOption  ,
            bool useReverseParameter 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::IBaseCurve * edgeCurve ,
            NXOpen::Point * pointOffset ,
            NXOpen::Scalar * distancePercent ,
            NXOpen::PointCollection::AlongCurveOption option ,
            NXOpen::Sense sense ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::Scalar * scalarX ,
            NXOpen::Scalar * scalarY ,
            NXOpen::Scalar * scalarZ ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::Point * pointExtract ,
            NXOpen::Xform * xform ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::IBaseCurve * edgeCurve  ,
            NXOpen::Scalar * angle ,
            NXOpen::Xform * xform ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::IBaseCurve * edgeCurve  ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::IBaseCurve * curve1 ,
            NXOpen::IBaseCurve * curve2 ,
            NXOpen::Point * helpPt1 ,
            NXOpen::Point * helpPt2 ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::IBaseCurve * curve1 ,
            NXOpen::IBaseCurve * curve2 ,
            const NXOpen::Point3d & startPoint ,
            NXOpen::View * view ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::IParameterizedSurface * face  ,
            NXOpen::IBaseCurve * curve ,
            NXOpen::Point * helpPt1 ,
            NXOpen::Point * helpPt2 ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::IBasePlane * plane ,
            NXOpen::IBaseCurve * curve ,
            NXOpen::Point * helpPt1 ,
            NXOpen::Point * helpPt2 ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::IParameterizedSurface * sphericalFace  ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::Routing::IRoutePosition * routePosition  ,
            NXOpen::Xform * xform ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * FindObject
        (
            const NXString & journalIdentifier 
        );
        NXOpen::Point * FindObject
        (
            const char * journalIdentifier 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::CartesianCoordinateSystem * csys ,
            NXOpen::Scalar * scalarX ,
            NXOpen::Scalar * scalarY ,
            NXOpen::Scalar * scalarZ ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::Point * point1  ,
            NXOpen::Point * point2  ,
            NXOpen::Scalar * distancePercentage  ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreateVirtualIntersectionPoint
        (
            NXOpen::IBaseCurve * curve1 ,
            NXOpen::IBaseCurve * curve2 ,
            NXOpen::Point * helpPt1 ,
            NXOpen::Point * helpPt2 ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::Expression * exp ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreateStockOffsetPoint
        (
            NXOpen::Point * basePoint ,
            NXOpen::Direction * offsetDirr ,
            const NXString & offsetExpression ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        NXOpen::Point * CreateStockOffsetPoint
        (
            NXOpen::Point * basePoint ,
            NXOpen::Direction * offsetDirr ,
            const char * offsetExpression ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * EditStockOffsetPoint
        (
            NXOpen::Point * basePoint ,
            NXOpen::Direction * offsetDirr ,
            const NXString & offsetExpression ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        NXOpen::Point * EditStockOffsetPoint
        (
            NXOpen::Point * basePoint ,
            NXOpen::Direction * offsetDirr ,
            const char * offsetExpression ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePointOnPortExtractAlign
        (
            NXOpen::SmartObject::UpdateOption updateOption  ,
            NXOpen::Routing::Port * port ,
            NXOpen::Scalar * distance 
        );
        public: NXOpen::Point * CreatePointOnSurfaceAxis
        (
            NXOpen::TaggedObject * face ,
            NXOpen::Scalar * parameter ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::CAE::CAEFace * face ,
            NXOpen::Point * projectedPoint ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreateQuadrantPoint
        (
            NXOpen::IBaseCurve * curveOrEdge ,
            int quadrant ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePointOnSectionCG
        (
            NXOpen::SmartObject::UpdateOption updateOption ,
            NXOpen::TaggedObject * face 
        );
        public: void DeletePoint
        (
            NXOpen::Point * point 
        );
        public: void RemoveParameters
        (
            NXOpen::Point * point 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::ScCollector * faces ,
            NXOpen::IBaseCurve * curve ,
            NXOpen::Point * helpPt1 ,
            NXOpen::Point * helpPt2 ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::SmartObject::UpdateOption updateOption  ,
            NXOpen::Annotations::Annotation * annotation  ,
            NXOpen::Scalar * t  ,
            int side  ,
            int block  ,
            bool attachFcfToDim 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::IBaseCurve * splarc  ,
            NXOpen::View * view 
        );
        public: NXOpen::Point * CreatePointSplinePole
        (
            NXOpen::IBaseCurve * splineCurve ,
            int poleIndex ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePointSplarc
        (
            NXOpen::IBaseCurve * splarc ,
            NXOpen::View * view 
        );
        public: NXOpen::Point * CreatePointSplineDefiningPoint
        (
            NXOpen::IBaseCurve * splineCurve ,
            int definingPointIndex ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePoint
        (
            NXOpen::IBaseCurve * edgeCurve ,
            NXOpen::Scalar * scalarT ,
            NXOpen::PointCollection::PointOnCurveLocationOption locationOption ,
            NXOpen::Point * specifiedPoint ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePointAtCoordinateSystemOrigin
        (
            NXOpen::SmartObject::UpdateOption updateOption ,
            NXOpen::CoordinateSystem * smartCsys 
        );
        public: NXOpen::Point * CreatePointBSurfacePole
        (
            NXOpen::IParameterizedSurface * face ,
            int uIndex ,
            int vIndex ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreateCurveMidPoint
        (
            NXOpen::IBaseCurve * curve  ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Point * CreatePointFromShipCoordinates
        (
            NXOpen::SmartObject::UpdateOption updateOption  ,
            NXOpen::IBasePlane * xPlane ,
            NXOpen::IBasePlane * yPlane ,
            NXOpen::IBasePlane * zPlane ,
            NXOpen::PointCollection::ShipCoordinatesXdirectiontype xDirection ,
            NXOpen::PointCollection::ShipCoordinatesYdirectiontype yDirection ,
            NXOpen::PointCollection::ShipCoordinatesZdirectiontype zDirection ,
            NXOpen::Scalar * xDistance ,
            NXOpen::Scalar * yDistance ,
            NXOpen::Scalar * zDistance 
        );
    }; //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