lineardimension.h

Go to the documentation of this file.

// Copyright 2015 Trimble Navigation Ltd. All rights reserved.
// This file is intended for public distribution.

#ifndef LAYOUT_MODEL_LINEARDIMENSION_H_
#define LAYOUT_MODEL_LINEARDIMENSION_H_

#include <LayOutAPI/common.h>
#include <LayOutAPI/geometry/geometry.h>
#include <LayOutAPI/model/defs.h>

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

typedef enum {
  LOLinearDimensionLeaderLineType_SingleSegment = 0, 
  LOLinearDimensionLeaderLineType_TwoSegment,        
  LOLinearDimensionLeaderLineType_Bezier,            
  LOLinearDimensionLeaderLineType_Hidden,            
  LONumLinearDimensionLeaderLineTypes
} LOLinearDimensionLeaderLineType;

LO_RESULT LOLinearDimensionCreate(LOLinearDimensionRef* dimension,
                                  const LOPoint2D* start_point,
                                  const LOPoint2D* end_point,
                                  double height);

LO_RESULT LOLinearDimensionAddReference(LOLinearDimensionRef dimension);

LO_RESULT LOLinearDimensionRelease(LOLinearDimensionRef* dimension);

LO_EXPORT LOLinearDimensionRef LOLinearDimensionFromEntity(LOEntityRef entity);

LO_EXPORT LOEntityRef LOLinearDimensionToEntity(LOLinearDimensionRef dimension);

LO_RESULT LOLinearDimensionGetExplodedEntities(LOLinearDimensionRef dimension,
                                               LOEntityListRef entity_list);

LO_RESULT LOLinearDimensionGetUsesCustomText(LOLinearDimensionRef dimension,
                                             bool* use_custom_text);

LO_RESULT LOLinearDimensionSetUsesCustomText(LOLinearDimensionRef dimension,
                                             bool use_custom_text);

LO_RESULT LOLinearDimensionCreateDimensionTextCopy(
    LOLinearDimensionRef dimension,
    LOFormattedTextRef* text);

LO_RESULT LOLinearDimensionSetDimensionText(LOLinearDimensionRef dimension,
                                            LOFormattedTextRef text);

LO_RESULT LOLinearDimensionGetLeaderLineType(
    LOLinearDimensionRef dimension,
    LOLinearDimensionLeaderLineType* leader_line_type);

LO_RESULT LOLinearDimensionSetLeaderLineType(
    LOLinearDimensionRef dimension,
    LOLinearDimensionLeaderLineType leader_line_type);

LO_RESULT LOLinearDimensionGetUsesAutoScale(LOLinearDimensionRef dimension,
                                            bool* use_auto_scale);

LO_RESULT LOLinearDimensionSetUsesAutoScale(LOLinearDimensionRef dimension,
                                            bool use_auto_scale);

LO_RESULT LOLinearDimensionGetScale(LOLinearDimensionRef dimension,
                                    double* scale);

LO_RESULT LOLinearDimensionSetScale(LOLinearDimensionRef dimension,
                                    double scale);

LO_RESULT LOLinearDimensionGetStartConnectionPoint(
    LOLinearDimensionRef dimension,
    LOPoint2D* point);

LO_RESULT LOLinearDimensionSetStartConnectionPoint(
    LOLinearDimensionRef dimension,
    LOPoint2D* point);

LO_RESULT LOLinearDimensionGetEndConnectionPoint(
    LOLinearDimensionRef dimension,
    LOPoint2D* point);

LO_RESULT LOLinearDimensionSetEndConnectionPoint(
    LOLinearDimensionRef dimension,
    LOPoint2D* point);

LO_RESULT LOLinearDimensionGetStartExtentPoint(LOLinearDimensionRef dimension,
                                               LOPoint2D* point);

LO_RESULT LOLinearDimensionSetStartExtentPoint(LOLinearDimensionRef dimension,
                                               LOPoint2D* point);

LO_RESULT LOLinearDimensionGetEndExtentPoint(LOLinearDimensionRef dimension,
                                             LOPoint2D* point);

LO_RESULT LOLinearDimensionSetEndExtentPoint(LOLinearDimensionRef dimension,
                                             LOPoint2D* point);

LO_RESULT LOLinearDimensionGetStartOffsetPoint(LOLinearDimensionRef dimension,
                                               LOPoint2D* point);

LO_RESULT LOLinearDimensionGetEndOffsetPoint(LOLinearDimensionRef dimension,
                                             LOPoint2D* point);

LO_RESULT LOLinearDimensionSetStartOffsetLength(
    LOLinearDimensionRef dimension,
    double length);

LO_RESULT LOLinearDimensionSetEndOffsetLength(
    LOLinearDimensionRef dimension,
    double length);

LO_RESULT LOLinearDimensionConnectTo(LOLinearDimensionRef dimension,
                                     LOConnectionPointRef start_point,
                                     LOConnectionPointRef end_point);

LO_RESULT LOLinearDimensionDisconnect(LOLinearDimensionRef dimension);

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

#endif // LAYOUT_MODEL_LINEARDIMENSION_H_