path.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_PATH_H_
#define LAYOUT_MODEL_PATH_H_

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

typedef enum {
  LOPathPointType_MoveTo = 0,    
  LOPathPointType_LineTo,        
  LOPathPointType_BezierTo,      
  LOPathPointType_ArcCenter,     
  LOPathPointType_BezierControl, 
  LOPathPointType_Close,         
  LONumPathPointTypes
} LOPathPointType;

typedef enum {
  LOPathWindingType_None = 0,
  LOPathWindingType_Clockwise,
  LOPathWindingType_CounterClockwise,
  LONumPathWindingTypes
} LOPathWindingType;

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

LO_RESULT LOPathCreate(LOPathRef* path,
                       const LOPoint2D* start_point,
                       const LOPoint2D* end_point);

LO_RESULT LOPathCreateBezier(LOPathRef* path,
                             const LOPoint2D* start_point,
                             const LOPoint2D* control_point_1,
                             const LOPoint2D* control_point_2,
                             const LOPoint2D* end_point);

LO_RESULT LOPathCreateFromRectangle(LOPathRef* path, LORectangleRef rectangle);

LO_RESULT LOPathCreateFromEllipse(LOPathRef* path, LOEllipseRef ellipse);

LO_RESULT LOPathCreateArc(LOPathRef* path, const LOPoint2D* center_point,
    double radius, double start_angle, double end_angle);

LO_RESULT LOPathAddReference(LOPathRef path);

LO_RESULT LOPathRelease(LOPathRef* path);

LO_EXPORT LOPathRef LOPathFromEntity(LOEntityRef entity);

LO_EXPORT LOEntityRef LOPathToEntity(LOPathRef path);

LO_RESULT LOPathGetNumberOfPoints(LOPathRef path, size_t* size);

LO_RESULT LOPathGetPoints(LOPathRef path,
                          size_t points_size,
                          LOPoint2D points[],
                          size_t* number_of_points_copied);

LO_RESULT LOPathGetPointAtIndex(LOPathRef path,
                                size_t point_index,
                                LOPoint2D* point);

LO_RESULT LOPathGetPointTypes(LOPathRef path,
                              size_t pointtypes_size,
                              LOPathPointType pointtypes[],
                              size_t* number_of_pointtypes_copied);

LO_RESULT LOPathGetPointTypeAtIndex(LOPathRef path,
                                    size_t point_index,
                                    LOPathPointType* pointtype);

LO_RESULT LOPathGetStartPoint(LOPathRef path,
                              LOPoint2D* point);

LO_RESULT LOPathGetEndPoint(LOPathRef path,
                            LOPoint2D* point);

LO_RESULT LOPathCreateFromStartArrow(LOPathRef* arrow_path,
                                     LOPathRef path);

LO_RESULT LOPathCreateFromEndArrow(LOPathRef* arrow_path,
                                   LOPathRef path);

LO_RESULT LOPathGetClosed(LOPathRef path,
                          bool* is_closed);

LO_RESULT LOPathGetParametricLength(LOPathRef path,
                                    double* parametric_length);

LO_RESULT LOPathGetPointAtParameter(LOPathRef path,
                                    double parametric_value,
                                    LOPoint2D* point);

LO_RESULT LOPathGetTangentAtParameter(LOPathRef path,
                                      double parametric_value,
                                      LOVector2D* tangent);

LO_RESULT LOPathGetCircle(LOPathRef path, bool* is_circle, LOPoint2D* center,
    double* radius);

LO_RESULT LOPathGetArc(LOPathRef path, bool* is_arc, LOPoint2D* center,
    double* radius, double* start_angle, double* end_angle);
  
LO_RESULT LOPathAppendLineTo(LOPathRef path, const LOPoint2D* point);

LO_RESULT LOPathAppendBezierTo(LOPathRef path,
                               const LOPoint2D* control_point_1,
                               const LOPoint2D* control_point_2,
                               const LOPoint2D* point);

LO_RESULT LOPathAppendPathTo(LOPathRef path, LOPathRef other_path);

LO_RESULT LOPathClose(LOPathRef path);

LO_RESULT LOPathGetWindingType(LOPathRef path, LOPathWindingType* winding);

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