length_formatter.h

Go to the documentation of this file.

// Copyright 2017 Trimble Inc. All Rights Reserved.

#ifndef SKETCHUP_LENGTH_FORMATTER_H_
#define SKETCHUP_LENGTH_FORMATTER_H_

#include <SketchUpAPI/defs.h>

#ifdef __cplusplus
extern "C" {
#endif

enum SULengthFormatType {
  SU_LFORMAT_DECIMAL,
  SU_LFORMAT_ARCHITECTURAL,
  SU_LFORMAT_ENGINEERING,
  SU_LFORMAT_FRACTIONAL
};

enum SULengthUnitType {
  SU_LUNIT_INCHES,
  SU_LUNIT_FEET,
  SU_LUNIT_MILLIMETER,
  SU_LUNIT_CENTIMETER,
  SU_LUNIT_METER,
  SU_LUNIT_YARD
};

enum SUAreaUnitType {
  SU_AUNIT_SQUARE_INCHES,
  SU_AUNIT_SQUARE_FEET,
  SU_AUNIT_SQUARE_MILLIMETER,
  SU_AUNIT_SQUARE_CENTIMETER,
  SU_AUNIT_SQUARE_METER,
  SU_AUNIT_SQUARE_YARD
};

enum SUVolumeUnitType {
  SU_VUNIT_CUBIC_INCHES,
  SU_VUNIT_CUBIC_FEET,
  SU_VUNIT_CUBIC_MILLIMETER,
  SU_VUNIT_CUBIC_CENTIMETER,
  SU_VUNIT_CUBIC_METER,
  SU_VUNIT_CUBIC_YARD,
  SU_VUNIT_LITER,
  SU_VUNIT_US_GALLON
};

SU_RESULT SULengthFormatterCreate(SULengthFormatterRef* formatter);

SU_RESULT SULengthFormatterRelease(SULengthFormatterRef* formatter);

SU_RESULT SULengthFormatterGetPrecision(SULengthFormatterRef formatter, size_t* precision);

SU_RESULT SULengthFormatterSetPrecision(SULengthFormatterRef formatter, size_t precision);

SU_RESULT SULengthFormatterGetAreaPrecision(SULengthFormatterRef formatter, size_t* precision);

SU_RESULT SULengthFormatterSetAreaPrecision(SULengthFormatterRef formatter, size_t precision);

SU_RESULT SULengthFormatterGetVolumePrecision(SULengthFormatterRef formatter, size_t* precision);

SU_RESULT SULengthFormatterSetVolumePrecision(SULengthFormatterRef formatter, size_t precision);

SU_RESULT SULengthFormatterGetFormat(
    SULengthFormatterRef formatter, enum SULengthFormatType* format);

SU_RESULT SULengthFormatterSetFormat(
    SULengthFormatterRef formatter, enum SULengthFormatType format);

SU_RESULT SULengthFormatterGetUnits(SULengthFormatterRef formatter, enum SULengthUnitType* units);

SU_RESULT SULengthFormatterGetAreaUnits(SULengthFormatterRef formatter, enum SUAreaUnitType* units);

SU_RESULT SULengthFormatterGetVolumeUnits(
    SULengthFormatterRef formatter, enum SUVolumeUnitType* units);

SU_RESULT SULengthFormatterSetUnits(SULengthFormatterRef formatter, enum SULengthUnitType units);

SU_RESULT SULengthFormatterSetAreaUnits(SULengthFormatterRef formatter, enum SUAreaUnitType units);

SU_RESULT SULengthFormatterSetVolumeUnits(
    SULengthFormatterRef formatter, enum SUVolumeUnitType units);

SU_RESULT SULengthFormatterGetSuppressUnits(SULengthFormatterRef formatter, bool* suppress);

SU_RESULT SULengthFormatterSetSuppressUnits(SULengthFormatterRef formatter, bool suppress);

SU_RESULT SULengthFormatterGetLengthString(
    SULengthFormatterRef formatter, double length, bool strip, SUStringRef* string);

SU_RESULT SULengthFormatterGetAreaString(
    SULengthFormatterRef formatter, double area, SUStringRef* string);

SU_RESULT SULengthFormatterGetVolumeString(
    SULengthFormatterRef formatter, double volume, SUStringRef* string);

SU_RESULT SULengthFormatterParseString(
    SULengthFormatterRef formatter, SUStringRef string, double* value);

SU_RESULT SULengthFormatterSetForceInchDisplay(SULengthFormatterRef formatter, bool force_inch);

SU_RESULT SULengthFormatterGetForceInchDisplay(SULengthFormatterRef formatter, bool* force_inch);

#ifdef __cplusplus
}  // extern "C"
#endif

#endif  // SKETCHUP_LENGTH_FORMATTER_H_