GiDrawable.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 __ODDRAWABLE_H__
#define __ODDRAWABLE_H__  /* { Secret} **/
 
#include "RxObject.h"
#include "RxOverrule.h"
 
class OdGiDrawableTraits;
class OdGiWorldDraw;
class OdGiViewportDraw;
class OdGsCache;
class OdDbStub;
class OdGeExtents3d;
 
#include "TD_PackPush.h"

class FIRSTDLL_EXPORT OdGiDrawable : public OdRxObject
{
protected:
  OdGiDrawable();
public:
 
  ODRX_DECLARE_MEMBERS(OdGiDrawable);

  enum SetAttributesFlags
  {
    kDrawableNone                         = 0, // Default flags; the drawable object uses only OdGi primitives, 
                                               // with no nested calls to draw().
    kDrawableIsAnEntity                   = 1, // Classes derived from OdDbEntity must set this flag,
                                               // which is set by the default implementation of 
                                               // OdDbEntity::subSetAttributes().
    kDrawableUsesNesting                  = 2, // The drawable uses nested calls to draw(), but makes no
                                               // calls to other OdGi primatives. 
    kDrawableIsCompoundObject             = 4, // The drawable is to be treated as a block. Valid only when combined 
                                               // with kDrawableIsAnEntity. If set, you must override 
                                               // OdDbEntity::getCompoundObjectTransform().
    kDrawableViewIndependentViewportDraw  = 8,  // Currently not supported.
    kDrawableIsInvisible                  = 16, // Object is invisible, and should not be rendered.
    kDrawableHasAttributes                = 32, // Currently not supported.
    kDrawableRegenTypeDependantGeometry   = 64, // This flag must be set for objects which is drawn differently in different regen type modes.
    kDrawableIsDimension                  = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128), // Dimension objects must set these flags
                                                // which are set by the default implementation of OdDbDimension.
    kDrawableRegenDraw                    = 256, // The drawable must be always regenerated.
    kDrawableStandardDisplaySingleLOD     = 512,   // Currently not supported.
    kDrawableShadedDisplaySingleLOD       = 1024,  // Currently not supported.
    kDrawableViewDependentViewportDraw    = 2048,  // Currently not supported.
    kDrawableBlockDependentViewportDraw   = 4096,  // Currently not supported.
    kDrawableIsExternalReference          = 8192,  // Currently not supported.
    kDrawableNotPlottable                 = 16384, // Currently not supported.
    kDrawableNotAllowLCS                  = 32768, // Currently not supported.
    kDrawableMergeControlOff              = 65536, // Merge Control disabled for this drawable
 
    kLastFlag                             = kDrawableMergeControlOff // Marker
  };

  enum DrawableType
  {
      kGeometry              = 0,     // Geometry.
      kDistantLight          = 1,     // Distant light. This number is important!
      kPointLight            = 2,     // Point light. This number is important!
      kSpotLight             = 3,     // Spot light. This number is important!
      kAmbientLight,                  // Ambient light.
      kSolidBackground,               // Solid background light.
      kGradientBackground,            // Gradient background.
      kImageBackground,               // Image background.
      kGroundPlaneBackground,         // Ground plane background.
      kViewport,                      // Viewport.
      kWebLight,                      // Web light.
      kSkyBackground,                 // Sky background.
      kImageBasedLightingBackground,  // Image-based lightning background.
      // 
      kEnvironmentBackground = 16,    // Environment background.
      kCustomBackground               // User-defined background.
  };

  virtual DrawableType drawableType() const { return kGeometry; }

  ODRX_SEALED_VIRTUAL OdUInt32 setAttributes(OdGiDrawableTraits* pTraits) const ODRX_FINAL;

  ODRX_SEALED_VIRTUAL bool worldDraw(OdGiWorldDraw* pWd) const ODRX_FINAL;

  ODRX_SEALED_VIRTUAL void viewportDraw(OdGiViewportDraw* pVd) const ODRX_FINAL;

  virtual bool isPersistent() const = 0;

  virtual OdDbStub* id() const = 0;

  virtual void setGsNode(OdGsCache* pGsNode) = 0;

  virtual OdGsCache* gsNode() const = 0;

  ODRX_SEALED_VIRTUAL OdUInt32 viewportDrawLogicalFlags(OdGiViewportDraw* pVd) const ODRX_FINAL;

  virtual OdResult getGeomExtents(OdGeExtents3d& extents) const;

  ODRX_SEALED_VIRTUAL OdUInt32 regenSupportFlags() const ODRX_FINAL;
 
protected:
  virtual OdUInt32 subSetAttributes (OdGiDrawableTraits * traits) const = 0;
  virtual bool subWorldDraw (OdGiWorldDraw * wd) const = 0;
  virtual void subViewportDraw (OdGiViewportDraw * vd) const = 0;
  virtual OdUInt32 subViewportDrawLogicalFlags (OdGiViewportDraw * vd) const;
  virtual OdUInt32 subRegenSupportFlags() const;
  friend class OdGiDrawableOverrule;
};

typedef OdSmartPtr<OdGiDrawable> OdGiDrawablePtr;

class FIRSTDLL_EXPORT OdGiDrawableOverrule : public OdRxOverrule
{
public:
  ODRX_DECLARE_MEMBERS(OdGiDrawableOverrule);

  OdGiDrawableOverrule();

  virtual OdUInt32 setAttributes (const OdGiDrawable* pSubject, OdGiDrawableTraits * traits);

  virtual bool worldDraw (const OdGiDrawable* pSubject, OdGiWorldDraw * wd);

  virtual void viewportDraw (const OdGiDrawable* pSubject, OdGiViewportDraw * vd);

  virtual OdUInt32 viewportDrawLogicalFlags (const OdGiDrawable* pSubject, OdGiViewportDraw * vd);

  virtual OdUInt32 regenSupportFlags(const OdGiDrawable* pSubject);
};
 
#include "TD_PackPop.h"
 
#endif // __ODDRAWABLE_H__