AcDbHatch.h

Go to the documentation of this file.

#pragma once
 
//
// (C) Copyright 2005-2024 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#include "..\acdb17\AcDbEntity.h"
#include "..\acdb17\AcDb.h"
#include "..\acad\Acad.h"
 
template < typename Param1 > class AcArrayMemCopyReallocator;
class AcCmColor;
class AcDbEntity;
class AcDbIdMapping;
class AcDbObjectId;
class AcDbRegion;
class AcDbSystemInternals;
class AcGePlane;
class AcGePoint2d;
class AcGeVector3d;
class AcRxClass;
 
class ARX_API AcDbHatch : public AcDbEntity
{
public:
        enum GradientPatternType
        {
                kPreDefinedGradient = 0,
                kUserDefinedGradient = 1
        };
        enum HatchLoopType
        {
                kDefault = 0,
                kExternal = 1,
                kPolyline = 2,
                kDerived = 4,
                kTextbox = 8,
                kOutermost = 0x10,
                kNotClosed = 0x20,
                kSelfIntersecting = 0x40,
                kTextIsland = 0x80,
                kDuplicate = 0x100,
                kIsAnnotative = 0x200,
                kDoesNotSupportScale = 0x400,
                kForceAnnoAllVisible = 0x800,
                kOrientToPaper = 0x1000,
                kIsAnnotativeBlock = 0x2000
        };
        enum HatchObjectType
        {
                kHatchObject = 0,
                kGradientObject = 1
        };
        enum HatchPatternType
        {
                kUserDefined = 0,
                kPreDefined = 1,
                kCustomDefined = 2
        };
        enum HatchStyle
        {
                kNormal = 0,
                kOuter = 1,
                kIgnore = 2
        };
 
    enum HatchEdgeType
    {
        kLine = 1,
        kCirArc = 2,
        kEllArc = 3,
        kSpline = 4 
    };
 
public:
          AcDbHatch(void);
         bool  associative(void)const ;
         bool  isSolidFill(void)const ;
         bool  lineGenerationEnabled(void)const ;
         bool  patternDouble(void)const ;
         bool  setLineGenerationEnabled(bool);
          AcDbRegion *  getRegionArea(void)const ;
          AcGePoint2d  originPoint(void)const ;
          AcGeVector3d  normal(void)const ;
         double  elevation(void)const ;
         double  gradientAngle(void)const ;
         double  patternAngle(void)const ;
         double  patternScale(void)const ;
         double  patternSpace(void)const ;
          GradientPatternType  gradientType(void)const ;
          HatchObjectType  hatchObjectType(void)const ;
          HatchPatternType  patternType(void)const ;
          HatchStyle  hatchStyle(void)const ;
          Acad::ErrorStatus  appendLoop(long, AcDbObjectIdArray const &);
          Acad::ErrorStatus  appendLoop(long, AcGePoint2dArray const &, AcGeDoubleArray const &);
          Acad::ErrorStatus  appendLoop(long, AcDbVoidPtrArray const &, AcGeIntArray const &);
          Acad::ErrorStatus  evaluateGradientColorAt(float, AcCmColor &);
          Acad::ErrorStatus  evaluateHatch(bool=true);
          Acad::ErrorStatus  getArea(double &)const ;
          Acad::ErrorStatus  getAssocObjIds( AcDbObjectIdArray &)const ;
          Acad::ErrorStatus  getAssocObjIdsAt(int, AcDbObjectIdArray &)const ;
          Acad::ErrorStatus  getGradientColors(unsigned int &, AcCmColor * &,float * &);
          Acad::ErrorStatus  getHatchLineDataAt(int, AcGePoint2d &, AcGePoint2d &)const ;
          Acad::ErrorStatus  getHatchLinesData( AcGePoint2dArray &, AcGePoint2dArray &)const ;
          Acad::ErrorStatus  getLoopAt(int,long &, AcGePoint2dArray &, AcGeDoubleArray &)const ;
          Acad::ErrorStatus  getLoopAt(int,long &, AcDbVoidPtrArray &, AcGeIntArray &)const ;
          Acad::ErrorStatus  getPatternDefinitionAt(int,double &,double &,double &,double &,double &, AcGeDoubleArray &)const ;
          Acad::ErrorStatus  insertLoopAt(int,long, AcDbObjectIdArray const &);
          Acad::ErrorStatus  insertLoopAt(int,long, AcGePoint2dArray const &, AcGeDoubleArray const &);
          Acad::ErrorStatus  insertLoopAt(int,long, AcDbVoidPtrArray const &, AcGeIntArray const &);
          Acad::ErrorStatus  removeAssocObjIds(void);
          Acad::ErrorStatus  removeLoopAt(int);
          Acad::ErrorStatus  setAssociative(bool);
          Acad::ErrorStatus  setElevation(double);
          Acad::ErrorStatus  setGradient( GradientPatternType,wchar_t const *);
          Acad::ErrorStatus  setGradientAngle(double);
          Acad::ErrorStatus  setGradientColors(unsigned int, AcCmColor *,float *);
          Acad::ErrorStatus  setGradientOneColorMode(int);
          Acad::ErrorStatus  setGradientShift(float);
          Acad::ErrorStatus  setHatchObjectType( HatchObjectType);
          Acad::ErrorStatus  setHatchStyle( HatchStyle);
          Acad::ErrorStatus  setNormal( AcGeVector3d const &);
          Acad::ErrorStatus  setOriginPoint( AcGePoint2d const &);
          Acad::ErrorStatus  setPattern( HatchPatternType,ACHAR const *);
          Acad::ErrorStatus  setPatternAngle(double);
          Acad::ErrorStatus  setPatternDouble(bool);
          Acad::ErrorStatus  setPatternScale(double);
          Acad::ErrorStatus  setPatternSpace(double);
          Acad::ErrorStatus  setShadeTintValue(float);
          Acad::ErrorStatus  setShadeTintValueAndColor2(float);
         float  getShadeTintValue(void)const ;
         float  gradientShift(void)const ;
         int  getGradientOneColorMode(void)const ;
         int  numHatchLines(void)const ;
         int  numLoops(void)const ;
         int  numPatternDefinitions(void)const ;
         long  loopTypeAt(int)const ;
         
         virtual  ~AcDbHatch(void);
         virtual bool  castShadows(void)const ;
         virtual bool  receiveShadows(void)const ;
         
         virtual  Acad::ErrorStatus  getClassID( _GUID *)const ;
         virtual  Acad::ErrorStatus  getPlane( AcGePlane &, AcDb::Planarity &)const ;
         virtual  Acad::ErrorStatus  subSwapIdWith( AcDbObjectId,int,int);
         virtual  Acad::ErrorStatus  swapReferences( AcDbIdMapping const &);
         virtual int  isGradient(void)const ;
         virtual int  isHatch(void)const ;
         virtual void  modifiedGraphics( AcDbEntity const *);
         virtual void  setCastShadows(bool);
         virtual void  setReceiveShadows(bool);
         void  removeHatchLines(void);
         wchar_t const *  gradientName(void)const ;
         wchar_t const *  patternName(void)const ;
     virtual  Acad::ErrorStatus  subClose( void );
     Acad::ErrorStatus setBackgroundColor(const AcCmColor& param_1);
 
         ACRX_DECLARE_MEMBERS( AcDbHatch )
 
protected:
          AcDbHatch( AcDbSystemInternals *);
 
};