measure.h

Go to the documentation of this file.

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CORE_MEASURE_H_INCLUDED_
#define PDFSDK_CORE_MEASURE_H_INCLUDED_
 
#include <pdfsdk/core/api_macro.h>
#include <pdfsdk/core/atoms.h>
#include <pdfsdk/core/objects.h>
#include <pdfsdk/errors.h>
#include <pdfsdk/math_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef PDObject PDMeasure;
 
typedef struct {
    const wchar_t* units;
    float conversionFactor;
    PDAtom fractionalFormat;  // D F R T
    int64_t fractionalDenominator;
    bool fractionalKeepLowZeros;
    const wchar_t* thousandsSeparator;
    const wchar_t* decimalSeparator;
    const wchar_t* prefix;
    const wchar_t* suffix;
    PDAtom unitsPosition;  // S P
} PDNumberFormatParams;
 
typedef struct {
    const wchar_t* ratioString;
    PDNumberFormatParams* xFormat;
    size_t xFormatSize;
    PDNumberFormatParams* yFormat;
    size_t yFormatSize;
    PDNumberFormatParams* distanceFormat;
    size_t distanceFormatSize;
    PDNumberFormatParams* areaFormat;
    size_t areaFormatSize;
    PDNumberFormatParams* angleFormat;
    size_t angleFormatSize;
    PDNumberFormatParams* slopeFormat;
    size_t slopeFormatSize;
    PDPointF origin;
    float cyx;
} PDMeasureRLParams;
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMeasureFormat(PDObject numberFormatArray, float initialValue, wchar_t* buffer, size_t bufSize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMeasureGetSubtype(PDMeasure measure, PDAtom* pSubtype);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMeasureRLCreate(PDDoc doc, const PDMeasureRLParams* params, PDMeasure* pMeasure);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMeasureRLGetRatio(PDMeasure measure, wchar_t* buffer, size_t bufSize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMeasureRLFormatX(PDMeasure measure, float x, wchar_t* buffer, size_t bufSize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMeasureRLFormatY(PDMeasure measure, float y, wchar_t* buffer, size_t bufSize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMeasureRLFormatDistance(PDMeasure measure, const PDPointF* points, size_t npoints, wchar_t* buffer, size_t bufSize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMeasureRLFormatArea(PDMeasure measure, const PDPointF* points, size_t npoints, wchar_t* buffer, size_t bufSize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMeasureRLFormatAngle(PDMeasure measure, float degrees, wchar_t* buffer, size_t bufSize, size_t* pSize);
 
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetNumVPs(PDPage page, size_t* count);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageAddVP(PDPage page, size_t index, PDRectF vpBBox, const wchar_t* buffer, size_t bufSize, PDMeasure measure);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageRemoveVPByIndex(PDPage page, size_t index);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetVPBBox(PDPage page, size_t index, PDRectF* pVPBBox);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetVPName(PDPage page, size_t index, wchar_t* buffer, size_t bufSize, size_t* pSize);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDPageGetVPMeasure(PDPage page, size_t index, PDMeasure* pMeasure);
 
// Measurement Line / Polygon / PolyLine
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotSetMeasure(PDAnnot annot, PDMeasure pMeasure);
PDF_CORE_API PDErrCode PDFSDK_CALLCONV PDMarkupAnnotGetMeasure(PDAnnot annot, PDMeasure* pMeasure);
 
#ifdef __cplusplus
}
#endif
 
#endif  // PDFSDK_CORE_MEASURE_H_INCLUDED_