FxHLR.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 "DDKERNEL.h"
 
#include "IdArrays.h"
 
#include "DbEntity.h"
#include "DbViewport.h"
 
namespace FxHLR
{
 
    // Input flags for HLR engine
    enum Control
    {
        kProject = 0x0001,
        kShowAll = 0x0002,
        kEntity = 0x0004,
        kBlock = 0x0008,
        kSubentity = 0x0010,
        kHideTangents = 0x0020,
        kCleanup = 0x0040,
        kIsolines = 0x0080,
        kUnite = 0x0100,
        kReuse = 0x0200,
        kProgress = 0x0400,
        kHandlePoints = 0x0800,
        kProcessAll = 0x1000,
        kHonorInternals = 0x2000,
        kMeshSilhouettes = 0x4000,
        kSingleCacheVp = 0x8000
    };


    class DDKERNEL_API Data
    {
    public:
        enum Visibility
        {
            kVisible,
            kHidden,
            kOccluded,
            kInternallyHidden,
            kUndefined
        };
 
    protected:
        OdDbEntityPtr m_pEntity;
 
        OdDbObjectIdArray m_objectIds;
        OdDbSubentId m_subentId;
 
        Visibility m_visibility;
        Visibility m_hlrVisibility;
 
        OdDbEntityPtr m_pResultEntity;
 
    public:
        Data();
        virtual ~Data();
 
        void SetEntity( OdDbEntityPtr pEnt );
        void SetObjectIds( const OdDbObjectIdArray& id );
        void SetResultEntity( OdDbEntityPtr pResultEnt );
        void SetVisibility( Visibility visibility );
        void SetHlrVisibility( Visibility visibility );
        void SetSubentId( const OdDbSubentId& subentId );
 
        OdDbEntityPtr GetEntity() const;
        const OdDbObjectIdArray& GetObjectIds() const;
        OdDbEntityPtr GetResultEntity() const;
        Visibility GetVisibility() const;
        Visibility GetHlrVisibility() const;
        const OdDbSubentId& GetSubentId() const;
    };

    
    class Engine;

    class DDKERNEL_API Collector
    {
    protected:
        OdDbEntityPtrArray m_apEntities;
        OdDbObjectIdArray m_aEntityIds;
 
    public:
        OdArray<Data *> m_aOutputData;
 
    public:
        Collector();
        Collector( const OdDbObjectIdArray& ids );
        Collector( const OdDbEntityPtrArray& entities );
        Collector( Collector& collector );
 
        virtual ~Collector();
 
        const OdDbEntityPtrArray& GetInputEntities() const;
        const OdDbObjectIdArray& GetInputEntityIds() const;
 
        void AddEntity( OdDbEntityPtr pEnt );
        void AddEntities( const OdDbEntityPtrArray& pEnts );
        void AddEntity( const OdDbObjectId& id );
        void AddEntities( const OdDbObjectIdArray& ids );
 
        void RemoveEntity( OdDbEntityPtr pEnt );
        void RemoveEntities( const OdDbEntityPtrArray& pEnts );
        void RemoveEntity( const OdDbObjectId& id );
        void RemoveEntities( OdDbObjectIdArray& ids );
 
        void Clear();
 
    };

 
    typedef void( *_AbortCallbackFct ) ( bool *abort );
    typedef void( *_ProgressCallbackFct ) ( int percent_completed );

    class DDKERNEL_API Engine
    {
    protected:
        OdGePoint3d m_ptTarget;
        OdGeVector3d m_vViewDirection;
        int m_iControl;
        _AbortCallbackFct m_pAbortCallbackFct;
        _ProgressCallbackFct m_pAcisConvertionProgressCallbackFct;
        _ProgressCallbackFct m_pHlProgressCallbackFct;
        _ProgressCallbackFct m_pFxConvertionProgressCallbackFct;
 
    public:
        Engine( int iFlags = kShowAll | kEntity | kBlock | kSubentity | kReuse );
        Engine( const OdDbObjectId& id, int iFlags = kShowAll | kEntity | kBlock | kSubentity | kReuse );
        Engine( OdDbViewportPtr pViewport, int iFlags = kShowAll | kEntity | kBlock | kSubentity | kReuse );
        Engine( const OdGePoint3d& viewTarget, const OdGeVector3d& viewDirection, int iFlags = kShowAll | kEntity | kBlock | kSubentity | kReuse );
 
        virtual ~Engine();
 
        OdResult Run( Collector& collector );
 
        void SetAbortCallback( _AbortCallbackFct fct );
 
        void SetAcisConversionProgressCallBack( _ProgressCallbackFct fct );
        void SetHLProgressCallBack( _ProgressCallbackFct fct );
        void SetFxConversionProgressCallBack( _ProgressCallbackFct fct );
 
        static void CleanHlrCache();
        static void CleanHlrCache( OdDbEntityPtr pEnt, const OdDbObjectId& VpId = OdDbObjectId::kNull );
        static void CleanHlrCache( OdDbEntityPtr pEnt, OdGePoint3d viewTarget, OdGeVector3d viewDir );
 
    };
 
}