GsModel.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 __ODGSMODEL_H_INCLUDED_
#define __ODGSMODEL_H_INCLUDED_
 
#include "Gs/Gs.h"
#include "Gs/GsSimpleParams.h"
#include "Ge/GePoint3dArray.h"
 
class OdGiPathNode;
 
#include "TD_PackPush.h"

class FIRSTDLL_EXPORT ODRX_ABSTRACT OdGsCache : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdGsCache);

  virtual OdGsModel* model() const = 0;

  virtual void setDrawableNull() = 0;

  virtual bool extents(OdGeExtents3d& extents) const = 0;
};
 
typedef OdGiDrawablePtr (*OdGiOpenDrawableFn)(OdDbStub* id);
 
class OdGsModelReactor;

class FIRSTDLL_EXPORT ODRX_ABSTRACT OdGsModel : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdGsModel);

  virtual void setOpenDrawableFn(OdGiOpenDrawableFn openDrawableFn) = 0;

  virtual void onAdded(OdGiDrawable* pAdded, OdGiDrawable* pParent) = 0;

  virtual void onAdded(OdGiDrawable* pAdded, OdDbStub* parentID) = 0;
  
  virtual void onModified(OdGiDrawable* pModified, OdGiDrawable* pParent) = 0;

  virtual void onModified(OdGiDrawable* pModified, OdDbStub* parentID) = 0;

  virtual void onModifiedGraphics(const OdGiDrawable* pModified, OdDbStub* parentID) = 0;

  virtual void onErased(OdGiDrawable* pErased, OdGiDrawable* pParent) = 0;

  virtual void onErased(OdGiDrawable* pErased, OdDbStub* parentID) = 0;

  virtual void onUnerased(OdGiDrawable* pUnerased, OdGiDrawable* pParent);
 
  virtual void onUnerased(OdGiDrawable* pUnerased, OdDbStub* parentID);
 
  // Invalidation Hint

  enum InvalidationHint
  {
    kInvalidateIsolines       = 0,  // Invalidate isolines
    kInvalidateViewportCache  = 1,  // Invalidate viewport cache
    kInvalidateAll            = 2,  // Invalidate all caches
    kInvalidateMaterials      = 3,  // Invalidate materials
    kInvalidateLinetypes      = 4   // Invalidate all linetype caches
  };

  virtual void invalidate(InvalidationHint hint) = 0;

  virtual void invalidate(OdGsView* pView) = 0;

  virtual void invalidateVisible( OdGsDevice* pDevice ) = 0;

  virtual void setTransform(const OdGeMatrix3d&) = 0;

  virtual OdGeMatrix3d transform() const = 0;

  virtual void highlight(const OdGiPathNode& path, bool bDoIt = true, OdUInt32 nStyle = 0, const OdGsView* pView = NULL) = 0;

  virtual void highlight(const OdGiPathNode& path, const OdGsMarker* pMarkers, OdUInt32 nMarkers, bool bDoIt = true,
                         OdUInt32 nStyle = 0, const OdGsView* pView = NULL) = 0;

  virtual void hide(const OdGiPathNode& path, bool bDoIt = true, bool bSelectHidden = false, const OdGsView* pView = NULL) = 0;

  virtual void hide(const OdGiPathNode& path, const OdGsMarker* pMarkers, OdUInt32 nMarkers, bool bDoIt = true,
                    bool bSelectHidden = false, const OdGsView* pView = NULL) = 0;

  virtual void externalTransform(const OdGiPathNode& path, bool bDoIt = true, const OdGsMatrixParam *xForm = NULL,
                                 const OdGsView* pView = NULL) = 0;

  virtual void externalTransform(const OdGiPathNode& path, const OdGsMarker* pMarkers, OdUInt32 nMarkers, bool bDoIt = true,
                                 const OdGsMatrixParam *xForm = NULL, const OdGsView* pView = NULL) = 0;

  virtual bool getExternalTransform(const OdGiPathNode &path, const OdGsMatrixParam *&xForm, const OdGsView *pView = NULL) const = 0;

  enum RenderType
  {
    kMinRenderType = -3, // Number of RenderType's in negative values range
    kUserBg1       = -3, // User-defined background rendering type without Z-buffer
    kUserBg2       = -2, // User-defined background rendering type with own Z-buffer
    kUserBg3       = -1, // User-defined background rendering type with Z-buffer
    kMain          =  0, // Use main Z-buffer
    kSprite,             // Use alternate Z-buffer (for sprites)
    kDirect,             // Render on device directly
    kHighlight,          // Render on device directly (skipping frame buffer and Z-buffer)
    kHighlightSelection, // Render on device directly using highlighting style (skipping frame buffer and Z-buffer)
    kDirectTopmost,      // Render on top of all other render types without Z-buffer
    kContrast,           // Render with contrast style
    kCount,              // Number of primary predefined RenderType's
    kUserFg1 = kCount,   // User-defined foreground rendering type with Z-buffer
    kUserFg2,            // User-defined foreground rendering type with own Z-buffer
    kUserFg3,            // Second user-defined foreground rendering type without Z-buffer
    kMaxRenderType,      // Number of RenderType's in positive values range
    kNumRenderTypes = kMaxRenderType - kMinRenderType // Exact number of RenderType's including predefined and user-defined RenderType's
  };

  virtual void setRenderType(RenderType renderType) = 0;

  virtual RenderType renderType() const = 0;
 
  //virtual bool addSceneGraphRoot(OdGiDrawable* pRoot) = 0;
  //virtual bool eraseSceneGraphRoot(OdGiDrawable* pRoot) = 0;

  virtual void setRenderModeOverride(OdGsView::RenderMode mode = OdGsView::kNone) = 0;

  virtual OdGsView::RenderMode renderModeOverride() const = 0;

  virtual void setViewClippingOverride(bool bEnable) = 0;

  virtual bool viewClippingOverride() const = 0;

  virtual void setBackground(OdDbStub *backgroundId) = 0;

  virtual OdDbStub *background() const = 0;

  virtual void setVisualStyle(OdDbStub *visualStyleId) = 0;
  
  virtual OdDbStub *visualStyle() const = 0;

  virtual void setVisualStyle(const OdGiVisualStyle &visualStyle) = 0;
  
  virtual bool visualStyle(OdGiVisualStyle &visualStyle) const = 0;
 
  virtual void addModelReactor(OdGsModelReactor *pReactor) = 0;
 
  virtual void removeModelReactor(OdGsModelReactor *pReactor) = 0;

  virtual void setEnableSectioning(bool bEnable) = 0;

  virtual bool isSectioningEnabled() const = 0;

  virtual bool setSectioning(const OdGePoint3dArray &points, const OdGeVector3d &upVector) = 0;

  virtual bool setSectioning(const OdGePoint3dArray &points, const OdGeVector3d &upVector,
                             double dTop, double dBottom) = 0;
                           
  virtual void setSectioningVisualStyle(OdDbStub *visualStyleId) = 0;

  virtual void setEnableLinetypes(bool bEnable) = 0;

  virtual bool isLinetypesEnabled() const = 0;

  virtual void setSelectable(bool bEnable) = 0;

  virtual bool isSelectable() const = 0;

  virtual void setEnableViewExtentsCalculation(bool bEnable) = 0;

  virtual bool isViewExtentsCalculationEnabled() const = 0;

  virtual void setEnableLightsInBlocks(bool bEnable) = 0;

  virtual bool isLightsInBlocksEnabled() const = 0;

  virtual void setViewSectioningOverride(bool bEnable) = 0;

  virtual bool viewSectioningOverride() const = 0;
};
 
#if defined _MSC_VER
#pragma warning(push)
#pragma warning(disable:4100) // unreferenced formal parameter
#endif

class OdGsModelReactor
{
  public:
    OdGsModelReactor() { }
    
    virtual ~OdGsModelReactor() { }
 
    //virtual bool onSceneGraphRootAdded(OdGsModel *pModel, OdGiDrawable *pAdded) { return true; }
    //virtual bool onSceneGraphRootErased(OdGsModel *pModel, OdGiDrawable *pErased) { return true; }

    virtual bool onAdded(OdGsModel *pModel, OdGiDrawable *pAdded, OdGiDrawable *pParent) { return true; }
    
    virtual bool onAdded(OdGsModel *pModel, OdGiDrawable *pAdded, OdDbStub *parentID) { return true; }

    virtual bool onErased(OdGsModel *pModel, OdGiDrawable *pErased, OdGiDrawable *pParent) { return true; }
    
    virtual bool onErased(OdGsModel *pModel, OdGiDrawable *pErased, OdDbStub *parentID) { return true; }

    virtual bool onModified(OdGsModel *pModel, OdGiDrawable *pModified, OdGiDrawable *pParent) { return true; }
    
    virtual bool onModified(OdGsModel *pModel, OdGiDrawable *pModified, OdDbStub *parentID) { return true; }

    virtual bool onUnerased(OdGsModel *pModel, OdGiDrawable *pUnerased, OdGiDrawable *pParent) { return onAdded(pModel, pUnerased, pParent); }
    
    virtual bool onUnerased(OdGsModel *pModel, OdGiDrawable *pUnerased, OdDbStub *parentID) { return onAdded(pModel, pUnerased, parentID); }
};
 
#if defined _MSC_VER
#pragma warning(pop)
#endif
 
#include "TD_PackPop.h"
 
#endif // __ODGSMODEL_H_INCLUDED_