XformCollection.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
//  Header for C++ interface to JA API
//--------------------------------------------------------------------------
//
//  Source File:
//     XformCollection.ja
//
//  Generated by:
//     apiwrap
//
//  WARNING:
//    This file is automatically generated - do not edit by hand
//
#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 XformCollection;
    class BasePart;
    class Xform;
    namespace Assemblies
    {
        class Component;
    }
    namespace Assemblies
    {
        class Explosion;
    }
    class Axis;
    class CoordinateSystem;
    class Direction;
    class DisplayableObject;
    class Expression;
    class ICurve;
    class IPlaneForXformByThreePlanes;
    class NXObject;
    class Offset;
    class Point;
    class Scalar;
    class View;
    class XformCollectionImpl;
    class NXOPENCPPEXPORT  XformCollection : public NXOpen::TaggedObjectCollection
    {
        public: enum AxisAndPlaneType
        {
            AxisAndPlaneTypeXaxisXyPlane,
            AxisAndPlaneTypeXaxisXzPlane,
            AxisAndPlaneTypeYaxisXyPlane,
            AxisAndPlaneTypeYaxisYzPlane,
            AxisAndPlaneTypeZaxisXzPlane,
            AxisAndPlaneTypeZaxisYzPlane
        };

        public: enum RotationSequence
        {
            RotationSequenceZXZ,
            RotationSequenceXYX,
            RotationSequenceYZY,
            RotationSequenceZYZ,
            RotationSequenceXZX,
            RotationSequenceYXY,
            RotationSequenceXYZ,
            RotationSequenceYZX,
            RotationSequenceZXY,
            RotationSequenceXZY,
            RotationSequenceZYX,
            RotationSequenceYXZ
        };
        private: XformCollectionImpl * m_xformcollection_impl;
        private: NXOpen::BasePart* m_owner;
        public: explicit XformCollection(NXOpen::BasePart *owner);
        public:
        tag_t Tag() const;
        public: ~XformCollection();
        //lint -sem(NXOpen::XformCollection::iterator::copy,initializer)
        class iterator : public std::iterator<std::forward_iterator_tag, NXOpen::Xform *>
        {
        public:
            iterator() : m_context(nullptr), m_current(NULL_TAG)
            {
                // coverity[uninit_member]
            } //lint !e1401 m_state is not initialized

            explicit iterator(NXOpen::XformCollection *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::XformCollection *m_context;
            tag_t m_current;
            unsigned int m_state[8];
        };

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

        public: NXOpen::Xform * CreateXform
        (
            const NXOpen::Point3d & origin ,
            const NXOpen::Vector3d & xDirection ,
            const NXOpen::Vector3d & yDirection ,
            NXOpen::SmartObject::UpdateOption updateOption  ,
            double scale 
        );
        public: NXOpen::Xform * CreateXform
        (
            const NXOpen::Point3d & origin ,
            const NXOpen::Matrix3x3 & orientation ,
            NXOpen::SmartObject::UpdateOption update ,
            double scale 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::SmartObject::UpdateOption updateOption  ,
            double scale 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::Point * point1  ,
            NXOpen::Point * point2  ,
            NXOpen::Point * point3  ,
            NXOpen::SmartObject::UpdateOption updateOption  ,
            double scale 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::IPlaneForXformByThreePlanes * plane1  ,
            NXOpen::IPlaneForXformByThreePlanes * plane2  ,
            NXOpen::IPlaneForXformByThreePlanes * plane3  ,
            NXOpen::SmartObject::UpdateOption updateOption  ,
            double scale 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::CoordinateSystem * csys ,
            NXOpen::Point * point0 ,
            NXOpen::Point * point1 ,
            NXOpen::Scalar * rotationScalarX ,
            NXOpen::Scalar * rotationScalarY ,
            NXOpen::Scalar * rotationScalarZ ,
            int rotationOption ,
            NXOpen::SmartObject::UpdateOption updateOption ,
            double scale 
        );
        public: NXOpen::Xform * CreateXformWithView
        (
            NXOpen::View * view ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::CoordinateSystem * csys ,
            NXOpen::Offset * point0 ,
            NXOpen::Offset * point1 ,
            NXOpen::Scalar * rotationScalarX ,
            NXOpen::Scalar * rotationScalarY ,
            NXOpen::Scalar * rotationScalarZ ,
            int rotationOption ,
            NXOpen::SmartObject::UpdateOption updateOption ,
            double scale 
        );
        public: NXOpen::Xform * CreateXformByDynamicOffset
        (
            NXOpen::CoordinateSystem * csys ,
            const NXOpen::Vector3d & originOffset ,
            const NXOpen::Matrix3x3 & trasformMatrix ,
            NXOpen::SmartObject::UpdateOption updateOption ,
            double scale 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::Point * origin  ,
            NXOpen::Direction * xDirection  ,
            NXOpen::Direction * yDirection  ,
            NXOpen::SmartObject::UpdateOption updateOption  ,
            double scale 
        );
        public: NXOpen::Xform * CreateXformByPointXDirZDir
        (
            NXOpen::Point * origin ,
            NXOpen::Direction * xDirection ,
            NXOpen::Direction * zDirection ,
            NXOpen::SmartObject::UpdateOption updateOption ,
            double scale 
        );
        public: NXOpen::Xform * CreateXformByPointYDirZDir
        (
            NXOpen::Point * origin ,
            NXOpen::Direction * yDirection ,
            NXOpen::Direction * zDirection ,
            NXOpen::SmartObject::UpdateOption updateOption ,
            double scale 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::Direction * xDirection  ,
            NXOpen::Direction * yDirection  ,
            NXOpen::SmartObject::UpdateOption updateOption  ,
            double scale 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::DisplayableObject * plane  ,
            NXOpen::Direction * axis  ,
            NXOpen::SmartObject::UpdateOption updateOption  ,
            double scale 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::Point * xPoint  ,
            NXOpen::Axis * zAxis  ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::Point * point ,
            NXOpen::Point * helperPoint  ,
            NXOpen::ICurve * curve ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::Assemblies::Component * workOcc  ,
            NXOpen::Assemblies::Component * contextObject  ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXformFromCurrentView
        (
            NXOpen::SmartObject::UpdateOption updateOption  ,
            double scale 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::NXObject * object ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::NXObject * object ,
            NXOpen::Assemblies::Explosion * explosion ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateExtractXform
        (
            NXOpen::NXObject * object ,
            NXOpen::SmartObject::UpdateOption updateOption ,
            bool forceXformCreation ,
            NXOpen::NXObject ** proto 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::Assemblies::Explosion * explosion ,
            NXOpen::Assemblies::Component * sourceComponent ,
            NXOpen::Assemblies::Component * destComponent ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXform
        (
            NXOpen::Point * origin ,
            NXOpen::XYZAxis axis ,
            NXOpen::Direction * direction ,
            NXOpen::Scalar * scale ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXformWithReverseNormal
        (
            NXOpen::Xform * xform ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXformDistanceDirection
        (
            NXOpen::Direction * direction ,
            NXOpen::Expression * distance ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXformDistanceBetweenPoints
        (
            NXOpen::Point * origin ,
            NXOpen::Point * measure ,
            NXOpen::Direction * vector ,
            NXOpen::Expression * distance ,
            NXOpen::Expression * originDistance ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXformDistanceRadial
        (
            NXOpen::Axis * axis ,
            NXOpen::Point * point ,
            NXOpen::Expression * distance ,
            NXOpen::Expression * originDistance ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXformAngleAxis
        (
            NXOpen::Axis * axis ,
            NXOpen::Expression * angle ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXformTwoPoints
        (
            NXOpen::Point * from ,
            NXOpen::Point * to ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXformRotateThreePoints
        (
            NXOpen::Axis * vector ,
            NXOpen::Point * start ,
            NXOpen::Point * end ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXformAxisVector
        (
            NXOpen::Axis * axis ,
            NXOpen::Direction * vector ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXformCsysToCsys
        (
            NXOpen::CoordinateSystem * from ,
            NXOpen::CoordinateSystem * to ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXformDistanceAngle
        (
            NXOpen::Expression * distance ,
            NXOpen::Expression * angle ,
            NXOpen::Axis * dirr ,
            NXOpen::Direction * angulardirr ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXformDynamic
        (
            const std::vector<NXOpen::Scalar *> & org ,
            const std::vector<NXOpen::Scalar *> & mtx ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXformDeltaXyz
        (
            const std::vector<NXOpen::Scalar *> & delta ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
        public: NXOpen::Xform * CreateXformByPlaneXDirPoint
        (
            NXOpen::DisplayableObject * plane ,
            NXOpen::Direction * xDirection ,
            NXOpen::Point * point ,
            NXOpen::SmartObject::UpdateOption updateOption ,
            double scale ,
            bool flipXDirection ,
            bool flipZDirection 
        );
        public: NXOpen::Xform * CreateXformByPlaneYDirPoint
        (
            NXOpen::DisplayableObject * plane ,
            NXOpen::Direction * yDirection ,
            NXOpen::Point * point ,
            NXOpen::SmartObject::UpdateOption updateOption ,
            double scale ,
            bool flipYDirection ,
            bool flipZDirection 
        );
        public: NXOpen::Xform * CreateXformExtract
        (
            NXOpen::SmartObject::UpdateOption updateOption ,
            NXOpen::Xform * xform1 ,
            NXOpen::Xform * xform2 
        );
        public: NXOpen::Xform * CreateXformPqr
        (
            NXOpen::SmartObject::UpdateOption updateOption ,
            NXOpen::Point * origin ,
            NXOpen::Point * pPoint ,
            NXOpen::Point * qPoint ,
            double scale ,
            NXOpen::XformCollection::AxisAndPlaneType axisAndPlaneType 
        );
        public: NXOpen::Xform * CreateXformEulerTaitBryanAngles
        (
            NXOpen::CoordinateSystem * csys ,
            NXOpen::Point * originPoint ,
            NXOpen::XformCollection::RotationSequence sequence ,
            NXOpen::Scalar * rotationScalarX ,
            NXOpen::Scalar * rotationScalarY ,
            NXOpen::Scalar * rotationScalarZ ,
            double scale ,
            NXOpen::SmartObject::UpdateOption updateOption 
        );
    }; //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