GsEntityNode.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef __OD_GS_ENTITY_NODE__
#define __OD_GS_ENTITY_NODE__
 
#include "Gs/GsNode.h"
#include "Si/SiSpatialIndex.h"
#include "OdArrayMemAlloc.h"
#include "Gs/GsHighlightData.h"
#include "Gs/GsUpdateManager.h"
 
class OdGsBaseVectorizer;
class OdGsBaseVectorizeDevice;
 
#include "TD_PackPush.h"

struct OdGsGeomPortion
{
  OdGsLayerNode*    m_pLayer;
  OdRxObjectPtr     m_pGsMetafile;
  OdGsGeomPortion*  m_pNext;

  OdGsGeomPortion()
    : m_pLayer(0)
    , m_pGsMetafile(0)
    , m_pNext(0)
  {
  }

  void copyFrom(OdGsGeomPortion& c)
  {
    m_pLayer = c.m_pLayer;
    m_pGsMetafile = c.m_pGsMetafile;
    m_pNext = c.m_pNext;
  }

  void clear()
  {
    m_pLayer = NULL;
    m_pGsMetafile = NULL;
    m_pNext = NULL;
  }

  void freeNestedPortions()
  {
    OdGsGeomPortion* pPortion = m_pNext;
    while (pPortion)
    {
      OdGsGeomPortion* pNextPortion = pPortion->m_pNext;
      delete pPortion;
      pPortion = pNextPortion;
    }
  }

  bool isEmptyPortion() const { return (m_pLayer == NULL) && m_pGsMetafile.isNull(); }
  
  void filterEmptyNestedPortions()
  {
    while (m_pNext && m_pNext->isEmptyPortion())
    {
      OdGsGeomPortion* pNextPortion = m_pNext->m_pNext;
      delete m_pNext;
      m_pNext = pNextPortion;
    }
    if (m_pNext)
      m_pNext->filterEmptyNestedPortions();
  }
};
 
class OdGsBaseVectorizeDevice;
class OdGsBaseContext;

class GS_TOOLKIT_EXPORT OdGsEntityNode : public OdGsNode, public OdSiEntity
{
  //DOM-IGNORE-BEGIN
  
  OdGsEntityNode*             m_pNextEntity;

  struct NextEntityEntry
  {
    OdGsEntityNode*           m_pNextEntity;
    OdUInt32                  m_entFlags;
  };
  void allocNextEntityArray(OdUInt32 nMaxVpId);
  
  inline NextEntityEntry *firstEntEntry() { return reinterpret_cast<NextEntityEntry*>(m_pNextEntity); }
  
  inline const NextEntityEntry *firstEntEntry() const { return reinterpret_cast<const NextEntityEntry*>(m_pNextEntity); }
  inline void checkEntEntry(OdUInt32 nVpId) const { if ((OdUInt32)OdPtrToInt32(firstEntEntry()->m_pNextEntity) <= nVpId) throw OdError(eInvalidIndex); }
  
  inline NextEntityEntry *nextEntEntry(OdUInt32 nVpId) { checkEntEntry(nVpId); return reinterpret_cast<NextEntityEntry*>(m_pNextEntity) + (nVpId + 1); }
  
  inline const NextEntityEntry *nextEntEntry(OdUInt32 nVpId) const { checkEntEntry(nVpId); return reinterpret_cast<const NextEntityEntry*>(m_pNextEntity) + (nVpId + 1); }
  
  //DOM-IGNORE-END
protected:
  mutable OdGeExtents3d       m_extents;
 
public:
  class GS_TOOLKIT_EXPORT Metafile : public OdRxObject
  {
  public:
    void* operator new(size_t);
    void operator delete(void *);

    Metafile();
    
    ~Metafile();

    bool play(OdGsBaseVectorizer& view, EMetafilePlayMode eMode, OdGsEntityNode& node, OdGsBaseContext* ctx = NULL);
    
    bool playNested(const OdGsView& view, OdGsEntityNode& node, OdGsBaseContext& ctx);
    
    bool hasDataToPlay(const OdGsView& view, EMetafilePlayMode eMode = kMfDisplay) const;
    
    bool layersChanged(OdUInt32 nVpId) const;
    
    bool containsVpFrozenLayers() const;
    
    bool containsFrozenLayers() const;
    
    bool containsAnyOfLayers( OdDbStub*const* layers, OdUInt32 count ) const;

    bool isEmpty() const;
    
    bool isAllLayersOff( OdUInt32 viewportId ) const;

    OdUInt32            m_nAwareFlags;
    OdGeExtents3d       m_extents;
    OdGsGeomPortion     m_first;
  };
  friend class Metafile;

  typedef OdSmartPtr<Metafile> MetafilePtr;
  //DOM-IGNORE-BEGIN
  class GS_TOOLKIT_EXPORT MetafileEx : public Metafile, public OdGsUpdateManager::OdGsUpdateManagerElement
  {
  protected:
    OdRxObjectPtr m_pDeviceRef;
    OdUInt64 m_nLength;
  public:
    class GS_TOOLKIT_EXPORT OdGsDeviceSelfReference : public OdRxObject
    {
      OdGsBaseVectorizeDevice* m_pDevice;
    public:
      OdGsDeviceSelfReference()
      {
        m_pDevice = NULL;
      };
      void setDevice( OdGsBaseVectorizeDevice* device ) 
      {
        m_pDevice = device;
      }
      OdGsBaseVectorizeDevice* device() { return m_pDevice; }
    };
 
    MetafileEx() : Metafile(), OdGsUpdateManager::OdGsUpdateManagerElement()
    {
      m_pDeviceRef = NULL;
    }
    ~MetafileEx();
    void setDevice( OdRxObjectPtr dev ) { m_pDeviceRef = dev; }
    OdRxObjectPtr device() { return m_pDeviceRef; }
 
    void setMetafileLength( OdUInt64 l ) { m_nLength = l; }
    OdUInt64 metafileLength() const { return m_nLength; }
  };
  //DOM-IGNORE-END
  friend class OdGsModuleObject;
  friend class OdGsBlockReferenceNode;
public:
  static void* Alloc(size_t nBytes) { return OdGsNode::s_aAlloc.getAt(1)->alloc((int)nBytes); }
  static void Free(void* pMemBlock) { OdGsNode::s_aAlloc.getAt(1)->release(pMemBlock); }
  static void* Realloc(void* pMemBlock, size_t newSize, size_t)
  {
    if(pMemBlock)
      OdGsNode::s_aAlloc.getAt(1)->release(pMemBlock);
    return OdGsNode::s_aAlloc.getAt(1)->alloc((int)newSize);
  }

  class MetafilePtrArray: public OdArrayMemAlloc<MetafilePtr, OdObjectsAllocator<MetafilePtr>, OdGsEntityNode>
  {
  public:
    ~MetafilePtrArray(){}
  };

  class GS_TOOLKIT_EXPORT MetafileHolder
  {
  public:
    //DOM-IGNORE-BEGIN
    
    enum 
    {
      kArray = 1,
      kVpDependent = 2,
      kAwareFlagsRegenType = 4,
 
      kRegenTypeStandard = 8,
      kRegenTypeHideOrShade = 16,
      kRegenTypeRenderCommand = 32,
      kRegenTypeMask = kRegenTypeStandard | kRegenTypeHideOrShade | kRegenTypeRenderCommand,
 
      kDependentGeometry = 64, // Marks PaperSpace entities
      kLayerDependent = 128 // Marks compound entities w/o blocks cache (#15036)
    };
    
    //DOM-IGNORE-END
    
    MetafileHolder(): m_flags(0)
    {
      *reinterpret_cast<Metafile**>(rawPtr()) = 0;
    }
    
    MetafileHolder(const MetafileHolder& c): m_flags(0)
    {
      *reinterpret_cast<Metafile**>(rawPtr()) = 0;
      if(!c.isValid())
        return;
      if(c.isArray())
      {
        allocateArray();
        getArray() = const_cast<MetafileHolder&>(c).getArray();
      }
      else
      {
        *reinterpret_cast<Metafile**>(rawPtr()) = const_cast<MetafileHolder&>(c).get();
        get()->addRef();
      }
      m_flags = c.m_flags;
    }
    
    ~MetafileHolder()
    {
      destroy();
    }
    
    bool isValid() const { return *((const Metafile**)rawPtr()) != NULL; }
    
    bool isArray() const { return GETBIT(flags(), kArray); }
    
    bool isVpDependent() const { return GETBIT(flags(), kVpDependent); }
    
    void setVpDependent(bool bOn)
    {
      SETBIT(m_flags, kVpDependent, bOn);
      if(bOn)
      {
        SETBIT(m_flags, kRegenTypeMask, false);
        setAwareFlagsRegenType(false);
      }
    }
 
    bool isAwareFlagsRegenType() const { return GETBIT(flags(), kAwareFlagsRegenType); }
    bool isRegenTypeDependent() const { return GETBIT(flags(), kRegenTypeMask); }
 
    void setDependentGeometry(bool bSet) { SETBIT(m_flags, kDependentGeometry, bSet); }
    bool isDependentGeometry() const { return GETBIT(flags(), kDependentGeometry); }
 
    void setLayerDependent(bool bSet) { SETBIT(m_flags, kLayerDependent, bSet); }
    bool isLayerDependent() const { return GETBIT(m_flags, kLayerDependent); }

    Metafile* get()
    {
        ODA_ASSERT(!isArray());
        return *reinterpret_cast<Metafile**>(rawPtr());
    }
    
    const Metafile* get() const
    {
        ODA_ASSERT(!isArray());
        return *reinterpret_cast<Metafile**>(const_cast<MetafileHolder*>(this)->rawPtr());
    }
    
    MetafilePtrArray& getArray()
    {
        ODA_ASSERT(isArray());
        return *reinterpret_cast<MetafilePtrArray*>(rawPtr());
    }
    
    const MetafilePtrArray& getArray() const
    {
        ODA_ASSERT(isArray());
        return *reinterpret_cast<const MetafilePtrArray*>(rawPtr());
    }
    
    void set(Metafile* pMf)
    {
      destroy();
      *reinterpret_cast<Metafile**>(rawPtr()) = pMf;
      if(pMf)
        pMf->addRef();
    }

    void setAtRegenType(Metafile* pMf, OdGiRegenType eRegenType);
    
    Metafile* getAtRegenType(OdGiRegenType& eRegenType)
    {
      ODA_ASSERT(isRegenTypeDependent());
      ODA_ASSERT(!isArray());
      if(GETBIT(flags(), kRegenTypeStandard))
        eRegenType = kOdGiStandardDisplay;
      else if(GETBIT(flags(), kRegenTypeHideOrShade))
        eRegenType = kOdGiHideOrShadeCommand;
      else
        eRegenType = kOdGiRenderCommand;
      return get();
    }

    void allocateArray();

    void destroy();
    
    int checkValid();

    void moveTo(MetafileHolder& c, int& n);
    OdUInt32 awareFlags(OdUInt32 nVpID) const
    {
      if(isArray())
      {
        if (isVpDependent() && (getArray().size() > nVpID))
        { const MetafilePtr &pMetafile = getArray().at(nVpID);
          return (!pMetafile.isNull()) ? pMetafile->m_nAwareFlags : 0;
        }
        return kVpRenderMode | (isAwareFlagsRegenType() ? kVpRegenType : 0);
      }
      return isValid() ? get()->m_nAwareFlags : 0;
    }

    void setAt(int n, Metafile* pMf)
    {
      ODA_ASSERT(isArray());
      if(getArray().size() <= OdUInt32(n))
        getArray().resize(n + 1);
      getArray()[n] = pMf;
    }
 
  protected:
    int flags() const { return (int)m_flags; }
    void* rawPtr() { return &m_data; }
    const void* rawPtr() const { return &m_data; }
    bool isValidMf(const Metafile& mf) const;
    void setAwareFlagsRegenType(bool bOn) { SETBIT(m_flags, kAwareFlagsRegenType, bOn); }
 
  protected:
    OdUInt8 m_flags;
#ifndef SWIG
#ifdef TD_STRICT_ALIGNMENT
#if defined(_MSC_VER) && (_MSC_VER < 1900)
    OdIntPtr m_data[((sizeof(MetafilePtrArray) > sizeof(OdRxObject*)) sizeof(MetafilePtrArray) ? sizeof(OdRxObject*):) / sizeof(OdIntPtr)];
#else
    OdIntPtr m_data[odmax(sizeof(MetafilePtrArray),sizeof(OdRxObject*)) / sizeof(OdIntPtr)];
#endif
#else
#if defined(_MSC_VER) && (_MSC_VER < 1900)
    OdUInt8 m_data[((sizeof(MetafilePtrArray) > sizeof(OdRxObject*)) ? sizeof(MetafilePtrArray) : sizeof(OdRxObject*))];
#else
    OdUInt8 m_data[odmax(sizeof(MetafilePtrArray),sizeof(OdRxObject*))];
#endif
#endif
#endif
  };
 
protected:
  OdGsStateBranchPtr m_stateBranch;
 
  virtual void propagateLayerChanges(OdGsViewImpl& view);
protected:
  MetafilePtrArray& metafileArray();
 
  mutable MetafileHolder m_metafile;
  const MetafilePtrArray& metafileArray() const;

  OdGsEntityNode::MetafilePtr metafile() const;
 
  void setExtentsFromMetafiles();
public:
  static OdGsEntityNode::MetafilePtr getEmptyMetafile(OdUInt32 flags, OdGsLayerNode *pLayerNode = NULL);

  OdGsEntityNode::MetafilePtr metafileAt(int metafileIndex) const;
  
  void setMetafile(OdGsEntityNode::Metafile* metafiles);
  
  void setMetafileAt(int metafileIndex, OdGsEntityNode::Metafile* pMetafile);

  void convertToViewportDependent(const OdGsUpdateContext& ctx);

  enum MetafileCompatibilityLevel
  {
    kSkipCheckCompatible = 0,
    kCheckViewChanges    = 1,
    kCheckCompatibleView = 2,
    kFindCompatible      = 3
  };

  OdGsEntityNode::Metafile* metafile(const OdGsViewImpl& view, OdGsUpdateContext* ctx,
                                     MetafileCompatibilityLevel findCompatibleLevel = kFindCompatible);
  void setMetafile(OdGsUpdateContext& ctx, OdGsEntityNode::Metafile* metafiles);
  
  OdRxObject* findCompatibleCache(const OdGsViewImpl& keyView, OdGsUpdateContext* ctx, OdUInt32 awareMask = 0);

  OdRxObject *findFirstGsMetafile(const OdGsViewImpl &view, bool *bContainsNested = nullptr,
                                  MetafileCompatibilityLevel findCompatibleLevel = kSkipCheckCompatible);
protected:
  // m_flags (don't add new flags here, we already utilized ~30 bits)
  enum
  {
    kHasExtents         = OdGsNode::kLastFlag << 1,
    kSpatiallyIndexed   = OdGsNode::kLastFlag << 2,
    kInWorkset          = OdGsNode::kLastFlag << 3,
    kSingleThreaded     = OdGsNode::kLastFlag << 4,
    kOwned              = OdGsNode::kLastFlag << 5,
    kDrawableRegenDraw  = OdGsNode::kLastFlag << 6,
    kEntityUnerased     = OdGsNode::kLastFlag << 7,
    kInvisible          = OdGsNode::kLastFlag << 8,
    kExtentsOutOfMS     = OdGsNode::kLastFlag << 9,
    kNonSelectable      = OdGsNode::kLastFlag << 10,
    kSkipSelection      = OdGsNode::kLastFlag << 11,
    kErased             = OdGsNode::kLastFlag << 12,
    kDrawableIsXref     = OdGsNode::kLastFlag << 13,
    kMultilistNextPtr   = OdGsNode::kLastFlag << 14,
    kLastFlag           = kMultilistNextPtr
  };
  // m_entFlags (add all new flags related to EntityNode here, keep some free space inside m_flags for inherited classes)
  enum
  {
    kLineweightBit1     = (1 << 0), // reserve 8 bits for maximal lineweight
    kLineweightBit2     = (1 << 1), kLineweightOffset = 0,
    kLineweightBit3     = (1 << 2),
    kLineweightBit4     = (1 << 3),
    kLineweightBit5     = (1 << 4),
    kLineweightBit6     = (1 << 5),
    kLineweightBit7     = (1 << 6),
    kLineweightBit8     = (1 << 7),
    kLineweightBitMask  = kLineweightBit1 | kLineweightBit2 | kLineweightBit3 | kLineweightBit4 | kLineweightBit5 | kLineweightBit6 | kLineweightBit7 | kLineweightBit8,
    kLightSourceOwner   = (1 << 8), // owning at least one light source
    kRegenOnHighlight   = (1 << 9), // cache require regeneration during highlighting state change
    kMarkedByUpdateManager = (1 << 10),
    kSkipDisplayClipping = (1 << 11),
    kLastEntFlag        = kSkipDisplayClipping
  };
  // m_markToSkipFlags
  enum
  {
    kMarkedToSkipFirst  = 0x00000001,
    kMarkedToSkipLast   = kMarkedToSkipFirst << 30,
    kMarkedToSkipAll    = 0x7FFFFFFF
  };
 
public:
  ODRX_DECLARE_MEMBERS(OdGsEntityNode);

  OdGsEntityNode(OdGsBaseModel* pModel, const OdGiDrawable* pUnderlyingDrawable, bool bSetGsNode = false);
public:
  ~OdGsEntityNode();

  void setNextEntity(OdGsEntityNode* pNextEntity);
  
  void setNextEntity(OdUInt32 nVpId, OdGsEntityNode* pNextEntity);
  OdGsEntityNode* nextEntity();
  
  OdGsEntityNode* nextEntity(OdUInt32 nVpId);
  const OdGsEntityNode* nextEntity() const;
  
  const OdGsEntityNode* nextEntity(OdUInt32 nVpId) const;
  OdUInt32 numNextEntity() const;
  void enableMultipleNextEntities(OdUInt32 nMaxVpId);

  void update(OdGsUpdateContext& ctx, OdGsContainerNode* pParent,
      OdSiSpatialIndex* pParentIndex);

  void updateVisible( OdGsViewImpl* pViewImpl );
  
  virtual OdGsEntityNode::MetafilePtr regenMetafile(OdGsUpdateContext &ctx, OdUInt32 vpDepFlags);

  virtual OdUInt32 awareFlags(OdUInt32 viewportId) const;

  virtual ENodeType nodeType() const { return kEntityNode; }
  
  virtual bool isReference() const { return false; }
  virtual bool isLight() const { return false; }
  virtual bool isSelfReferential() const { return false; }

  void display(OdGsDisplayContext& ctx);
 
  void select(OdGsBaseVectorizer& view);

  void invalidate(OdGsContainerNode* pParent, OdGsViewImpl* pView, OdUInt32 mask);

  bool extents(OdGeExtents3d& extents) const;

  bool spatiallyIndexed() const;
  
  bool spatiallyIndexed(OdUInt32 nVpId) const;
  
  void setSpatiallyIndexed(bool spatiallyIndexed);
  
  void setSpatiallyIndexed(OdUInt32 nVpId, bool spatiallyIndexed);

  bool owned() const;
  
  bool owned(OdUInt32 nVpId) const;
  
  void setOwned(bool owned);
  
  void setOwned(OdUInt32 nVpId, bool owned);

  bool markedByUpdateManager() const;

  void setMarkedByUpdateManager( bool marked );

  bool hasExtents() const;

  const OdGeExtents3d& extents() const;

  virtual bool isEmpty();

  virtual bool hasFrozenLayers();

  inline bool markedToSkip(unsigned mask);

  inline void markToSkip(unsigned mask, bool markToSkip);

  inline void markToSkipAll();

  static unsigned markToSkipMask(OdUInt32 threadIndex)
  {
    ODA_ASSERT(threadIndex >= 0 && threadIndex < 31);
    return kMarkedToSkipFirst << threadIndex;
  }

  void destroy(){}

  virtual bool layersChanged(OdGsViewImpl& view) const;

  bool markedAsNonSelectable() const;
  
  void markAsNonSelectable(bool val);
  bool isMarkedSkipSelection() const;
  void markSkipSelection(bool val);
  
  bool isMarkedErased() const;
  
  void markErased(bool val);
 
  bool isInWorkset() const;
  void setInWorkset(bool val);

  bool isRegenOnDraw() const;
  
  void setRegenOnDraw(bool val);

  bool isSingleThreaded() const;
  
  void setSingleThreaded(bool val);

  bool skipDisplayClipping() const;
  
  void setSkipDisplayClipping(bool bOn);

  bool isXref() const;

  virtual void highlight(bool bDoIt, bool bWholeBranch, OdUInt32 nSelStyle = 0);

  void hide(bool bDoIt, bool bSelectable = false, bool bWholeBranch = true);

  void setStateBranch(OdGsStateBranch *pBr);
  void resetStateBranch(OdGsStateBranch::BranchType branchType = OdGsStateBranch::kHighlightingBranch);
  OdGsStateBranch *stateBranch(OdGsStateBranch::BranchType branchType = OdGsStateBranch::kHighlightingBranch);
  const OdGsStateBranch *stateBranch(OdGsStateBranch::BranchType branchType = OdGsStateBranch::kHighlightingBranch) const;
  bool hasAnyStateBranch() const;

  virtual void playAsGeometry(OdGsBaseVectorizer& view, EMetafilePlayMode eMode);

  bool extents(const OdGsView* pView, OdGeExtents3d& ext) const;
  
  OdDb::LineWeight getMaxLineweightUsed() const;
  
  void addMaxLineweightUsed(OdDb::LineWeight lwd);
  
  void setMaxLineweightUsed(OdDb::LineWeight lwd);

  bool entityUnerased() const;
  
  void setEntityUnerased(bool flag);

  bool isInvisible() const;

  bool isExtentsOutOfModelSpace() const;
  void setExtentsOutOfModelSpace(bool flag);

  void resetInvalidVpFlag();

  void setAsLightSourceOwner(bool bSet);
  
  bool isLightSourceOwner() const;

  bool isRequireRegenOnHighlightChange() const;
 
public:
  virtual void makeStock();
  virtual void releaseStock();
  virtual void propagateLayerChangesStock();

  bool saveNodeState(OdGsFiler *pFiler, OdGsBaseVectorizer *pVectorizer = NULL) const;
  
  bool loadNodeState(OdGsFiler *pFiler, OdGsBaseVectorizer *pVectorizer = NULL);

  void transformExtents(OdGeExtents3d &ext, const OdGsStateBranch *pTransformBr = NULL, bool bInverse = false) const;
 
  class TransformedExtents
  {
    protected:
      OdGeExtents3d m_extents;
    public:
      TransformedExtents(const OdGsEntityNode *pNode)
        : m_extents(pNode->extents())
      { pNode->transformExtents(m_extents); }
      operator const OdGeExtents3d &() const { return m_extents; }
  };
 
  void insertToSpatialIndex(OdUInt32 nVpId, OdSiSpatialIndex &parentIndex, const OdGeExtents3d &prevExtents);
protected:
  bool findMetafileInStock(OdGsUpdateContext& ctx);
  inline void setExtentsFlags();
private:
  MetafileHolder m_mfStock;
  volatile int m_markToSkipFlags;
protected:
  // This flags willn't increase memory usage (at least on Win32) since utilize free space in 8 bytes alignment (__alignof(entity_node) == 8).
  OdUInt32 m_entFlags;
public:
  void addContentToUpdateManager( OdUInt32 viewportId, OdGsUpdateManager* pManager, const UpdateManagerContext& context );
  
  bool isMetafilesCompatible( const OdGsViewImpl* pView1, const OdGsViewImpl* pView2, OdGsUpdateContext* ctx );
};

typedef OdSmartPtr<OdGsEntityNode> OdGsEntityNodePtr;
 
 
inline void OdGsEntityNode::setNextEntity(OdGsEntityNode* pNextEntity)
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    throw OdError(eInvalidIndex);
  m_pNextEntity = pNextEntity;
}
 
inline void OdGsEntityNode::setNextEntity(OdUInt32 nVpId, OdGsEntityNode* pNextEntity)
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    nextEntEntry(nVpId)->m_pNextEntity = pNextEntity;
  else
    m_pNextEntity = pNextEntity;
}
 
inline void OdGsEntityNode::enableMultipleNextEntities(OdUInt32 nMaxVpId)
{
  if (nMaxVpId == 0xFFFFFFFF) nMaxVpId = 0;
  if ((numNextEntity() <= nMaxVpId) || ((nMaxVpId == 0) && GETBIT(m_flags, kMultilistNextPtr)))
    allocNextEntityArray(nMaxVpId);
}
 
inline OdGsEntityNode* OdGsEntityNode::nextEntity()
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    throw OdError(eInvalidIndex);
  return m_pNextEntity;
}
 
inline OdGsEntityNode* OdGsEntityNode::nextEntity(OdUInt32 nVpId)
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    return nextEntEntry(nVpId)->m_pNextEntity;
  //if (nVpId > 0) // Normal case, since we can request from non-VpDep container
  //  throw OdError(eInvalidIndex);
  return m_pNextEntity;
}
 
inline const OdGsEntityNode* OdGsEntityNode::nextEntity() const
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    throw OdError(eInvalidIndex);
  return m_pNextEntity;
}
 
inline const OdGsEntityNode* OdGsEntityNode::nextEntity(OdUInt32 nVpId) const
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    return nextEntEntry(nVpId)->m_pNextEntity;
  //if (nVpId > 0) // Normal case, since we can request from non-VpDep container
  //  throw OdError(eInvalidIndex);
  return m_pNextEntity;
}
 
inline OdUInt32 OdGsEntityNode::numNextEntity() const
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    return (OdUInt32)OdPtrToInt32(firstEntEntry()->m_pNextEntity);
  return 1;
}
 
inline bool OdGsEntityNode::hasExtents() const
{
  return GETBIT(m_flags, kHasExtents);
}
 
inline const OdGeExtents3d& OdGsEntityNode::extents() const
{
  return m_extents;
}
 
inline bool OdGsEntityNode::markedToSkip(unsigned mask)
{
  ODA_ASSERT((mask >= kMarkedToSkipFirst) && (mask <= kMarkedToSkipLast));
  //atomic function is required, called in MT mode (display)
#ifndef TD_SINGLE_THREAD
  return (mask & OdInterlockedExchangeAdd(&m_markToSkipFlags, 0)) != 0;
#else
  return GETBIT(m_markToSkipFlags, mask);
#endif
}
 
inline void OdGsEntityNode::markToSkip(unsigned mask, bool bSkip)
{
  ODA_ASSERT((mask >= kMarkedToSkipFirst) && (mask <= kMarkedToSkipLast));
  ODA_ASSERT(mask && !(mask & (mask-1))); // this function does not accept multi-bit masks
  if(markedToSkip(mask) != bSkip)
  {
    //atomic function is required, called in MT mode (display)
#ifndef TD_SINGLE_THREAD
    if(bSkip)
      OdInterlockedExchangeAdd(&m_markToSkipFlags, mask);
    else
      OdInterlockedExchangeAdd(&m_markToSkipFlags, -(int)mask);
#else
    SETBIT(m_markToSkipFlags, mask, bSkip);
#endif
  }
}
 
inline void OdGsEntityNode::markToSkipAll()
{
  //atomic function is NOT required, is NOT called in MT mode
  m_markToSkipFlags = kMarkedToSkipAll;
}
 
inline bool OdGsEntityNode::spatiallyIndexed() const
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    throw OdError(eInvalidIndex);
  return GETBIT(m_flags, kSpatiallyIndexed);
}
 
inline bool OdGsEntityNode::spatiallyIndexed(OdUInt32 nVpId) const
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    return GETBIT(nextEntEntry(nVpId)->m_entFlags, kSpatiallyIndexed);
  //if (nVpId > 0) // Normal case, since we can request from non-VpDep container
  //  throw OdError(eInvalidIndex);
  return GETBIT(m_flags, kSpatiallyIndexed);
}
 
inline void OdGsEntityNode::setSpatiallyIndexed(bool bIndexed)
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    throw OdError(eInvalidIndex);
  SETBIT(m_flags, kSpatiallyIndexed, bIndexed);
}
 
inline void OdGsEntityNode::setSpatiallyIndexed(OdUInt32 nVpId, bool bIndexed)
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    SETBIT(nextEntEntry(nVpId)->m_entFlags, kSpatiallyIndexed, bIndexed);
  else
    SETBIT(m_flags, kSpatiallyIndexed, bIndexed);
}
 
inline bool OdGsEntityNode::owned() const
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    throw OdError(eInvalidIndex);
  return GETBIT(m_flags, kOwned);
}
 
inline bool OdGsEntityNode::owned(OdUInt32 nVpId) const
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    return GETBIT(nextEntEntry(nVpId)->m_entFlags, kOwned);
  //if (nVpId > 0) // Normal case, since we can request from non-VpDep container
  //  throw OdError(eInvalidIndex);
  return GETBIT(m_flags, kOwned);
}
 
inline void OdGsEntityNode::setOwned(bool bOwned)
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    throw OdError(eInvalidIndex);
  SETBIT(m_flags, kOwned, bOwned);
}
 
inline void OdGsEntityNode::setOwned(OdUInt32 nVpId, bool bOwned)
{
  if (GETBIT(m_flags, kMultilistNextPtr))
    SETBIT(nextEntEntry(nVpId)->m_entFlags, kOwned, bOwned);
  else
    SETBIT(m_flags, kOwned, bOwned);
}
 
inline OdGsEntityNode::MetafilePtrArray& OdGsEntityNode::metafileArray()
{
  return m_metafile.getArray();
}
 
inline const OdGsEntityNode::MetafilePtrArray& OdGsEntityNode::metafileArray() const
{
  return m_metafile.getArray();
}
 
inline OdGsEntityNode::MetafilePtr OdGsEntityNode::metafile() const
{
  return m_metafile.get();
}
 
inline OdGsEntityNode::MetafilePtr OdGsEntityNode::metafileAt(int metafileIndex) const
{
  return metafileArray()[metafileIndex];
}
 
#define VPMETAFILEHOLDERARRAY_DESTRUCTOR ~MetafilePtrArray
 
inline void OdGsEntityNode::setMetafile(OdGsEntityNode::Metafile* pMetafile)
{
  m_metafile.set(pMetafile);
}
 
inline bool OdGsEntityNode::entityUnerased() const
{
  return GETBIT(m_flags, kEntityUnerased);
}
 
inline void OdGsEntityNode::setEntityUnerased(bool flag)
{
  SETBIT(m_flags, kEntityUnerased, flag);
}
 
inline bool OdGsEntityNode::isInvisible() const
{
  return GETBIT(m_flags, kInvisible);
}
 
inline void OdGsEntityNode::resetInvalidVpFlag()
{
  if (invalidVp())
  {
    setInvalidVp(false);
  }
}
 
inline bool OdGsEntityNode::markedAsNonSelectable() const
{
  return GETBIT(m_flags, kNonSelectable);
}
 
inline void OdGsEntityNode::markAsNonSelectable(bool val)
{
  SETBIT(m_flags, kNonSelectable, val);
}
 
inline bool OdGsEntityNode::isMarkedSkipSelection() const
{
  return GETBIT(m_flags, kSkipSelection);
}
 
inline void OdGsEntityNode::markSkipSelection(bool val)
{
  SETBIT(m_flags, kSkipSelection, val);
}
 
inline bool OdGsEntityNode::isMarkedErased() const
{
  return GETBIT(m_flags, kErased);
}
 
inline void OdGsEntityNode::markErased(bool val)
{
  SETBIT(m_flags, kErased, val);
}
 
inline bool OdGsEntityNode::Metafile::isEmpty() const
{
  for(const OdGsGeomPortion* ptr = &m_first; ptr; ptr = ptr->m_pNext)
  {
    if(ptr->m_pGsMetafile.get())
      return false;
  }
  return true;
}
 
inline bool OdGsEntityNode::isExtentsOutOfModelSpace() const
{
  return GETBIT(m_flags, kExtentsOutOfMS);
}
 
inline void OdGsEntityNode::setExtentsOutOfModelSpace(bool val)
{
  SETBIT(m_flags, kExtentsOutOfMS, val);
}
 
inline void OdGsEntityNode::setAsLightSourceOwner(bool bSet)
{
  SETBIT(m_entFlags, kLightSourceOwner, bSet);
}
 
inline bool OdGsEntityNode::isLightSourceOwner() const
{
  return GETBIT(m_entFlags, kLightSourceOwner);
}
 
inline bool OdGsEntityNode::isRequireRegenOnHighlightChange() const
{
  return GETBIT(m_entFlags, kRegenOnHighlight);
}
 
inline bool OdGsEntityNode::isInWorkset() const
{
  return GETBIT(m_flags, kInWorkset);
}
 
inline void OdGsEntityNode::setInWorkset(bool val)
{
  SETBIT(m_flags, kInWorkset, val);
}
 
inline bool OdGsEntityNode::isSingleThreaded() const
{
  return GETBIT(m_flags, kSingleThreaded);
}
 
inline void OdGsEntityNode::setSingleThreaded(bool val)
{
  SETBIT(m_flags, kSingleThreaded, val);
}
 
inline bool OdGsEntityNode::isRegenOnDraw() const
{
  return GETBIT(m_flags, kDrawableRegenDraw);
}
 
inline void OdGsEntityNode::setRegenOnDraw(bool val)
{
  SETBIT(m_flags, kDrawableRegenDraw, val);
}
 
inline void OdGsEntityNode::highlight(bool bDoIt, bool bWholeBranch, OdUInt32 nSelStyle)
{
  OdGsNode::highlight(bDoIt, bWholeBranch, nSelStyle);
  if (stateBranch() && (!bDoIt || bWholeBranch))
    resetStateBranch();
}
 
inline void OdGsEntityNode::hide(bool bDoIt, bool bSelectable, bool bWholeBranch)
{
  OdGsNode::hide(bDoIt, bSelectable, bWholeBranch);
  if (stateBranch(OdGsStateBranch::kVisibilityBranch) && (!bDoIt || bWholeBranch) )
    resetStateBranch(OdGsStateBranch::kVisibilityBranch);
}
 
inline void OdGsEntityNode::setStateBranch(OdGsStateBranch *pBr)
{ if (pBr)
  { const OdGsStateBranch::BranchType branchType = pBr->type();
    OdGsStateBranch *pPrevBranch = NULL, *pCurBranch = m_stateBranch.get();
    while (pCurBranch && (branchType > pCurBranch->type()))
      pPrevBranch = pCurBranch, pCurBranch = pCurBranch->nextTypeOfBranch();
    if (pCurBranch && (pCurBranch->type() == branchType))
    { // This branch type already exist
      if (pCurBranch == pBr)
        return; // Same branch
      pBr->setNextTypeOfBranch(pCurBranch->nextTypeOfBranch());
      pCurBranch->setNextTypeOfBranch(NULL);
    }
    else
    { // New branch of this type
      pBr->setNextTypeOfBranch(pCurBranch);
    }
    if (pPrevBranch)
      pPrevBranch->setNextTypeOfBranch(pBr);
    else
      m_stateBranch = pBr;
  }
  else
  {
    ODA_FAIL();
  }
}
 
inline void OdGsEntityNode::resetStateBranch(OdGsStateBranch::BranchType branchType)
{ OdGsStateBranch *pPrevBranch = NULL, *pCurBranch = m_stateBranch.get();
  while (pCurBranch && (branchType > pCurBranch->type()))
    pPrevBranch = pCurBranch, pCurBranch = pCurBranch->nextTypeOfBranch();
  if (pCurBranch && (pCurBranch->type() == branchType))
  { OdGsStateBranchPtr brLock(pCurBranch);
    if (pPrevBranch)
      pPrevBranch->setNextTypeOfBranch(pCurBranch->nextTypeOfBranch());
    else
      m_stateBranch = pCurBranch->nextTypeOfBranch();
    pCurBranch->setNextTypeOfBranch(NULL);
    if (brLock->reactor())
      brLock->reactor()->onBranchDetach(this, brLock);
  }
}
 
inline OdGsStateBranch *OdGsEntityNode::stateBranch(OdGsStateBranch::BranchType branchType)
{ OdGsStateBranch *pCurBranch = m_stateBranch.get();
  if (pCurBranch)
  {
    do
    {
      if (pCurBranch->type() == branchType)
        break;
      if (pCurBranch->type() > branchType)
        pCurBranch = NULL;
      else
        pCurBranch = pCurBranch->nextTypeOfBranch();
    } while (pCurBranch);
  }
  return pCurBranch;
}
 
inline const OdGsStateBranch *OdGsEntityNode::stateBranch(OdGsStateBranch::BranchType branchType) const
{ const OdGsStateBranch *pCurBranch = m_stateBranch.get();
  if (pCurBranch)
  {
    do
    {
      if (pCurBranch->type() == branchType)
        break;
      if (pCurBranch->type() > branchType)
        pCurBranch = NULL;
      else
        pCurBranch = pCurBranch->nextTypeOfBranch();
    } while (pCurBranch);
  }
  return pCurBranch;
}
 
inline bool OdGsEntityNode::hasAnyStateBranch() const
{
  return !m_stateBranch.isNull();
}
 
inline void OdGsEntityNode::setExtentsFlags()
{
  SETBIT(m_flags, kHasExtents, m_extents.isValidExtents());
  SETBIT(m_flags, kExtentsOutOfMS, !OdSi::properExtents(m_extents));
}
 
inline OdDb::LineWeight OdGsEntityNode::getMaxLineweightUsed() const
{
  return (OdDb::LineWeight)((m_entFlags & kLineweightBitMask) >> kLineweightOffset);
}
 
inline void OdGsEntityNode::addMaxLineweightUsed(OdDb::LineWeight lwd)
{
  if (lwd)
  {
    OdDb::LineWeight maxLwd = getMaxLineweightUsed();
    if (lwd > maxLwd)
      setMaxLineweightUsed(lwd);
  }
}
 
inline void OdGsEntityNode::setMaxLineweightUsed(OdDb::LineWeight lwd)
{
  m_entFlags = ((OdUInt32(lwd) << kLineweightOffset) & kLineweightBitMask) | (m_entFlags & ~kLineweightBitMask);
}
 
inline bool OdGsEntityNode::markedByUpdateManager() const
{
  return GETBIT(m_entFlags, kMarkedByUpdateManager);
}
 
inline void OdGsEntityNode::setMarkedByUpdateManager(bool bMarked)
{
  SETBIT(m_entFlags, kMarkedByUpdateManager, bMarked);
}
 
inline bool OdGsEntityNode::skipDisplayClipping() const
{
  return GETBIT(m_entFlags, kSkipDisplayClipping);
}
 
inline void OdGsEntityNode::setSkipDisplayClipping(bool bOn)
{
  SETBIT(m_entFlags, kSkipDisplayClipping, bOn);
}
 
inline bool OdGsEntityNode::isXref() const
{
  return GETBIT(m_flags, kDrawableIsXref);
}
 
typedef OdArray<OdGsEntityNode*, OdMemoryAllocator<OdGsEntityNode*> > OdGsEntityNodeArray;
 
#include "TD_PackPop.h"
 
#endif // __OD_GS_ENTITY_NODE__