Gi.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_GI_H_
#define _OD_GI_H_
 
#include "RxObject.h"
#include "CmColorBase.h"
#include "GiAuxData.h"
 
class OdDbStub;
class OdCmEntityColor;
class OdGeVector3d;
class OdGiMapper;
class OdCmTransparency;
struct OdGiDgLinetypeModifiers;
class OdGiFill;
struct OdGiLineweightOverride;
class OdGiPalette;

typedef enum
{
  kOdGiFillAlways = 1,  // Always fill closed graphic primitives.
  kOdGiFillNever  = 2   // Never fill closed graphic primitives.
} OdGiFillType;

typedef enum
{
  kOdGiInvisible      = 0, // Invisible
  kOdGiVisible        = 1, // Visible
  kOdGiSilhouette     = 2, // Silhouette edge
  kOdGiJoint          = 4  // Joint open silhouette edge
} OdGiVisibility;
 
#include "TD_PackPush.h"

class FIRSTDLL_EXPORT OdGiDrawableTraits : public OdRxObject
{ 
public:
  ODRX_DECLARE_MEMBERS(OdGiDrawableTraits);
};

class FIRSTDLL_EXPORT OdGiSubEntityTraits : public OdGiDrawableTraits
{
public:
  
  enum DrawFlags
  {
    kNoDrawFlags        = 0x0000,   // Default value. No DrawFlags specified.
    kDrawBackfaces      = 0x0001,   // Forces backfaces vectorization.
    kDrawHatchGroup     = 0x0002,   // Next shells and meshes should draw hatches.
    kDrawFrontfacesOnly = 0x0004,   // Forces discard backfaces mode.
    kDrawGradientFill   = 0x0008,   // Draws with gradient fill.
    kDrawSolidFill      = 0x0010,   // Draws with solid fill.
    kDrawNoLineWeight   = 0x0020,   // Disables lineweight.
    kDrawNoPlotstyle    = 0x0080,   // Disables plotstyles.
    // the range before 0x8000 is reserved.
    kDrawContourFill            = 0x08000, // Specific to DGN files.
    kDisableLayoutCache         = 0x10000, // Disable metafile caching for layout switching.
    kDrawBoundaryForClipping    = 0x20000, // Draw (rough) boundary of object to be checked
                                           // when clipping is performed, set by vectorizer.
    kDrawBoundaryForClippingDrw = 0x40000, // Draw (rough) boundary of object to be checked
                                           // when clipping is performed, set by a drawable.
    kClipSetIsEmpty             = 0x80000,
    kDrawPolygonFill            = 0x100000, // Fill in all modes if FillAlways mode enabled.
    kExcludeFromViewExt         = 0x200000, // Don't use extents of the entity when calculating total extents.
    kDrawDgLsPolyWithoutBreaks  = 0x400000, // Draw polylines/polygons with Dgn Line Style without segmentation.
    kPolygonProcessing          = 0x800000, // Polygon filling logic must be applied for shell primitive.
    kDisableAutoGenerateNormals = 0x1000000, // Avoid automatic generation of normals for mesh/shell primitives.
    kDisableFillModeCheck       = 0x2000000, // Avoid checking of OdGiContext::fillMode during filling of geometry primitives.
    kDrawUnderlayReference      = 0x4000000, // Draw underlay reference object.
    kLineStyleScaleOverride     = 0x8000000, // Doesn't multiply current line scale to byBlock line scale. Only for multiplyByBlockLinetypeScales mode.
    kDisableDisplayClipping     = 0x10000000, // Disable display clipping
    kRegenTypeDependent2dDraw   = 0x20000000, // Specific for spamodeler. Draw edges as polyline created by points generated by the faceter
    kInternalDrawFlags = kDisableLayoutCache | kClipSetIsEmpty | kRegenTypeDependent2dDraw,
//FELIX_CHANGE_BEGIN
    kDrawGeometryForExtents     = 0x04000,
    kFxNoFillOnSelect           = 0x40000000,
//FELIX_CHANGE_END
    // Flags which can be inherited by nested drawables.
    kInheritableDrawFlags       = kDrawNoLineWeight | kDrawNoPlotstyle | kDrawBoundaryForClipping | kDrawBoundaryForClippingDrw |
    kInternalDrawFlags | kExcludeFromViewExt | kDrawBackfaces | kDrawFrontfacesOnly | kDisableDisplayClipping | kRegenTypeDependent2dDraw
  };

  enum LockFlags
  {
    kNoLockFlags                = 0x00000000,   // No lock flags are used.
    kLockColors                 = 0x00000001,   // Lock colors.
    kLockLineWeight             = 0x00000002,   // Lock lineweight.
    kLockLineType               = 0x00000004,   // Lock linetype.
    kLockLineTypeScale          = 0x00000008,   // Lock linetype scale.
    kLockLayer                  = 0x00000010,   // Lock layer.
    kLockByBlockLayer           = 0x00000020,   // Lock the ByBlock layer.
    kKeepAuxDataAndLockFlags    = 0x00000040,   // Keep auxiliary data and lock flags.
    kInheritableLockFlags       = kLockColors | kLockLineWeight | kLockLineType | kLockLineTypeScale | kLockLayer | kKeepAuxDataAndLockFlags  // Inherited lock flags.
  };

  enum ShadowFlags
  {
    kShadowsCastAndReceive = 0,   // Geometry could cast and receive shadows.
    kShadowsDoesNotCast    = 1,   // Geometry doesn't cast shadows.
    kShadowsDoesNotReceive = 2,   // Geometry doesn't receive shadows.
    kShadowsIgnore         = kShadowsDoesNotCast | kShadowsDoesNotReceive // Geometry doesn't cast and receive shadows.
  };

  enum SelectionFlags
  {
    kNoSelectionFlags = 0,   // No selection flags set.
    kSelectionIgnore      = 1, // Avoid geometry selection.
    kHighlightingGeometry = 2, // Geometry drawn only in case if entire entity highlighted.
    kHiddenInHighlight    = 4  // Geometry hidden only in case if entire entity highlighted. 
//FELIX_CHANGE_BEGIN
    ,
#ifdef XENON
    kFxDrawWhenSelected = 0x08,     // XENON: Geometry drawn only when entity is selected
    kFxSkipDrawWhenSelected = 0x10, // XENON: Geometry hidden when entity is selected
#endif
    kFxSubentitySelection = 0x80 // Selection geometry for subentity selection only.
//FELIX_CHANGE_END
  };

  enum SubEntityHints
  {
    kHint2DAttributes  = 1,  // Setup attributes only available in 2DWireframe mode (plotStyles and etc.).
    kHint3DAttributes  = 2,  // Setup attributes only available in shaded modes (materials and etc.).
    kHintAllAttributes = kHint2DAttributes | kHint3DAttributes,  // Setup attributes that available in both 2D and 3D modes.
    kHintSnapModeOn  = 4,  // Setup that we currently inside selection for snap method.
    kHintDefaultState  = kHintAllAttributes  // Default setup flag for the attributes.
  };
public:
  ODRX_DECLARE_MEMBERS(OdGiSubEntityTraits);

  virtual void setColor(
    OdUInt16 color) = 0;

  virtual void setTrueColor(
    const OdCmEntityColor& color) = 0;

  virtual void setLayer(
    OdDbStub* layerId) = 0;

  virtual void setLineType(
    OdDbStub* lineTypeId) = 0;

  virtual void setSelectionMarker(
    OdGsMarker selectionMarker) = 0;

  virtual void setFillType(
    OdGiFillType fillType) = 0;

  virtual void setFillPlane(
    const OdGeVector3d* pNormal = 0);

  virtual void setLineWeight(
    OdDb::LineWeight lineWeight) = 0;

  virtual void setLineTypeScale(
    double lineTypeScale = 1.0) = 0;

  virtual void setThickness(
    double thickness) = 0;

  virtual void setPlotStyleName(
    OdDb::PlotStyleNameType plotStyleNameType, 
    OdDbStub* plotStyleNameId = 0) = 0;

  virtual void setMaterial(
    OdDbStub* materialId) = 0;

  virtual void setMapper(
    const OdGiMapper *pMapper) = 0;

  virtual void setVisualStyle(
    const OdDbStub* visualStyleId);

  virtual void setTransparency(
    const OdCmTransparency &transparency);

  virtual void setDrawFlags(
    OdUInt32 drawFlags);

  virtual void setLockFlags(
    OdUInt32 lockFlags);

  virtual void setSelectionGeom(
    bool bSelectionFlag);

  virtual void setShadowFlags(
    ShadowFlags shadowFlags);

  virtual void setSectionable(
    bool bSectionableFlag);

  virtual void setSelectionFlags(
    SelectionFlags selectionFlags);

  virtual OdUInt16 color() const = 0;

  virtual OdCmEntityColor trueColor() const = 0;

  virtual OdDbStub* layer() const = 0;

  virtual OdDbStub* lineType() const = 0;

  virtual OdGiFillType fillType() const = 0;

  virtual bool fillPlane(
    OdGeVector3d& normal);

  virtual OdDb::LineWeight lineWeight() const = 0;

  virtual double lineTypeScale() const = 0;

  virtual double thickness() const = 0;

  virtual OdDb::PlotStyleNameType plotStyleNameType() const = 0;

  virtual OdDbStub* plotStyleNameId() const = 0;

  virtual OdDbStub* material() const = 0;
  
  virtual const OdGiMapper* mapper() const = 0;

  virtual OdDbStub* visualStyle() const;

  virtual OdCmTransparency transparency() const;

  virtual OdUInt32 drawFlags() const;

  virtual OdUInt32 lockFlags() const;

  virtual bool selectionGeom() const;

  virtual ShadowFlags shadowFlags() const;

  virtual bool sectionable() const;

  virtual SelectionFlags selectionFlags() const;
 
  // Specific to DGN files

  virtual void setSecondaryTrueColor(
    const OdCmEntityColor& color);

  virtual OdCmEntityColor secondaryTrueColor() const;

  virtual void setLineStyleModifiers(
    const OdGiDgLinetypeModifiers* pLSMod);

  virtual const OdGiDgLinetypeModifiers* lineStyleModifiers() const;
 
  // eof Specific to DGN files section

  virtual void setFill(
    const OdGiFill* pFill);

  virtual const OdGiFill* fill() const;

  virtual void setAuxData(
    const OdGiAuxiliaryDataPtr& pAuxData);

  virtual OdGiAuxiliaryDataPtr auxData() const;

  virtual bool pushLineweightOverride(const OdGiLineweightOverride* pOverride);

  virtual void popLineweightOverride();

  virtual bool pushPaletteOverride(const OdGiPalette* pOverride);

  virtual void popPaletteOverride();

  virtual OdUInt32 setupForEntity() const;

  virtual void addLight(
    const OdDbStub* lightId);
};

typedef OdSmartPtr<OdGiSubEntityTraits> OdGiSubEntityTraitsPtr;
 
#include "TD_PackPop.h"
 
#endif //_OD_GI_H_