AcDbUnderlayReference.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 "..\acad\Acad.h"
 
template < typename Param1 > class AcArrayMemCopyReallocator;
class AcDbObjectId;
class AcDbSystemInternals;
class AcGeMatrix3d;
class AcGePoint2d;
class AcGePoint3d;
class AcGeScale3d;
class AcGeVector3d;
class AcRxClass;
class AcUnderlayLayer;
class AcDbUnderlayReference_Impl;
 
class ARX_API AcDbUnderlayReference : public AcDbEntity
{
public:
    ACRX_DECLARE_MEMBERS(AcDbUnderlayReference)
    AcDbUnderlayReference( );
 
public:
    bool  isAdjustedForBackground(void)const ;
    bool  isClipped(void)const ;
    bool  isMonochrome(void)const ;
    bool  isOn(void)const ;
    AcGePoint2dArray const &  clipBoundary(void)const ;
    AcDbObjectId  definitionId(void)const ;
    AcGeMatrix3d  transform(void)const ;
    AcGePoint3d  position(void)const ;
    AcGeScale3d  scaleFactors(void)const ;
    AcGeVector3d  normal(void)const ;
    double  rotation(void)const ;
    Acad::ErrorStatus  getUnderlayLayer(int, AcUnderlayLayer &)const ;
    Acad::ErrorStatus  setClipBoundary( AcGePoint2dArray const &);
    Acad::ErrorStatus  setContrast(unsigned char);
    Acad::ErrorStatus  setDefinitionId( AcDbObjectId);
    Acad::ErrorStatus  setFade(unsigned char);
    Acad::ErrorStatus  setIsAdjustedForBackground(bool);
    Acad::ErrorStatus  setIsClipped(bool);
    Acad::ErrorStatus  setIsMonochrome(bool);
    Acad::ErrorStatus  setIsOn(bool);
    Acad::ErrorStatus  setNormal( AcGeVector3d const &);
    Acad::ErrorStatus  setPosition( AcGePoint3d const &);
    Acad::ErrorStatus  setRotation(double);
    Acad::ErrorStatus  setScaleFactors( AcGeScale3d const &);
    Acad::ErrorStatus  setTransform( AcGeMatrix3d const &);
    Acad::ErrorStatus  setUnderlayLayer(int, AcUnderlayLayer const &);
         
    static unsigned char __cdecl contrastDefault(void);
    static unsigned char __cdecl contrastLowerLimit(void);
    static unsigned char __cdecl contrastUpperLimit(void);
    static unsigned char __cdecl fadeDefault(void);
    static unsigned char __cdecl fadeLowerLimit(void);
    static unsigned char __cdecl fadeUpperLimit(void);
         
    unsigned char  contrast(void)const ;
    unsigned char  fade(void)const ;
    unsigned long  underlayLayerCount(void)const ;
    virtual  ~AcDbUnderlayReference(void);
    virtual bool  isContentSnappable(void)const ;
    virtual bool  isFramePlottable(void)const ;
    virtual bool  isFrameVisible(void)const ;
    Acad::ErrorStatus generateClipBoundaryFromPline(AcDbObjectId);
    Acad::ErrorStatus setWidth(double);
    Acad::ErrorStatus width(double&) const;
    Acad::ErrorStatus setHeight(double);
    Acad::ErrorStatus height(double&) const;
 
private:
    AcDbUnderlayReference_Impl *m_pImpl;
};