///////////////////////////////////////////////////////////////////////////////
|
// Copyright (C) 2002-2016, 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 Teigha(R) software pursuant to a license
|
// agreement with Open Design Alliance.
|
// Teigha(R) Copyright (C) 2002-2016 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 __IMGVARS_H
|
#define __IMGVARS_H /*!DOM*/
|
|
#include "TD_PackPush.h"
|
|
class OdDbRasterVariables;
|
|
#include "DbRasterImageDef.h"
|
|
/** \details
|
This template class is a specialization of the OdSmartPtr class for OdDbRasterVariables object pointers.
|
*/
|
typedef OdSmartPtr<OdDbRasterVariables> OdDbRasterVariablesPtr;
|
|
/** \details
|
This class represents RasterVariables objects in an OdDbDatabase instance.
|
|
\sa
|
TD_Db
|
|
\remarks
|
RasterVariables objects contain settings applicable to raster images.
|
A single instance of this class is stored with every OdDbDatabase that contains raster images.
|
|
<group OdDb_Classes>
|
*/
|
class TOOLKIT_EXPORT OdDbRasterVariables : public OdDbObject
|
{
|
public:
|
|
ODDB_DECLARE_MEMBERS(OdDbRasterVariables);
|
|
OdDbRasterVariables();
|
|
enum FrameSettings
|
{
|
kImageFrameInvalid = -1, // Invalid
|
kImageFrameOff = 0, // Frame is off
|
kImageFrameAbove = 1, // Frame is above the image
|
kImageFrameBelow = 2, // Frame is below the image
|
kImageFrameOnNoPlot = 3 // New in R24 (AC24 support)
|
};
|
|
enum ImageQuality
|
{
|
kImageQualityInvalid = -1, // Invalid
|
kImageQualityDraft = 0, // Draft quality
|
kImageQualityHigh = 1 // High quality
|
};
|
|
virtual OdResult dwgInFields(
|
OdDbDwgFiler* pFiler);
|
|
virtual void dwgOutFields(
|
OdDbDwgFiler* pFiler) const;
|
|
virtual OdResult dxfInFields(
|
OdDbDxfFiler* pFiler);
|
|
virtual void dxfOutFields
|
(OdDbDxfFiler* pFiler) const;
|
|
/** \details
|
Returns the image frame display (DXF 70).
|
|
\remarks
|
imageFrame() returns one of the following:
|
|
<table>
|
Name Value Description
|
kImageFrameInvalid -1 Invalid
|
kImageFrameOff 0 Frame is off
|
kImageFrameAbove 1 Frame is above the image
|
kImageFrameBelow 2 Frame is below the image
|
</table>
|
|
*/
|
virtual FrameSettings imageFrame() const;
|
|
/** \details
|
Sets the image frame display (DXF 70).
|
|
\param imageFrame [in] Image frame display.
|
|
\remarks
|
imageFrame must be one of the following:
|
|
<table>
|
Name Value Description
|
kImageFrameOff 0 Frame is off
|
kImageFrameAbove 1 Frame is above the image
|
kImageFrameBelow 2 Frame is below the image
|
</table>
|
*/
|
virtual void setImageFrame(
|
FrameSettings imageFrame );
|
|
/** \details
|
Returns the image display quality (DXF 71).
|
|
\remarks
|
imageQuality() returns one of the following:
|
|
<table>
|
Name Value Description
|
kImageQualityInvalid -1 Invalid
|
kImageQualityDraft 0 Draft quality
|
kImageQualityHigh 1 High quality
|
</table>
|
*/
|
virtual ImageQuality imageQuality() const;
|
|
/** \details
|
Sets the image display quality (DXF 71).
|
\param imageQuality [in] Image Quality.
|
|
\remarks
|
imageQuality must be one of the following:
|
|
<table>
|
Name Value Description
|
kImageQualityInvalid -1 Invalid
|
kImageQualityDraft 0 Draft quality
|
kImageQualityHigh 1 High quality
|
</table>
|
*/
|
virtual void setImageQuality(
|
ImageQuality imageQuality );
|
|
/** \details
|
Returns the real-world units corresponding to drawing units (DXF 72).
|
|
\remarks
|
units() returns one of the following:
|
|
<table>
|
Name Value
|
OdDbRasterImageDef::kNone 0
|
OdDbRasterImageDef::kMillimeter 1
|
OdDbRasterImageDef::kCentimeter 2
|
OdDbRasterImageDef::kMeter 3
|
OdDbRasterImageDef::kKilometer 4
|
OdDbRasterImageDef::kInch 5
|
OdDbRasterImageDef::kFoot 6
|
OdDbRasterImageDef::kYard 7
|
OdDbRasterImageDef::kMile 8
|
OdDbRasterImageDef::kMicroinches 9
|
OdDbRasterImageDef::kMils 10
|
OdDbRasterImageDef::kAngstroms 11
|
OdDbRasterImageDef::kNanometers 12
|
OdDbRasterImageDef::kMicrons 13
|
OdDbRasterImageDef::kDecimeters 14
|
OdDbRasterImageDef::kDekameters 15
|
OdDbRasterImageDef::kHectometers 16
|
OdDbRasterImageDef::kGigameters 17
|
OdDbRasterImageDef::kAstronomical 18
|
OdDbRasterImageDef::kLightYears 19
|
OdDbRasterImageDef::kParsecs 20
|
</table>
|
*/
|
virtual OdDbRasterImageDef::Units userScale() const;
|
|
/** \details
|
Specifies the real-world units corresponding to drawing units (DXF 72).
|
|
\param units [in] Real-world units.
|
|
\remarks
|
units must be one of the following:
|
|
<table>
|
Name Value
|
OdDbRasterImageDef::kNone 0
|
OdDbRasterImageDef::kMillimeter 1
|
OdDbRasterImageDef::kCentimeter 2
|
OdDbRasterImageDef::kMeter 3
|
OdDbRasterImageDef::kKilometer 4
|
OdDbRasterImageDef::kInch 5
|
OdDbRasterImageDef::kFoot 6
|
OdDbRasterImageDef::kYard 7
|
OdDbRasterImageDef::kMile 8
|
OdDbRasterImageDef::kMicroinches 9
|
OdDbRasterImageDef::kMils 10
|
OdDbRasterImageDef::kAngstroms 11
|
OdDbRasterImageDef::kNanometers 12
|
OdDbRasterImageDef::kMicrons 13
|
OdDbRasterImageDef::kDecimeters 14
|
OdDbRasterImageDef::kDekameters 15
|
OdDbRasterImageDef::kHectometers 16
|
OdDbRasterImageDef::kGigameters 17
|
OdDbRasterImageDef::kAstronomical 18
|
OdDbRasterImageDef::kLightYears 19
|
OdDbRasterImageDef::kParsecs 20
|
</table>
|
*/
|
virtual void setUserScale(
|
OdDbRasterImageDef::Units units);
|
|
/** \details
|
Opens the RasterVariables object in the specified database.
|
|
\param openMode [in] Mode in which to open the RasterVariables object.
|
\param pDb [in] Pointer to the database containg the RasterVariables object.
|
|
|
\remarks
|
Returns a SmartPointer to the RasterVariables object.
|
|
Creates a RasterVariables object if one does not exist.
|
*/
|
static OdDbRasterVariablesPtr openRasterVariables(
|
OdDbDatabase* pDb,
|
OdDb::OpenMode openMode = OdDb::kForRead);
|
};
|
|
|
#include "TD_PackPop.h"
|
|
#endif // __IMGVARS_H
|
