GsProperties.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 _ODGSPROPERTIES_H_INCLUDED_
#define _ODGSPROPERTIES_H_INCLUDED_
 
#include "OdaCommon.h"
#include "RxObject.h"
#include "Gi/GiDrawable.h"
#include "Gi/GiCommonDraw.h"
#include "Gs/GsExport.h"
#include "CmColorBase.h"
 
class OdDbStub;
 
class OdGiRasterImage;
class OdGsBaseVectorizer;
class OdGsViewImpl;
 
#include "TD_PackPush.h"

class OdGsPropertiesDirectRenderOutput
{
  public:
    enum DirectRenderFlags
    {
      DirectRender_Point           = 1,
      DirectRender_LineFlat        = (1 << 1),
      DirectRender_LineGouraud     = (1 << 2),
      DirectRender_TriangleFlat    = (1 << 3),
      DirectRender_TriangleGouraud = (1 << 4),
      DirectRender_PolygoneFlat    = (1 << 5),
      DirectRender_PolygoneGouraud = (1 << 6),
      DirectRender_Image           = (1 << 7)
    };
    struct DirectRenderImageUV
    {
      double u, v;
    };
    struct DirectRenderImageParams
    {
      DirectRenderImageUV *uvCoords;
      const OdGiDrawable *pDrawable; // For images caching
      bool bUpdate;
      DirectRenderImageParams() : uvCoords(NULL), pDrawable(NULL), bUpdate(false) {}
    };
  public:
    virtual void directRenderOutputPoint(const OdGePoint3d &/*point*/,
                                         const OdCmEntityColor &/*color*/)
    {
    }
    virtual void directRenderOutputLineFlat(const OdGePoint3d &/*pt1*/, const OdGePoint3d &/*pt2*/,
                                            const OdCmEntityColor &/*color*/)
    {
    }
    virtual void directRenderOutputLineGouraud(const OdGePoint3d &/*pt1*/, const OdGePoint3d &/*pt2*/,
                                               const OdCmEntityColor &/*clr1*/, const OdCmEntityColor &/*clr2*/)
    {
    }
    virtual void directRenderOutputTriangleFlat(const OdGePoint3d &/*pt1*/, const OdGePoint3d &/*pt2*/, const OdGePoint3d &/*pt3*/,
                                                const OdCmEntityColor &/*color*/)
    {
    }
    virtual void directRenderOutputTriangleGouraud(const OdGePoint3d &/*pt1*/, const OdGePoint3d &/*pt2*/, const OdGePoint3d &/*pt3*/,
                                                   const OdCmEntityColor &/*clr1*/, const OdCmEntityColor &/*clr2*/, const OdCmEntityColor &/*clr3*/)
    {
    }
    virtual void directRenderOutputPolygoneFlat(OdUInt32 /*nPts*/, const OdGePoint3d * /*pPts*/,
                                                const OdCmEntityColor &/*color*/)
    {
    }
    virtual void directRenderOutputPolygoneGouraud(OdUInt32 /*nPts*/, const OdGePoint3d * /*pPts*/,
                                                   const OdCmEntityColor * /*pClrs*/)
    {
    }
    virtual void directRenderOutputImage(const OdGePoint3d * /*pRect*/, const OdGiRasterImage * /*pImage*/,
                                         const OdGsPropertiesDirectRenderOutput::DirectRenderImageParams &/*driParams*/)
    {
    }
 
    virtual OdUInt32 directRenderOutputFlags() const = 0;
    
    virtual ~OdGsPropertiesDirectRenderOutput() {}
};

class GS_TOOLKIT_EXPORT OdGsProperties : public OdRxObject
{
public:
  enum PropertiesType
  {
    kViewport          = 1,
    
    kBackground        = (1 << 1),
    
    kVisualStyle       = (1 << 2),
    
    kRenderEnvironment = (1 << 3),
    
    kRenderSettings    = (1 << 4),
    
    kDeviceSimple      = 0,

    kDeviceBackground  = 3, // kViewport | kBackground

    kDeviceNormal      = 7, // kViewport | kBackground | kVisualStyle

    kDeviceRender      = 31, // kAll

    kAll               = 31
  };
protected:
  void *m_pUnderlyingDrawable;
  const OdGiDrawable *m_pInconsistentDrawable;
  OdGiContext* m_context;
 
  OdGiDrawablePtr (*m_pOpenDrawableFn)(OdDbStub* id);
  bool m_bDrawablePersistent;
  // For optimize
  OdGiDrawable::DrawableType m_dType;
public:
  ODRX_DECLARE_MEMBERS(OdGsProperties);

  OdGsProperties();
 
  void setOpenDrawableFn(OdGiDrawablePtr (*fn)(OdDbStub*));

  void setUnderlyingDrawable(const OdGiDrawable *pUnderlyingDrawable, OdGiContext* ctx);
  
  OdGiDrawablePtr underlyingDrawable() const;
  
  bool isUnderlyingDrawableChanged(const OdGiDrawable *pUnderlyingDrawable) const;
  
  bool hasUnderlyingDrawable() const;
 
  bool isUnderlyingDrawablePersistent() const;
  
  OdDbStub* underlyingDrawableId() const;

  OdGiDrawable::DrawableType underlyingDrawableType() const;

  virtual PropertiesType propertiesType() const = 0;
 
  // Search down in hierarchy for appropriate properties
  virtual OdSmartPtr<OdGsProperties> propertiesForType(PropertiesType /*type*/) const;
 
  // Update attributes
  virtual void update(const OdGiDrawable* pUnderlyingDrawable,
      OdGsViewImpl* view, OdUInt32 incFlags = kAll) = 0;
  // Display attributed data
  virtual void display(OdGsBaseVectorizer& view,
      OdGsPropertiesDirectRenderOutput *pdro = NULL, OdUInt32 incFlags = kAll) = 0;
};

typedef OdSmartPtr<OdGsProperties> OdGsPropertiesPtr;
 
#include "TD_PackPop.h"
 
#endif // _ODGSPROPERTIES_H_INCLUDED_