LayOut C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
style.h
Go to the documentation of this file.
1 // Copyright 2015 Trimble Navigation Ltd. All rights reserved.
2 // This file is intended for public distribution.
3 
4 #ifndef LAYOUT_MODEL_STYLE_H_
5 #define LAYOUT_MODEL_STYLE_H_
6 
7 #include <LayOutAPI/common.h>
8 #include <LayOutAPI/model/defs.h>
9 
27 typedef enum {
28  LOStrokeJoinStyle_Miter = 0,
29  LOStrokeJoinStyle_Round,
30  LOStrokeJoinStyle_Bevel,
31  LONumStrokeJoinStyles
32 } LOStrokeJoinStyle;
33 
38 typedef enum {
39  LOStrokeCapStyle_Flat = 0,
40  LOStrokeCapStyle_Round,
41  LOStrokeCapStyle_Square,
42  LONumStrokeCapStyles
43 } LOStrokeCapStyle;
44 
49 typedef enum {
50  LOStrokePattern_Solid = 0,
51  LOStrokePattern_Dash,
52  LOStrokePattern_Dot,
53  LOStrokePattern_DashDot,
54  LOStrokePattern_DashDotDot,
55  LOStrokePattern_DashSpace,
56  LOStrokePattern_DashDotDotDot,
57  LOStrokePattern_DashDashDot,
58  LOStrokePattern_DashDashDotDot,
59  LOStrokePattern_DashDashDotDotDot,
60  LOStrokePattern_Center,
61  LOStrokePattern_Phantom,
62  LOStrokePattern_ShortDash,
63  LONumStrokePatterns
64 } LOStrokePattern;
65 
70 typedef enum {
71  LOTextUnderline_None = 0,
72  LOTextUnderline_Single,
73  LOTextUnderline_Double,
74  LONumTextUnderlines
75 } LOTextUnderline;
76 
81 typedef enum {
82  LOTextElevation_Normal = 0,
83  LOTextElevation_Superscript,
84  LOTextElevation_Subscript,
85  LONumTextElevations
86 } LOTextElevation;
87 
92 typedef enum {
93  LOTextAlignment_Left = 0,
94  LOTextAlignment_Right,
95  LOTextAlignment_Center,
96  LONumTextAlignments
97 } LOTextAlignment;
98 
103 typedef enum {
104  LOTextAnchor_Top = 0,
105  LOTextAnchor_Center,
106  LOTextAnchor_Bottom,
107  LONumTextAnchors
108 } LOTextAnchor;
109 
114 typedef enum {
115  LODimensionRotationAlignment_Horizontal = 0,
116  LODimensionRotationAlignment_Vertical,
117  LODimensionRotationAlignment_Align,
118  LODimensionRotationAlignment_Perpendicular,
119  LONumDimensionRotationAlignments
120 } LODimensionRotationAlignment;
121 
128 typedef enum {
129  LODimensionVerticalAlignment_Above = 0,
130  LODimensionVerticalAlignment_Center,
131  LODimensionVerticalAlignment_Below,
132  LODimensionVerticalAlignment_Offset,
133  LONumDimensionVerticalAlignments
134 } LODimensionVerticalAlignment;
135 
141 typedef enum {
142  // Linear dimension units
143  LODimensionUnits_FractionalInches = 0,
144  LODimensionUnits_ArchitecturalInches,
145  LODimensionUnits_EngineeringFeet,
146  LODimensionUnits_DecimalInches,
147  LODimensionUnits_DecimalFeet,
148  LODimensionUnits_DecimalMillimeters,
149  LODimensionUnits_DecimalCentimeters,
150  LODimensionUnits_DecimalMeters,
151  LODimensionUnits_DecimalPoints,
152 
153  // Angular dimension units
154  LODimensionUnits_Degrees,
155  LODimensionUnits_Radians,
156 
157  LONumDimensionUnits
158 } LODimensionUnits;
159 
160 
161 
166 typedef enum {
167  LOArrowType_None = 0,
168  LOArrowType_FilledTriangle,
169  LOArrowType_OpenTriangle,
170  LOArrowType_FilledSkinnyTriangle,
171  LOArrowType_OpenSkinnyTriangle,
172  LOArrowType_OpenArrow90,
173  LOArrowType_OpenArrow120,
174  LOArrowType_FilledCircle,
175  LOArrowType_OpenCircle,
176  LOArrowType_FilledSquare,
177  LOArrowType_OpenSquare,
178  LOArrowType_FilledDiamond,
179  LOArrowType_OpenDiamond,
180  LOArrowType_Star,
181  LOArrowType_T,
182  LOArrowType_SlashRight,
183  LOArrowType_SlashLeft,
184  LOArrowType_Underrun,
185  LOArrowType_Overrun,
186  LONumArrowTypes
187 } LOArrowType;
188 
194 typedef enum {
195  LOSubEntityType_LabelLeaderLine = 0,
196  LOSubEntityType_LabelText,
197  LOSubEntityType_DimensionStartExtensionLine,
198  LOSubEntityType_DimensionEndExtensionLine,
199  LOSubEntityType_DimensionDimensionLine,
200  LOSubEntityType_DimensionLeaderLine,
201  LOSubEntityType_DimensionText,
202  LONumSubEntityTypes
203 } LOSubEntityType;
204 
205 #include "entity.h"
206 #include <SketchUpAPI/color.h>
207 
208 #ifdef __cplusplus
209 extern "C" {
210 #endif // __cplusplus
211 
220 LO_RESULT LOStyleCreate(LOStyleRef* style);
221 
230 LO_RESULT LOStyleRelease(LOStyleRef* style);
231 
241 LO_RESULT LOStyleCopy(LOStyleRef src_style, LOStyleRef dst_style);
242 
254 LO_RESULT LOStyleGetStroked(LOStyleRef style, bool* is_stroked);
255 
264 LO_RESULT LOStyleSetStroked(LOStyleRef style, bool is_stroked);
265 
277 LO_RESULT LOStyleGetStrokeWidth(LOStyleRef style, double* stroke_width);
278 
288 LO_RESULT LOStyleSetStrokeWidth(LOStyleRef style, double stroke_width);
289 
301 LO_RESULT LOStyleGetStrokeColor(LOStyleRef style,
302  SUColor* stroke_color);
303 
312 LO_RESULT LOStyleSetStrokeColor(LOStyleRef style, SUColor stroke_color);
313 
325 LO_RESULT LOStyleGetStrokeJoinStyle(LOStyleRef style,
326  LOStrokeJoinStyle* join_type);
327 
337 LO_RESULT LOStyleSetStrokeJoinStyle(LOStyleRef style,
338  LOStrokeJoinStyle join_type);
339 
351 LO_RESULT LOStyleGetStrokeCapStyle(LOStyleRef style,
352  LOStrokeCapStyle* cap_type);
353 
363 LO_RESULT LOStyleSetStrokeCapStyle(LOStyleRef style,
364  LOStrokeCapStyle cap_type);
365 
377 LO_RESULT LOStyleGetStrokePattern(LOStyleRef style,
378  LOStrokePattern* stroke_pattern);
379 
389 LO_RESULT LOStyleSetStrokePattern(LOStyleRef style,
390  LOStrokePattern stroke_pattern);
391 
403 LO_RESULT LOStyleGetStrokePatternScale(LOStyleRef style,
404  double* pattern_scale);
405 
416 LO_RESULT LOStyleSetStrokePatternScale(LOStyleRef style,
417  double pattern_scale);
418 
430 LO_RESULT LOStyleGetSolidFilled(LOStyleRef style, bool* solid_filled);
431 
440 LO_RESULT LOStyleSetSolidFilled(LOStyleRef style, bool solid_filled);
441 
453 LO_RESULT LOStyleGetSolidFillColor(LOStyleRef style, SUColor* fill_color);
454 
463 LO_RESULT LOStyleSetSolidFillColor(LOStyleRef style, SUColor fill_color);
464 
476 LO_RESULT LOStyleGetPatternFilled(LOStyleRef style, bool* pattern_filled);
477 
486 LO_RESULT LOStyleSetPatternFilled(LOStyleRef style, bool pattern_filled);
487 
502 LO_RESULT LOStyleGetPatternFillImagePath(LOStyleRef style,
503  SUStringRef* image_path);
504 
516 LO_RESULT LOStyleSetPatternFillImagePath(LOStyleRef style,
517  const char* image_path);
518 
530 LO_RESULT LOStyleGetPatternFillRotation(LOStyleRef style, double* rotation);
531 
541 LO_RESULT LOStyleSetPatternFillRotation(LOStyleRef style, double rotation);
542 
554 LO_RESULT LOStyleGetPatternFillScale(LOStyleRef style, double* scale);
555 
567 LO_RESULT LOStyleSetPatternFillScale(LOStyleRef style, double scale);
568 
580 LO_RESULT LOStyleGetPatternFillOrigin(LOStyleRef style,
581  LOPoint2D* origin);
582 
592 LO_RESULT LOStyleSetPatternFillOrigin(LOStyleRef style,
593  const LOPoint2D* origin);
594 
607 LO_RESULT LOStyleGetTextFontFamily(LOStyleRef style,
608  SUStringRef* family);
609 
619 LO_RESULT LOStyleSetTextFontFamily(LOStyleRef style,
620  const char* family);
621 
633 LO_RESULT LOStyleGetTextBold(LOStyleRef style, bool* is_bold);
634 
643 LO_RESULT LOStyleSetTextBold(LOStyleRef style, bool is_bold);
644 
656 LO_RESULT LOStyleGetTextItalic(LOStyleRef style, bool* is_italic);
657 
666 LO_RESULT LOStyleSetTextItalic(LOStyleRef style, bool is_italic);
667 
679 LO_RESULT LOStyleGetFontSize(LOStyleRef style, double* size_in_points);
680 
691 LO_RESULT LOStyleSetFontSize(LOStyleRef style, double size_in_points);
692 
704 LO_RESULT LOStyleGetTextColor(LOStyleRef style, SUColor* color);
705 
714 LO_RESULT LOStyleSetTextColor(LOStyleRef style, SUColor color);
715 
727 LO_RESULT LOStyleGetTextUnderline(LOStyleRef style,
728  LOTextUnderline* underline_type);
729 
739 LO_RESULT LOStyleSetTextUnderline(LOStyleRef style,
740  LOTextUnderline underline_type);
741 
754 LO_RESULT LOStyleGetTextElevation(LOStyleRef style,
755  LOTextElevation* elevation_type);
756 
766 LO_RESULT LOStyleSetTextElevation(LOStyleRef style,
767  LOTextElevation elevation_type);
768 
780 LO_RESULT LOStyleGetTextAlignment(LOStyleRef style,
781  LOTextAlignment* alignment_type);
782 
792 LO_RESULT LOStyleSetTextAlignment(LOStyleRef style,
793  LOTextAlignment alignment_type);
794 
806 LO_RESULT LOStyleGetTextAnchor(LOStyleRef style,
807  LOTextAnchor* anchor_type);
808 
818 LO_RESULT LOStyleSetTextAnchor(LOStyleRef style,
819  LOTextAnchor anchor_type);
820 
832 LO_RESULT LOStyleGetDimensionRotationAlignment(
833  LOStyleRef style,
834  LODimensionRotationAlignment* alignment);
835 
845 LO_RESULT LOStyleSetDimensionRotationAlignment(
846  LOStyleRef style,
847  LODimensionRotationAlignment alignment);
848 
860 LO_RESULT LOStyleGetDimensionVerticalAlignment(
861  LOStyleRef style,
862  LODimensionVerticalAlignment* alignment);
863 
875 LO_RESULT LOStyleSetDimensionVerticalAlignment(
876  LOStyleRef style,
877  LODimensionVerticalAlignment alignment);
878 
893 LO_RESULT LOStyleGetDimensionUnits(LOStyleRef style,
894  LODimensionUnits* units,
895  double* precision);
896 
913 LO_RESULT LOStyleSetDimensionUnits(LOStyleRef style,
914  LODimensionUnits units,
915  double precision);
916 
928 LO_RESULT LOStyleGetSuppressDimensionUnits(LOStyleRef style,
929  bool* is_suppressed);
930 
939 LO_RESULT LOStyleSetSuppressDimensionUnits(LOStyleRef style,
940  bool is_suppressed);
941 
942 
943 
944 
945 
955 LO_RESULT LOStrokePatternGetMaximumNumberOfWidths(size_t* num_widths);
956 
974 LO_RESULT LOStrokePatternGetWidths(LOStrokePattern stroke_pattern,
975  size_t len,
976  double widths[],
977  size_t* num_widths);
978 
989 LO_RESULT LOStyleGetStartArrowType(LOStyleRef style,
990  LOArrowType* type);
991 
1001 LO_RESULT LOStyleSetStartArrowType(LOStyleRef style,
1002  LOArrowType type);
1003 
1014 LO_RESULT LOStyleGetStartArrowSize(LOStyleRef style,
1015  double* size);
1016 
1026 LO_RESULT LOStyleSetStartArrowSize(LOStyleRef style,
1027  double size);
1028 
1039 LO_RESULT LOStyleGetEndArrowType(LOStyleRef style,
1040  LOArrowType* type);
1041 
1051 LO_RESULT LOStyleSetEndArrowType(LOStyleRef style,
1052  LOArrowType type);
1053 
1064 LO_RESULT LOStyleGetEndArrowSize(LOStyleRef style,
1065  double* size);
1066 
1076 LO_RESULT LOStyleSetEndArrowSize(LOStyleRef style,
1077  double size);
1078 
1088 LO_RESULT LOStyleIsArrowTypeFilled(LOArrowType type,
1089  bool* filled);
1090 
1103 LO_RESULT LOStyleSetSubEntityStyle(LOStyleRef style,
1104  LOSubEntityType type,
1105  LOStyleRef sub_style);
1106 
1120 LO_RESULT LOStyleGetSubEntityStyle(LOStyleRef style,
1121  LOSubEntityType type,
1122  LOStyleRef* sub_style);
1123 
1124 #ifdef __cplusplus
1125 } // end extern "C"
1126 #endif // __cplusplus
1127 #endif // LAYOUT_MODEL_STYLE_H_
1128 
Generated on Wed Sep 8 2021 14:15:26 for LayOut C API by   doxygen 1.8.3.1