FxSelectionSet.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "FxPragmaPush.h"
 
#include "DDKERNEL.h"
 
#include <DbSSet.h>
#include <StaticRxObject.h>
#include <SharedPtr.h>
 
#include <Ge/GePoint3d.h>
#include <Ge/GeVector3d.h>
 
#include <vector>
 
class CFxDatabase;
class CFxView;
class CFxDocument;
class CFxSelectionData;
class CFxUserIO;
class CFxSelectionSetReactor;
class CFxEntityData;
class CFxSelectionSetFilter;
 
struct fdt_resbufW;

class DDKERNEL_API CFxSelectionSet :
    protected OdStaticRxObject< OdDbSelectionSet >
{
public:
    ODRX_HEAP_OPERATORS()
 
    /* {secret} */
    virtual ~CFxSelectionSet();

    virtual size_t GetNumber() const = 0;

    virtual CFxDatabase* GetFxDatabase() = 0;

    virtual size_t GetLength() const = 0;

    virtual size_t GetTotalSubents() const = 0;

    virtual const OdDbObjectId& GetId( size_t index ) const = 0;

    virtual size_t SubentGetLength( size_t index ) const = 0;

    virtual const OdDbFullSubentPath& SubentGetId( size_t index, size_t subentIndex ) const = 0;

    virtual void Clear() = 0;

    virtual bool IsMember( const OdDbObjectId& id ) const = 0;

    virtual bool IsMember( const OdDbFullSubentPath & path ) const = 0;
 
    typedef std::vector<const OdRxClass*> CLASS_VECTOR;
    typedef std::vector<size_t> SIZE_T_VECTOR;

    virtual void GetClassesFound( CLASS_VECTOR& classes, SIZE_T_VECTOR& objects ) const = 0;

    virtual const OdRxClass* GetCommonBaseClass() const = 0;

    virtual const OdRxClass* GetCommonBasePEClass() const = 0;

    virtual void GetObjectsByClass( const OdRxClass* pClass, OdDbObjectIdArray& objects ) const = 0;

    virtual int GetNTHX( int index, fdt_resbufW** data ) const = 0;

    virtual bool Add( const OdDbObjectId& objId ) = 0;

    virtual bool Remove( const OdDbObjectId& objId ) = 0;

    virtual bool SubentAdd( const OdDbFullSubentPath& path ) = 0;

    virtual bool SubentRemove( const OdDbFullSubentPath& path ) = 0;

    virtual void SetCustomFilter( const CFxSelectionSetFilter* pFilter ) = 0;

    virtual const CFxSelectionSetFilter* GetCustomFilter() = 0;

    virtual void AddObjectFilter( const OdRxClass* pClass ) = 0;

    virtual void ClearObjectFilters() = 0;

    struct DDKERNEL_API MergeResult
    {
        size_t m_Found;
        size_t m_Duplicated;
        size_t m_Removed;
        size_t m_Groups;
        size_t m_FoundNotInCurrentSpace;

        size_t m_RemovedOnLockedLayers;
        size_t m_RemovedOnOffLayers;
        size_t m_RemovedOnFrozenLayers;
        size_t m_RemovedNotInCurrentSpace;
        size_t m_RemovedNotInWorkingSet;
 
        size_t m_RemovedCloud;
        /* {secret}*/
        MergeResult();
    };

    enum
    {
        eRemoveNone = 0x0,
        eRemoveOnLockedLayers = 0x1,
        eRemoveOnOffLayers = 0x2,
        eRemoveOnFrozenLayers = 0x4,
        eRemoveNotInCurrentSpace = 0x8,
        eRemoveNotRectViewports = 0x10,
        eRemoveOverallViewports = 0x20,
        eRemoveNotInWorkingSet = 0x40,
        eRemoveCloud = 0x80, //flag added to not include Clouds in selection process.
                             // added to select entities inside block references in several dimension commands and interfere
                             eRemoveDefExceptNotInCurrentSpaceInvalid = eRemoveOnLockedLayers | eRemoveOverallViewports,
                             eRemoveDefaultInvalid = eRemoveOnLockedLayers | eRemoveNotInCurrentSpace | eRemoveOverallViewports | eRemoveNotInWorkingSet,
                             eRemoveDefaultInvalidButNonRectViewports = eRemoveOnLockedLayers | eRemoveNotInCurrentSpace | eRemoveOverallViewports | eRemoveNotInWorkingSet
    };
    typedef int RemoveFlags;

    struct DDKERNEL_API MergeOptions
    {
        RemoveFlags m_RemoveOptions;
        fdt_resbufW* m_pFilter;
        OdArray<OdRxClass*> m_Classes;
 
        MergeOptions();
    };

    virtual MergeResult Merge( const CFxSelectionSet* pSS, MergeOptions options ) = 0;

    virtual MergeResult Merge( const OdDbObjectIdArray& idsToMerge, MergeOptions options ) = 0;

    virtual void AddReactor( CFxSelectionSetReactor* pReactor ) = 0;

    virtual void RemoveReactor( CFxSelectionSetReactor* pReactor ) = 0;

    virtual bool IsHighlightEnabled() const = 0;

    virtual void SetHighlightEnabled( bool enable ) = 0;

    template <class TType, class TKey = TType>
    class CFxIterator
    {
    public:
        virtual ~CFxIterator() {};
        virtual void start() = 0;
        virtual void step() = 0;
        virtual bool done() const = 0;
        virtual const TType& object() const = 0;
        virtual bool seek( const TKey& object ) = 0;
    };

    virtual CFxIterator<CFxSelectionData>* CreateIterator() const = 0;
 
    virtual bool IsEmpty() const = 0;
 
public:
    static CFxSelectionSet* SelectByPoint( const OdGePoint3d& pointWCS, double pickboxEYE, CFxView* pView );

    static CFxSelectionSet* SelectByBox( const OdGePoint3d& firstPointWCS, const OdGePoint3d& secondPointWCS, CFxView* pView );

    static CFxSelectionSet* SelectByWindow( const OdGePoint3d& firstPointWCS, const OdGePoint3d& secondPointWCS, CFxView* pView );

    static CFxSelectionSet* SelectByCrossingWindow( const OdGePoint3d& firstPointWCS, const OdGePoint3d& secondPointWCS, CFxView* pView );

    static CFxSelectionSet* SelectByPolygon( const OdGePoint3dArray& pointsWCS, CFxView* pView );

    static CFxSelectionSet* SelectByCrossingPolygon( const OdGePoint3dArray& pointsWCS, CFxView* pView );

    static CFxSelectionSet* SelectByFence( const OdGePoint3dArray& pointsWCS, CFxView* pView );

    static CFxSelectionSet* SelectAll( CFxDocument* pDoc );

    static CFxSelectionSet* SelectLast( CFxDocument* pDoc );

    static CFxSelectionSet* SelectGroup( OdDbObjectId idGroup );

    static CFxSelectionSet* SelectPrevious( CFxDocument* pDoc );
 
public:
    /* {secret} */
    static CFxSelectionSet* SelectByView( CFxView* pView );
 
    /* {secret} */
    static CFxSelectionSet* SelectForHatch( CFxView* pView, const OdGePoint3d& pickPoint, OdGeExtents3d* extents );
};
 
typedef CFxSelectionSet::CFxIterator<CFxEntityData, OdDbObjectId> CFxSelectionDataIterator;

class DDKERNEL_API CFxSelectionData
{
public:
    /* {secret} */
    virtual ~CFxSelectionData();

    typedef enum
    {
        eNonGraphical           = 0,
        ePickPointSelection     = 1,
        eWindowOrWPolygon       = 2,
        eCrossingOrCPolygon     = 3,
        eFence                  = 4,
        eSubentity              = 5
    } SelectionMethod;
 
    typedef enum
    {
        kUnknown = 0,
        kWin,
        kCross,
        kBox,
        kLast,
        kEntity,
        kAll,
        kFence,
        kCPoly,
        kWPoly,
        kPick,
        kEvery,
        kXten,
        kGroup,
        kPrevious,
        kMultiple,
    } SelectionMode;

    virtual SelectionMethod GetMethod() const = 0;

    virtual fdt_resbufW* GetData() const = 0;

    virtual int GetWindowId() const = 0;

    struct DDKERNEL_API CFxVertexData
    {
        typedef enum
        {
            eInfiniteLine   = 0,
            eRay            = 1,
            eLineSegment    = 2
        } PointDescription;
 
        PointDescription m_Description;
        OdGePoint3d m_Point;
        OdGeVector3d m_Direction;
    };

    virtual size_t GetPointsCount() const = 0;

    virtual CFxVertexData* GetPoints() const = 0;

    virtual size_t GetNumEntities() const = 0;

    virtual bool IsNestedSelection() const = 0;

    virtual const OdDbObjectId& GetSpaceId() const = 0;

    virtual CFxSelectionDataIterator* CreateIterator() const = 0;
 
    virtual SelectionMode GetMode() const = 0;
};
 
typedef CFxSelectionSet::CFxIterator<OdDbFullSubentPath> CFxEntityDataIterator;

class DDKERNEL_API CFxEntityData
{
public:
    /* {secret} */
    virtual ~CFxEntityData();

    virtual const OdDbObjectId& GetId() const = 0;

    virtual const OdDbObjectId& GetLayerId() const = 0;

    virtual size_t GetDrawOrder() const = 0;

    virtual const OdRxClass* GetClass() const = 0;

    typedef enum
    {
        eUnset = 0x0,
        eNonAssociative = 0x1,
        eGroup = 0x2,
        eHatch = 0x4,
        eViewport = 0x8
    } Flags;

    virtual Flags GetFlags() const = 0;

    virtual int GetIndex() const = 0;

    virtual bool IsWholeEntitySelected() const = 0;

    virtual size_t SubentGetLength() const = 0;

    virtual bool ContainsSubent( const OdDbFullSubentPath & path ) const = 0;

    virtual bool SubentAdd( const OdDbFullSubentPath& subentPath ) = 0;

    virtual bool SubentRemove( const OdDbFullSubentPath& subentPath ) = 0;

    virtual CFxEntityDataIterator* CreateIterator() const = 0;
};
 
#include "FxPragmaPop.h"