Routing_SplinePathBuilder.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
//  JA API的C++接口头文件
//--------------------------------------------------------------------------
//
//  源文件:
//     Routing_SplinePathBuilder.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/ugmath.hxx>
#include <NXOpen/libnxopencpp_routing_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 Routing
    {
        class SplinePathBuilder;
    }
    class Builder;
    class Curve;
    class Direction;
    class Expression;
    class NXObject;
    class Point;
    namespace Routing
    {
        class AssignTangencyBuilder;
    }
    namespace Routing
    {
        class ControlPoint;
    }
    namespace Routing
    {
        class Stock;
    }
    namespace Routing
    {
        class _SplinePathBuilderBuilder;
        class SplinePathBuilderImpl;
        class NXOPENCPP_ROUTINGEXPORT  SplinePathBuilder : public NXOpen::Builder
        {
            public: enum DefiningTypes
            {
                DefiningTypesUnsupported,
                DefiningTypesInterpolation,
                DefiningTypesParametric,
                DefiningTypesBezier,
                DefiningTypesBezierSlack,
                DefiningTypesBezierMaxCurvature,
                DefiningTypesBezierMaxCurvatureSlacked
            };

            public: enum DefiningPointMethod
            {
                DefiningPointMethodCreatePoint ,
                DefiningPointMethodUseExisting
            };

            public: enum DragMode
            {
                DragModeActive,
                DragModeInactive
            };

            public: enum SplinePathSlackType
            {
                SplinePathSlackTypePercentLength,
                SplinePathSlackTypeAdditionalLength,
                SplinePathSlackTypeLockLength,
                SplinePathSlackTypeTotalPercentage,
                SplinePathSlackTypeTotalAdditional,
                SplinePathSlackTypeUndefined
            };

            public: enum SplinePathAttributeOptions
            {
                SplinePathAttributeOptionsRadius,
                SplinePathAttributeOptionsRatioToDiameter
            };

            public: enum SplinePathRadiusSource
            {
                SplinePathRadiusSourceExpression,
                SplinePathRadiusSourceRatioToDiameter,
                SplinePathRadiusSourceAttribute
            };
            private: SplinePathBuilderImpl * m_splinepathbuilder_impl;
            private: friend class  _SplinePathBuilderBuilder;
            protected: SplinePathBuilder();
public: ~SplinePathBuilder();
            public: int AddDefiningPointToSpline
            (
                NXOpen::Point * point ,
                bool createNewPoint 
            );
            public: void AddDefiningPointAtAbsoluteCoords
            (
                const NXOpen::Point3d & point 
            );
            public: void UpdateDefiningPointPositionAtIndex
            (
                int index ,
                NXOpen::Point * point ,
                bool inDrag 
            );
            public: void UpdateDefiningPoint
            (
                int index ,
                NXOpen::Point * point ,
                bool inDrag ,
                const NXOpen::Vector3d & translation 
            );
            public: void DeleteDefiningPointAtIndex
            (
                int index 
            );
            public: void SetLockToSelectedFlag
            (
                bool lockSelected 
            );
            public: void SetAddPointsOnSubdivideFlag
            (
                bool addPoints 
            );
            public: void SetCreateTangencyFlag
            (
                bool createTangency 
            );
            public: double GetSplineLength
            (
            );
            public: double GetSplineLengthNoShaping
            (
            );
            public: void LockSplineLengthWithShaping
            (
                NXOpen::Expression * length ,
                NXOpen::Direction * slackDirection 
            );
            public: void LockSplineLengthWithShapingFixedPoints
            (
                NXOpen::Expression * length ,
                NXOpen::Direction * slackDirection 
            );
            public: void ShapeByAdditionalLengthMovingPoints
            (
                NXOpen::Expression * length ,
                NXOpen::Routing::SplinePathBuilder::SplinePathSlackType slackType ,
                NXOpen::Direction * slackDirection 
            );
            public: void LockSplineLengthNoShaping
            (
                NXOpen::Expression * length 
            );
            public: void SetSplineLength
            (
                NXOpen::Expression * length 
            );
            public: void RemoveAllShaping
            (
            );
            public: void RemoveLengthConstraint
            (
            );
            public: void IsLengthLocked
            (
                NXOpen::Expression ** length ,
                bool* isLocked ,
                NXOpen::Direction ** slackDirection 
            );
            public: void AddSlackToSpline
            (
                NXOpen::Routing::SplinePathBuilder::SplinePathSlackType slackType ,
                NXOpen::Expression * slackValue ,
                NXOpen::Direction * slackDirection 
            );
            public: void IsSplineSlacked
            (
                bool* slacked ,
                NXOpen::Routing::SplinePathBuilder::SplinePathSlackType* slackType ,
                NXOpen::Expression ** slackValue ,
                NXOpen::Direction ** downDir 
            );
            public: void InitializeDrag
            (
                int index 
            );
            public: void CommitDrag
            (
                NXOpen::Point * definingPoint 
            );
            public: void AssignExtension
            (
                int pointIndex ,
                NXOpen::Direction * direction ,
                NXOpen::Expression * forwardLength ,
                NXOpen::Expression * backwardLength 
            );
            public: void AssignHealPathExtension
            (
                int pointIndex ,
                NXOpen::Direction * direction ,
                NXOpen::Expression * forwardLength ,
                NXOpen::Expression * backwardLength 
            );
            public: void CreateHealPathConstraints
            (
                NXOpen::NXObject * startObject ,
                NXOpen::NXObject * endObject 
            );
            public: void AskDefiningData
            (
                std::vector<NXOpen::Point *> & points 
            );
            public: void GetExtensionDataForPointAtIndex
            (
                int index ,
                NXOpen::Expression ** forwardLength ,
                NXOpen::Expression ** backwardLength ,
                NXOpen::Vector3d* extDirection 
            );
            public: void GetDefiningPointPositions
            (
                std::vector<double> & pointPositions 
            );
            public: void GetDefiningPointPositionsAsPoints
            (
                std::vector<NXOpen::Point3d> & pointPositions 
            );
            public: NXOpen::Curve * GetRouteSegment
            (
            );
            public: NXOpen::Routing::ControlPoint * GetStartAndEndRcp
            (
                NXOpen::Routing::ControlPoint ** startRcp 
            );
            public: void DetachPoint
            (
                int index 
            );
            public: void GetOffsetData
            (
                int index ,
                int* method ,
                NXOpen::Point ** basePoint ,
                NXOpen::Direction ** offDir ,
                NXString* exp 
            );
            public: NXOpen::Routing::Stock * GetLargestDiameterStock
            (
            );
            public: double GetLockedSplineMinimumLength
            (
            );
            public: bool UseMinimumCheckingValue
            (
            );
            public: void SetUseMinimumCheckingValue
            (
                bool useMinRadius 
            );
            public: NXOpen::Routing::SplinePathBuilder::SplinePathAttributeOptions MinimumCheckingMethod
            (
            );
            public: void SetMinimumCheckingMethod
            (
                NXOpen::Routing::SplinePathBuilder::SplinePathAttributeOptions routeCheckingMethod 
            );
            public: double MinimumRadius
            (
            );
            public: NXOpen::Expression * MinimumCheckingAllowableValue
            (
            );
            public: NXOpen::Expression * MinimumCheckingAllowableRatio
            (
            );
            public: bool ShowSplineMinimumRadius
            (
            );
            public: void SetShowSplineMinimumRadius
            (
                bool allowDisplay 
            );
            public: void UpdateExtensionDirectionForPointAtIndex
            (
                int index ,
                const NXOpen::Vector3d & deltaTrans ,
                const NXOpen::Matrix3x3 & orientation ,
                bool inDrag 
            );
            public: void UpdateExtensionDirectionAtIndex
            (
                int index ,
                const NXOpen::Vector3d & direction 
            );
            public: void AssignTangentExtensionForPointAtIndex
            (
                int index ,
                NXOpen::Expression * forwardLength ,
                NXOpen::Expression * backwardLength ,
                NXOpen::Vector3d* tangent ,
                NXOpen::Vector3d* normal ,
                NXOpen::Direction ** extensionDir 
            );
            public: void AssignExtension
            (
                int pointIndex ,
                NXOpen::Direction * direction ,
                NXOpen::Expression * forwardLength ,
                NXOpen::Expression * backwardLength ,
                bool forceDeleteOnZeroExpression 
            );
            public: NXOpen::Expression * BoundedCurvatureRadius
            (
            );
            public: NXOpen::Expression * BoundedCurvatureRatio
            (
            );
            public: bool BoundedCurvature
            (
            );
            public: void SetBoundedCurvature
            (
                bool useBoundedCurvature 
            );
            public: NXOpen::Routing::SplinePathBuilder::DefiningTypes DefiningType
            (
            );
            public: void SetDefiningType
            (
                NXOpen::Routing::SplinePathBuilder::DefiningTypes definingType 
            );
            public: NXOpen::Routing::AssignTangencyBuilder * CreateAssignTangencyBuilder
            (
            );
            public: NXOpen::Routing::AssignTangencyBuilder * GetAssignTangencyBuilder
            (
            );
            public: NXOpen::Routing::SplinePathBuilder::SplinePathRadiusSource RadiusSource
            (
            );
            public: void SetRadiusSource
            (
                NXOpen::Routing::SplinePathBuilder::SplinePathRadiusSource source 
            );
            public: void SetStockBoundedDiameter
            (
                double value 
            );
            public: void SetDefaultPortExtensionLength
            (
                double value 
            );
        };
    }
}
#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