style.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_STYLE_H_
#define LAYOUT_MODEL_STYLE_H_

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

typedef enum {
  LOStrokeJoinStyle_Miter = 0,  
  LOStrokeJoinStyle_Round,      
  LOStrokeJoinStyle_Bevel,      
  LONumStrokeJoinStyles
} LOStrokeJoinStyle;

typedef enum {
  LOStrokeCapStyle_Flat = 0,  
  LOStrokeCapStyle_Round,     
  LOStrokeCapStyle_Square,    
  LONumStrokeCapStyles
} LOStrokeCapStyle;

typedef enum {
  LOStrokePattern_Solid = 0,          
  LOStrokePattern_Dash,               
  LOStrokePattern_Dot,                
  LOStrokePattern_DashDot,            
  LOStrokePattern_DashDotDot,         
  LOStrokePattern_DashSpace,          
  LOStrokePattern_DashDotDotDot,      
  LOStrokePattern_DashDashDot,        
  LOStrokePattern_DashDashDotDot,     
  LOStrokePattern_DashDashDotDotDot,  
  LOStrokePattern_Center,             
  LOStrokePattern_Phantom,            
  LOStrokePattern_ShortDash,          
  LONumStrokePatterns
} LOStrokePattern;

typedef enum {
  LOTextUnderline_None = 0,  
  LOTextUnderline_Single,    
  LOTextUnderline_Double,    
  LONumTextUnderlines
} LOTextUnderline;

typedef enum {
  LOTextStrikeThrough_None = 0,  
  LOTextStrikeThrough_Single,    
  LONumTextStrikeThroughs
} LOTextStrikeThrough;

typedef enum {
  LOTextElevation_Normal = 0,   
  LOTextElevation_Superscript,  
  LOTextElevation_Subscript,    
  LONumTextElevations
} LOTextElevation;

typedef enum {
  LOTextAlignment_Left = 0,  
  LOTextAlignment_Right,     
  LOTextAlignment_Center,    
  LONumTextAlignments
} LOTextAlignment;

typedef enum {
  LOTextAnchor_Top = 0,  
  LOTextAnchor_Center,   
  LOTextAnchor_Bottom,   
  LONumTextAnchors
} LOTextAnchor;

typedef enum {
  LODimensionRotationAlignment_Horizontal = 0,  
  LODimensionRotationAlignment_Vertical,        
  LODimensionRotationAlignment_Align,           
  LODimensionRotationAlignment_Perpendicular,   

  LONumDimensionRotationAlignments
} LODimensionRotationAlignment;

typedef enum {
  LODimensionVerticalAlignment_Above = 0,  
  LODimensionVerticalAlignment_Center,     
  LODimensionVerticalAlignment_Below,      
  LODimensionVerticalAlignment_Offset,     
  LONumDimensionVerticalAlignments
} LODimensionVerticalAlignment;

typedef enum {
  // Linear dimension units
  LODimensionUnits_FractionalInches = 0,  
  LODimensionUnits_ArchitecturalInches,   
  LODimensionUnits_EngineeringFeet,       
  LODimensionUnits_DecimalInches,         
  LODimensionUnits_DecimalFeet,           
  LODimensionUnits_DecimalMillimeters,    
  LODimensionUnits_DecimalCentimeters,    
  LODimensionUnits_DecimalMeters,         
  LODimensionUnits_DecimalPoints,         

  // Angular dimension units
  LODimensionUnits_Degrees,  
  LODimensionUnits_Radians,  

  LONumDimensionUnits
} LODimensionUnits;



typedef enum {
  LOArrowType_None = 0,              
  LOArrowType_FilledTriangle,        
  LOArrowType_OpenTriangle,          
  LOArrowType_FilledSkinnyTriangle,  
  LOArrowType_OpenSkinnyTriangle,    
  LOArrowType_OpenArrow90,           
  LOArrowType_OpenArrow120,          
  LOArrowType_FilledCircle,          
  LOArrowType_OpenCircle,            
  LOArrowType_FilledSquare,          
  LOArrowType_OpenSquare,            
  LOArrowType_FilledDiamond,         
  LOArrowType_OpenDiamond,           
  LOArrowType_Star,                  
  LOArrowType_T,                     
  LOArrowType_SlashRight,            
  LOArrowType_SlashLeft,             
  LOArrowType_Underrun,              
  LOArrowType_Overrun,               
  LONumArrowTypes
} LOArrowType;

typedef enum {
  LOSubEntityType_LabelLeaderLine = 0,          
  LOSubEntityType_LabelText,                    
  LOSubEntityType_DimensionStartExtensionLine,  
  LOSubEntityType_DimensionEndExtensionLine,    
  LOSubEntityType_DimensionDimensionLine,       
  LOSubEntityType_DimensionLeaderLine,          
  LOSubEntityType_DimensionText,                
  LONumSubEntityTypes
} LOSubEntityType;

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

LO_RESULT LOStyleCreate(LOStyleRef* style);

LO_RESULT LOStyleRelease(LOStyleRef* style);

LO_RESULT LOStyleCopy(LOStyleRef src_style, LOStyleRef dst_style);

LO_RESULT LOStyleGetStroked(LOStyleRef style, bool* is_stroked);

LO_RESULT LOStyleSetStroked(LOStyleRef style, bool is_stroked);

LO_RESULT LOStyleGetStrokeWidth(LOStyleRef style, double* stroke_width);

LO_RESULT LOStyleSetStrokeWidth(LOStyleRef style, double stroke_width);

LO_RESULT LOStyleGetStrokeColor(LOStyleRef style, SUColor* stroke_color);

LO_RESULT LOStyleSetStrokeColor(LOStyleRef style, SUColor stroke_color);

LO_RESULT LOStyleGetStrokeJoinStyle(LOStyleRef style, LOStrokeJoinStyle* join_type);

LO_RESULT LOStyleSetStrokeJoinStyle(LOStyleRef style, LOStrokeJoinStyle join_type);

LO_RESULT LOStyleGetStrokeCapStyle(LOStyleRef style, LOStrokeCapStyle* cap_type);

LO_RESULT LOStyleSetStrokeCapStyle(LOStyleRef style, LOStrokeCapStyle cap_type);

LO_RESULT LOStyleGetStrokePattern(LOStyleRef style, LOStrokePattern* stroke_pattern);

LO_RESULT LOStyleSetStrokePattern(LOStyleRef style, LOStrokePattern stroke_pattern);

LO_RESULT LOStyleGetStrokePatternScale(LOStyleRef style, double* pattern_scale);

LO_RESULT LOStyleSetStrokePatternScale(LOStyleRef style, double pattern_scale);

LO_RESULT LOStyleGetSolidFilled(LOStyleRef style, bool* solid_filled);

LO_RESULT LOStyleSetSolidFilled(LOStyleRef style, bool solid_filled);

LO_RESULT LOStyleGetSolidFillColor(LOStyleRef style, SUColor* fill_color);

LO_RESULT LOStyleSetSolidFillColor(LOStyleRef style, SUColor fill_color);

LO_RESULT LOStyleGetPatternFilled(LOStyleRef style, bool* pattern_filled);

LO_RESULT LOStyleSetPatternFilled(LOStyleRef style, bool pattern_filled);

LO_RESULT LOStyleGetPatternFillImagePath(LOStyleRef style, SUStringRef* image_path);

LO_RESULT LOStyleSetPatternFillImagePath(LOStyleRef style, const char* image_path);

LO_RESULT LOStyleGetPatternFillRotation(LOStyleRef style, double* rotation);

LO_RESULT LOStyleSetPatternFillRotation(LOStyleRef style, double rotation);

LO_RESULT LOStyleGetPatternFillScale(LOStyleRef style, double* scale);

LO_RESULT LOStyleSetPatternFillScale(LOStyleRef style, double scale);

LO_RESULT LOStyleGetPatternFillOrigin(LOStyleRef style, LOPoint2D* origin);

LO_RESULT LOStyleSetPatternFillOrigin(LOStyleRef style, const LOPoint2D* origin);

LO_RESULT LOStyleGetTextFontFamily(LOStyleRef style, SUStringRef* family);

LO_RESULT LOStyleSetTextFontFamily(LOStyleRef style, const char* family);

LO_RESULT LOStyleGetTextBold(LOStyleRef style, bool* is_bold);

LO_RESULT LOStyleSetTextBold(LOStyleRef style, bool is_bold);

LO_RESULT LOStyleGetTextItalic(LOStyleRef style, bool* is_italic);

LO_RESULT LOStyleSetTextItalic(LOStyleRef style, bool is_italic);

LO_RESULT LOStyleGetFontSize(LOStyleRef style, double* size_in_points);

LO_RESULT LOStyleSetFontSize(LOStyleRef style, double size_in_points);

LO_RESULT LOStyleGetTextColor(LOStyleRef style, SUColor* color);

LO_RESULT LOStyleSetTextColor(LOStyleRef style, SUColor color);

LO_RESULT LOStyleGetTextUnderline(LOStyleRef style, LOTextUnderline* underline_type);

LO_RESULT LOStyleSetTextUnderline(LOStyleRef style, LOTextUnderline underline_type);

LO_RESULT LOStyleGetTextStrikeThrough(LOStyleRef style, LOTextStrikeThrough* strikethrough_type);

LO_RESULT LOStyleSetTextStrikeThrough(LOStyleRef style, LOTextStrikeThrough strikethrough_type);

LO_RESULT LOStyleGetTextElevation(LOStyleRef style, LOTextElevation* elevation_type);

LO_RESULT LOStyleSetTextElevation(LOStyleRef style, LOTextElevation elevation_type);

LO_RESULT LOStyleGetTextAlignment(LOStyleRef style, LOTextAlignment* alignment_type);

LO_RESULT LOStyleSetTextAlignment(LOStyleRef style, LOTextAlignment alignment_type);

LO_RESULT LOStyleGetTextAnchor(LOStyleRef style, LOTextAnchor* anchor_type);

LO_RESULT LOStyleSetTextAnchor(LOStyleRef style, LOTextAnchor anchor_type);

LO_RESULT LOStyleGetDimensionRotationAlignment(
    LOStyleRef style, LODimensionRotationAlignment* alignment);

LO_RESULT LOStyleSetDimensionRotationAlignment(
    LOStyleRef style, LODimensionRotationAlignment alignment);

LO_RESULT LOStyleGetDimensionVerticalAlignment(
    LOStyleRef style, LODimensionVerticalAlignment* alignment);

LO_RESULT LOStyleSetDimensionVerticalAlignment(
    LOStyleRef style, LODimensionVerticalAlignment alignment);

LO_RESULT LOStyleGetDimensionUnits(LOStyleRef style, LODimensionUnits* units, double* precision);

LO_RESULT LOStyleSetDimensionUnits(LOStyleRef style, LODimensionUnits units, double precision);

LO_RESULT LOStyleGetSuppressDimensionUnits(LOStyleRef style, bool* is_suppressed);

LO_RESULT LOStyleSetSuppressDimensionUnits(LOStyleRef style, bool is_suppressed);





LO_RESULT LOStrokePatternGetMaximumNumberOfWidths(size_t* num_widths);

LO_RESULT LOStrokePatternGetWidths(
    LOStrokePattern stroke_pattern, size_t len, double widths[], size_t* num_widths);

LO_RESULT LOStyleGetStartArrowType(LOStyleRef style, LOArrowType* type);

LO_RESULT LOStyleSetStartArrowType(LOStyleRef style, LOArrowType type);

LO_RESULT LOStyleGetStartArrowSize(LOStyleRef style, double* size);

LO_RESULT LOStyleSetStartArrowSize(LOStyleRef style, double size);

LO_RESULT LOStyleGetEndArrowType(LOStyleRef style, LOArrowType* type);

LO_RESULT LOStyleSetEndArrowType(LOStyleRef style, LOArrowType type);

LO_RESULT LOStyleGetEndArrowSize(LOStyleRef style, double* size);

LO_RESULT LOStyleSetEndArrowSize(LOStyleRef style, double size);

LO_RESULT LOStyleIsArrowTypeFilled(LOArrowType type, bool* filled);

LO_RESULT LOStyleSetSubEntityStyle(LOStyleRef style, LOSubEntityType type, LOStyleRef sub_style);

LO_RESULT LOStyleGetSubEntityStyle(LOStyleRef style, LOSubEntityType type, LOStyleRef* sub_style);

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