Features_FaceRecognitionBuilder.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
// C++接口到JA API的头文件
//--------------------------------------------------------------------------
//
// 源文件:
//     Features_FaceRecognitionBuilder.ja
//
// 生成工具:
//     apiwrap
//
// 警告:
//    此文件由自动生成 - 请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/GeometricUtilities_OrientXpressBuilder.hxx>
#include <NXOpen/ModlConstraint.hxx>
#include <NXOpen/GeometricUtilities_IComponentBuilder.hxx>
#include <NXOpen/TaggedObject.hxx>
#include <NXOpen/ScCollector.hxx>
#include <NXOpen/SelectionIntentRule.hxx>
#include <NXOpen/libnxopencpp_features_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 Features
    {
        class FaceRecognitionBuilder;
    }
    namespace Annotations
    {
        class Dimension;
    }
    namespace Features
    {
        class Feature;
    }
    namespace GeometricUtilities
    {
        class IComponentBuilder;
    }
    namespace GeometricUtilities
    {
        class OrientXpressBuilder;
    }
    class NXObject;
    class ScCollector;
    class SelectionIntentRule;
    namespace Features
    {
        class _FaceRecognitionBuilderBuilder;
        class FaceRecognitionBuilderImpl;
        class NXOPENCPP_FEATURESEXPORT  FaceRecognitionBuilder : public NXOpen::TaggedObject, public virtual NXOpen::GeometricUtilities::IComponentBuilder
        {
            public: enum RelationFindScope
            {
                RelationFindScopeCoplanar  = 1,
                RelationFindScopeCoplanaraxes ,
                RelationFindScopeCoaxial  = 4,
                RelationFindScopeTangent  = 8,
                RelationFindScopeSymmetric  = 16,
                RelationFindScopeEqualdiameter  = 32,
                RelationFindScopeParallel  = 64,
                RelationFindScopePerpendicular  = 128,
                RelationFindScopeOffset  = 256,
                RelationFindScopeSameorbit  = 512,
                RelationFindScopeTangentatedge  = 1024,
                RelationFindScopeLiesonaxis  = 2048,
                RelationFindScopeRigidbodyface  = 4096
            };

            public: enum CloneFindScope
            {
                CloneFindScopeClone  = 1,
                CloneFindScopePattern ,
                CloneFindScopeSameentry  = 4,
                CloneFindScopeSameentrysurface  = 8,
                CloneFindScopeCoaxialclone  = 16,
                CloneFindScopeParallelclone  = 32,
                CloneFindScopeCoplanaraxesclone  = 64,
                CloneFindScopeExactmatch  = 128,
                CloneFindScopeLoosematch  = 256,
                CloneFindScopeHoleclone  = 512,
                CloneFindScopeChamferclone  = 1024
            };

            public: enum FindOrthoLockingMode
            {
                FindOrthoLockingModeOff  = 1,
                FindOrthoLockingModeLocalXyz ,
                FindOrthoLockingModePrinciplePlanes ,
                FindOrthoLockingModeLocalXyzRelationshipBased
            };

            public: enum RelationMethod
            {
                RelationMethodByFoundData  = 1,
                RelationMethodByFoundEcAndRelations
            };

            public:
            struct Relation
            {
                public:  NXOpen::NXObject * RelationTag;
                public:  NXOpen::ModlConstraint::RelationType RelationType;
                public: Relation() :
                    RelationTag(),
                    RelationType((NXOpen::ModlConstraint::RelationType)0)
{
                }
                public: Relation(NXOpen::NXObject * relationTagInitial  ,
                        NXOpen::ModlConstraint::RelationType relationTypeInitial  ) :
                    RelationTag(relationTagInitial),
                    RelationType(relationTypeInitial)
                {
                }
            };
            private: FaceRecognitionBuilderImpl * m_facerecognitionbuilder_impl;
            private: friend class  _FaceRecognitionBuilderBuilder;
            protected: FaceRecognitionBuilder();
            public: ~FaceRecognitionBuilder();
            public: NXOpen::ScCollector * FaceCollector
            (
            );
            public: NXOpen::ScCollector * VirtualFaceCollector
            (
            );
            public: bool CoplanarEnabled
            (
            );
            public: void SetCoplanarEnabled
            (
                bool coplanarEnabled 
            );
            public: bool CoplanarAxesEnabled
            (
            );
            public: void SetCoplanarAxesEnabled
            (
                bool coplanarEnabled 
            );
            public: bool CoaxialEnabled
            (
            );
            public: void SetCoaxialEnabled
            (
                bool coaxialEnabled 
            );
            public: bool SameOrbitEnabled
            (
            );
            public: void SetSameOrbitEnabled
            (
                bool sameOrbitEnabled 
            );
            public: bool RigidBodyFaceEnabled
            (
            );
            public: void SetRigidBodyFaceEnabled
            (
                bool rigidBodyFaceEnabled 
            );
            public: bool TangentEnabled
            (
            );
            public: void SetTangentEnabled
            (
                bool tangentEnabled 
            );
            public: bool EqualDiameterEnabled
            (
            );
            public: void SetEqualDiameterEnabled
            (
                bool equalDiameterEnabled 
            );
            public: bool SymmetricEnabled
            (
            );
            public: void SetSymmetricEnabled
            (
                bool symmetricEnabled 
            );
            public: bool OffsetEnabled
            (
            );
            public: void SetOffsetEnabled
            (
                bool offsetEnabled 
            );
            public: bool ThicknessChainEnabled
            (
            );
            public: void SetThicknessChainEnabled
            (
                bool thicknessChainEnabled 
            );
            public: bool ParallelEnabled
            (
            );
            public: void SetParallelEnabled
            (
                bool parallelEnabled 
            );
            public: bool PerpendicularEnabled
            (
            );
            public: void SetPerpendicularEnabled
            (
                bool perpendicularEnabled 
            );
            public: bool CloneEnabled
            (
            );
            public: void SetCloneEnabled
            (
                bool cloneEnabled 
            );
            public: bool PatternEnabled
            (
            );
            public: void SetPatternEnabled
            (
                bool patternEnabled 
            );
            public: bool SameEntryEnabled
            (
            );
            public: void SetSameEntryEnabled
            (
                bool sameEntryEnabled 
            );
            public: bool SameEntrySurfaceEnabled
            (
            );
            public: void SetSameEntrySurfaceEnabled
            (
                bool sameEntrySurfaceEnabled 
            );
            public: bool HoleCloneEnabled
            (
            );
            public: void SetHoleCloneEnabled
            (
                bool holeCloneEnabled 
            );
            public: bool ChamferCloneEnabled
            (
            );
            public: void SetChamferCloneEnabled
            (
                bool chamferCloneEnabled 
            );
            public: void SelectEntities
            (
                const std::vector<NXOpen::NXObject *> & entities 
            );
            public: void DeselectEntities
            (
                const std::vector<NXOpen::NXObject *> & entities 
            );
            public: void RecognizeCoplanar
            (
                bool isNear 
            );
            public: void UnrecognizeCoplanar
            (
                bool isNear 
            );
            public: void RecognizeCoplanarAxes
            (
                bool isNear 
            );
            public: void UnrecognizeCoplanarAxes
            (
                bool isNear 
            );
            public: void RecognizeCoaxial
            (
                bool isNear 
            );
            public: void UnrecognizeCoaxial
            (
                bool isNear 
            );
            public: void RecognizeSameOrbit
            (
                bool isNear 
            );
            public: void UnrecognizeSameOrbit
            (
                bool isNear 
            );
            public: void RecognizeRigidBodyFace
            (
                bool isNear 
            );
            public: void UnrecognizeRigidBodyFace
            (
                bool isNear 
            );
            public: void RecognizeTangent
            (
                bool isNear 
            );
            public: void UnrecognizeTangent
            (
                bool isNear 
            );
            public: void RecognizeSymmetric
            (
                bool isNear 
            );
            public: void UnrecognizeSymmetric
            (
                bool isNear 
            );
            public: void RecognizeThicknessChain
            (
                bool isNear 
            );
            public: void UnrecognizeThicknessChain
            (
                bool isNear 
            );
            public: void RecognizeEqualDiameter
            (
                bool isNear 
            );
            public: void UnrecognizeEqualDiameter
            (
                bool isNear 
            );
            public: void RecognizeParallel
            (
                bool isNear 
            );
            public: void UnrecognizeParallel
            (
                bool isNear 
            );
            public: void RecognizePerpendicular
            (
                bool isNear 
            );
            public: void UnrecognizePerpendicular
            (
                bool isNear 
            );
            public: void RecognizeOffset
            (
                bool isNear 
            );
            public: void UnrecognizeOffset
            (
                bool isNear 
            );
            public: void RecognizePattern
            (
                int cloneId 
            );
            public: void UnrecognizePattern
            (
                int cloneId 
            );
            public: void RecognizeCommonFace
            (
            );
            public: void UnrecognizeCommonFace
            (
            );
            public: void RecognizeCommonSurface
            (
            );
            public: void UnrecognizeCommonSurface
            (
            );
            public: void RecognizeCommonFaceById
            (
                int cloneId 
            );
            public: void UnrecognizeCommonFaceById
            (
                int cloneId 
            );
            public: void RecognizeCommonSurfaceById
            (
                int cloneId 
            );
            public: void UnrecognizeCommonSurfaceById
            (
                int cloneId 
            );
            public: void RecognizeCoaxialClone
            (
            );
            public: void UnrecognizeCoaxialClone
            (
            );
            public: void RecognizeParallelClone
            (
            );
            public: void UnrecognizeParallelClone
            (
            );
            public: void RecognizeCoplanarAxesClone
            (
            );
            public: void UnrecognizeCoplanarAxesClone
            (
            );
            public: void RecognizeExactMatch
            (
            );
            public: void UnrecognizeExactMatch
            (
            );
            public: void RecognizeLooseMatch
            (
            );
            public: void UnrecognizeLooseMatch
            (
            );
            public: void RecognizeHoleClones
            (
            );
            public: void UnrecognizeHoleClones
            (
            );
            public: void RecognizeChamferClone
            (
            );
            public: void UnrecognizeChamferClone
            (
            );
            public: bool UseFaceBrowse
            (
            );
            public: void SetUseFaceBrowse
            (
                bool useFaceBrowse 
            );
            public: NXOpen::GeometricUtilities::OrientXpressBuilder * ReferenceCoordinateSystem
            (
            );
            public: void LockConstraint
            (
                NXOpen::Features::Feature * feature 
            );
            public: void UnlockConstraint
            (
                NXOpen::Features::Feature * feature 
            );
            public: void DeleteConstraint
            (
                NXOpen::Features::Feature * feature 
            );
            public: void DeleteOffsetRelation
            (
                const std::vector<NXOpen::NXObject *> & offsetFaces 
            );
            public: void ReplaceRules
            (
                const std::vector<NXOpen::SelectionIntentRule *> & rules ,
                bool createRulesWoUpdate 
            );
            public: int RelationScope
            (
            );
            public: void SetRelationScope
            (
                int relationScope 
            );
            public: int CloneScope
            (
            );
            public: void SetCloneScope
            (
                int cloneScope 
            );
            public: double FindMinOffsetRatio
            (
            );
            public: void SetFindMinOffsetRatio
            (
                double findMinOffsetRatio 
            );
            public: bool FindChamfers
            (
            );
            public: void SetFindChamfers
            (
                bool isFindChamfers 
            );
            public: NXOpen::Features::FaceRecognitionBuilder::FindOrthoLockingMode OrthoLockingMode
            (
            );
            public: void SetOrthoLockingMode
            (
                NXOpen::Features::FaceRecognitionBuilder::FindOrthoLockingMode orthoLockingMode 
            );
            public: void SetFindScope
            (
                bool findInWorkPart ,
                const std::vector<NXOpen::NXObject *> & bodies 
            );
            public: NXOpen::Features::FaceRecognitionBuilder::RelationMethod RelationFoundMethod
            (
            );
            public: void SetRelationFoundMethod
            (
                NXOpen::Features::FaceRecognitionBuilder::RelationMethod relationFoundMethod 
            );
            public: NX_DEPRECATED("Deprecated in NX1926.0.0.  Use Features::FaceRecognitionBuilder::GetLiveRelations instead.") void GetVtkFoundRelation
            (
                int relationQueryScope  ,
                std::vector<NXOpen::Features::FaceRecognitionBuilder::Relation> & relations 
            );
            public: void SetEqualRadiusFacesMoveTogether
            (
                bool isEqualRadiusFacesMoveTogether 
            );
            public: void GetLiveRelations
            (
                int relationQueryScope  ,
                std::vector<NXOpen::Features::FaceRecognitionBuilder::Relation> & relations 
            );
            public: bool UseFindClone
            (
            );
            public: void SetUseFindClone
            (
                bool useFindClone 
            );
            public: bool UseFindRelated
            (
            );
            public: void SetUseFindRelated
            (
                bool useFindRelated 
            );
            public: NX_DEPRECATED("Deprecated in NX2406.0.0.  None.") bool FindGeneralClone
            (
            );
            public: NX_DEPRECATED("Deprecated in NX2406.0.0.  None.") void SetFindGeneralClone
            (
                bool findGenralClone 
            );
            public: void RemoveFoundFaces
            (
                const std::vector<NXOpen::NXObject *> & entities 
            );
            public: void SetVtkFindRelationCrossBody
            (
                bool isEnable 
            );
            public: bool GetVtkFindRelationCrossBody
            (
            );
            public: void AddLockDim
            (
                const std::vector<NXOpen::Annotations::Dimension *> & dimensions 
            );
            public: void UnlockDim
            (
                const std::vector<NXOpen::Annotations::Dimension *> & dimensions 
            );
            public: bool ExcludeBlendFaces
            (
            );
            public: void SetExcludeBlendFaces
            (
                bool isExcludeBlendFaces 
            );
            public: virtual bool Validate
            (
            );
        };
    }
}
#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