figma_api/models/regular_polygon_node.rs
1/*
2 * Figma API
3 *
4 * This is the OpenAPI specification for the [Figma REST API](https://www.figma.com/developers/api). Note: we are releasing the OpenAPI specification as a beta given the large surface area and complexity of the REST API. If you notice any inaccuracies with the specification, please [file an issue](https://github.com/figma/rest-api-spec/issues).
5 *
6 * The version of the OpenAPI document: 0.31.0
7 * Contact: support@figma.com
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct RegularPolygonNode {
16 /// A string uniquely identifying this node within the document.
17 #[serde(rename = "id")]
18 pub id: String,
19 /// The name given to the node by the user in the tool.
20 #[serde(rename = "name")]
21 pub name: String,
22 /// Whether or not the node is visible on the canvas.
23 #[serde(rename = "visible", skip_serializing_if = "Option::is_none")]
24 pub visible: Option<bool>,
25 /// If true, layer is locked and cannot be edited
26 #[serde(rename = "locked", skip_serializing_if = "Option::is_none")]
27 pub locked: Option<bool>,
28 /// Whether the layer is fixed while the parent is scrolling
29 #[serde(rename = "isFixed", skip_serializing_if = "Option::is_none")]
30 pub is_fixed: Option<bool>,
31 /// How layer should be treated when the frame is resized
32 #[serde(rename = "scrollBehavior")]
33 pub scroll_behavior: ScrollBehavior,
34 /// The rotation of the node, if not 0.
35 #[serde(rename = "rotation", skip_serializing_if = "Option::is_none")]
36 pub rotation: Option<f64>,
37 /// A mapping of a layer's property to component property name of component properties attached to this node. The component property name can be used to look up more information on the corresponding component's or component set's componentPropertyDefinitions.
38 #[serde(rename = "componentPropertyReferences", skip_serializing_if = "Option::is_none")]
39 pub component_property_references: Option<std::collections::HashMap<String, String>>,
40 #[serde(rename = "pluginData", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
41 pub plugin_data: Option<Option<serde_json::Value>>,
42 #[serde(rename = "sharedPluginData", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
43 pub shared_plugin_data: Option<Option<serde_json::Value>>,
44 #[serde(rename = "boundVariables", skip_serializing_if = "Option::is_none")]
45 pub bound_variables: Option<Box<models::IsLayerTraitBoundVariables>>,
46 /// A mapping of variable collection ID to mode ID representing the explicitly set modes for this node.
47 #[serde(rename = "explicitVariableModes", skip_serializing_if = "Option::is_none")]
48 pub explicit_variable_modes: Option<std::collections::HashMap<String, String>>,
49 /// How this node blends with nodes behind it in the scene (see blend mode section for more details)
50 #[serde(rename = "blendMode")]
51 pub blend_mode: models::BlendMode,
52 /// Opacity of the node
53 #[serde(rename = "opacity", skip_serializing_if = "Option::is_none")]
54 pub opacity: Option<f64>,
55 /// Keep height and width constrained to same ratio.
56 #[serde(rename = "preserveRatio", skip_serializing_if = "Option::is_none")]
57 pub preserve_ratio: Option<bool>,
58 /// Horizontal and vertical layout constraints for node.
59 #[serde(rename = "constraints", skip_serializing_if = "Option::is_none")]
60 pub constraints: Option<Box<models::LayoutConstraint>>,
61 /// A transformation matrix is standard way in computer graphics to represent translation and rotation. These are the top two rows of a 3x3 matrix. The bottom row of the matrix is assumed to be [0, 0, 1]. This is known as an affine transform and is enough to represent translation, rotation, and skew. The identity transform is [[1, 0, 0], [0, 1, 0]]. A translation matrix will typically look like: ``` [[1, 0, tx], [0, 1, ty]] ``` and a rotation matrix will typically look like: ``` [[cos(angle), sin(angle), 0], [-sin(angle), cos(angle), 0]] ``` Another way to think about this transform is as three vectors: - The x axis (t[0][0], t[1][0]) - The y axis (t[0][1], t[1][1]) - The translation offset (t[0][2], t[1][2]) The most common usage of the Transform matrix is the `relativeTransform property`. This particular usage of the matrix has a few additional restrictions. The translation offset can take on any value but we do enforce that the axis vectors are unit vectors (i.e. have length 1). The axes are not required to be at 90° angles to each other.
62 #[serde(rename = "relativeTransform", skip_serializing_if = "Option::is_none")]
63 pub relative_transform: Option<Vec<Vec<f64>>>,
64 /// Width and height of element. This is different from the width and height of the bounding box in that the absolute bounding box represents the element after scaling and rotation. Only present if `geometry=paths` is passed.
65 #[serde(rename = "size", skip_serializing_if = "Option::is_none")]
66 pub size: Option<Box<models::Vector>>,
67 /// Determines if the layer should stretch along the parent's counter axis. This property is only provided for direct children of auto-layout frames. - `INHERIT` - `STRETCH` In previous versions of auto layout, determined how the layer is aligned inside an auto-layout frame. This property is only provided for direct children of auto-layout frames. - `MIN` - `CENTER` - `MAX` - `STRETCH` In horizontal auto-layout frames, \"MIN\" and \"MAX\" correspond to \"TOP\" and \"BOTTOM\". In vertical auto-layout frames, \"MIN\" and \"MAX\" correspond to \"LEFT\" and \"RIGHT\".
68 #[serde(rename = "layoutAlign", skip_serializing_if = "Option::is_none")]
69 pub layout_align: Option<LayoutAlign>,
70 /// This property is applicable only for direct children of auto-layout frames, ignored otherwise. Determines whether a layer should stretch along the parent's primary axis. A `0` corresponds to a fixed size and `1` corresponds to stretch.
71 #[serde(rename = "layoutGrow", skip_serializing_if = "Option::is_none")]
72 pub layout_grow: Option<f64>,
73 /// Determines whether a layer's size and position should be determined by auto-layout settings or manually adjustable.
74 #[serde(rename = "layoutPositioning", skip_serializing_if = "Option::is_none")]
75 pub layout_positioning: Option<LayoutPositioning>,
76 /// The minimum width of the frame. This property is only applicable for auto-layout frames or direct children of auto-layout frames.
77 #[serde(rename = "minWidth", skip_serializing_if = "Option::is_none")]
78 pub min_width: Option<f64>,
79 /// The maximum width of the frame. This property is only applicable for auto-layout frames or direct children of auto-layout frames.
80 #[serde(rename = "maxWidth", skip_serializing_if = "Option::is_none")]
81 pub max_width: Option<f64>,
82 /// The minimum height of the frame. This property is only applicable for auto-layout frames or direct children of auto-layout frames.
83 #[serde(rename = "minHeight", skip_serializing_if = "Option::is_none")]
84 pub min_height: Option<f64>,
85 /// The maximum height of the frame. This property is only applicable for auto-layout frames or direct children of auto-layout frames.
86 #[serde(rename = "maxHeight", skip_serializing_if = "Option::is_none")]
87 pub max_height: Option<f64>,
88 /// The horizontal sizing setting on this auto-layout frame or frame child. - `FIXED` - `HUG`: only valid on auto-layout frames and text nodes - `FILL`: only valid on auto-layout frame children
89 #[serde(rename = "layoutSizingHorizontal", skip_serializing_if = "Option::is_none")]
90 pub layout_sizing_horizontal: Option<LayoutSizingHorizontal>,
91 /// The vertical sizing setting on this auto-layout frame or frame child. - `FIXED` - `HUG`: only valid on auto-layout frames and text nodes - `FILL`: only valid on auto-layout frame children
92 #[serde(rename = "layoutSizingVertical", skip_serializing_if = "Option::is_none")]
93 pub layout_sizing_vertical: Option<LayoutSizingVertical>,
94 /// An array of fill paints applied to the node.
95 #[serde(rename = "fills")]
96 pub fills: Vec<models::Paint>,
97 /// A mapping of a StyleType to style ID (see Style) of styles present on this node. The style ID can be used to look up more information about the style in the top-level styles field.
98 #[serde(rename = "styles", skip_serializing_if = "Option::is_none")]
99 pub styles: Option<std::collections::HashMap<String, String>>,
100 /// An array of stroke paints applied to the node.
101 #[serde(rename = "strokes", skip_serializing_if = "Option::is_none")]
102 pub strokes: Option<Vec<models::Paint>>,
103 /// The weight of strokes on the node.
104 #[serde(rename = "strokeWeight", skip_serializing_if = "Option::is_none")]
105 pub stroke_weight: Option<f64>,
106 /// Position of stroke relative to vector outline, as a string enum - `INSIDE`: stroke drawn inside the shape boundary - `OUTSIDE`: stroke drawn outside the shape boundary - `CENTER`: stroke drawn centered along the shape boundary
107 #[serde(rename = "strokeAlign", skip_serializing_if = "Option::is_none")]
108 pub stroke_align: Option<StrokeAlign>,
109 /// A string enum with value of \"MITER\", \"BEVEL\", or \"ROUND\", describing how corners in vector paths are rendered.
110 #[serde(rename = "strokeJoin", skip_serializing_if = "Option::is_none")]
111 pub stroke_join: Option<StrokeJoin>,
112 /// An array of floating point numbers describing the pattern of dash length and gap lengths that the vector stroke will use when drawn. For example a value of [1, 2] indicates that the stroke will be drawn with a dash of length 1 followed by a gap of length 2, repeated.
113 #[serde(rename = "strokeDashes", skip_serializing_if = "Option::is_none")]
114 pub stroke_dashes: Option<Vec<f64>>,
115 /// Only specified if parameter `geometry=paths` is used. An array of paths representing the object fill.
116 #[serde(rename = "fillGeometry", skip_serializing_if = "Option::is_none")]
117 pub fill_geometry: Option<Vec<models::Path>>,
118 /// Only specified if parameter `geometry=paths` is used. An array of paths representing the object stroke.
119 #[serde(rename = "strokeGeometry", skip_serializing_if = "Option::is_none")]
120 pub stroke_geometry: Option<Vec<models::Path>>,
121 /// A string enum describing the end caps of vector paths.
122 #[serde(rename = "strokeCap", skip_serializing_if = "Option::is_none")]
123 pub stroke_cap: Option<StrokeCap>,
124 /// Only valid if `strokeJoin` is \"MITER\". The corner angle, in degrees, below which `strokeJoin` will be set to \"BEVEL\" to avoid super sharp corners. By default this is 28.96 degrees.
125 #[serde(rename = "strokeMiterAngle", skip_serializing_if = "Option::is_none")]
126 pub stroke_miter_angle: Option<f64>,
127 /// An array of export settings representing images to export from the node.
128 #[serde(rename = "exportSettings", skip_serializing_if = "Option::is_none")]
129 pub export_settings: Option<Vec<models::ExportSetting>>,
130 /// An array of effects attached to this node (see effects section for more details)
131 #[serde(rename = "effects")]
132 pub effects: Vec<models::Effect>,
133 /// Does this node mask sibling nodes in front of it?
134 #[serde(rename = "isMask", skip_serializing_if = "Option::is_none")]
135 pub is_mask: Option<bool>,
136 /// If this layer is a mask, this property describes the operation used to mask the layer's siblings. The value may be one of the following: - ALPHA: the mask node's alpha channel will be used to determine the opacity of each pixel in the masked result. - VECTOR: if the mask node has visible fill paints, every pixel inside the node's fill regions will be fully visible in the masked result. If the mask has visible stroke paints, every pixel inside the node's stroke regions will be fully visible in the masked result. - LUMINANCE: the luminance value of each pixel of the mask node will be used to determine the opacity of that pixel in the masked result.
137 #[serde(rename = "maskType", skip_serializing_if = "Option::is_none")]
138 pub mask_type: Option<MaskType>,
139 /// True if maskType is VECTOR. This field is deprecated; use maskType instead.
140 #[serde(rename = "isMaskOutline", skip_serializing_if = "Option::is_none")]
141 pub is_mask_outline: Option<bool>,
142 /// Node ID of node to transition to in prototyping
143 #[serde(rename = "transitionNodeID", skip_serializing_if = "Option::is_none")]
144 pub transition_node_id: Option<String>,
145 /// The duration of the prototyping transition on this node (in milliseconds). This will override the default transition duration on the prototype, for this node.
146 #[serde(rename = "transitionDuration", skip_serializing_if = "Option::is_none")]
147 pub transition_duration: Option<f64>,
148 /// The easing curve used in the prototyping transition on this node.
149 #[serde(rename = "transitionEasing", skip_serializing_if = "Option::is_none")]
150 pub transition_easing: Option<models::EasingType>,
151 /// Radius of each corner if a single radius is set for all corners
152 #[serde(rename = "cornerRadius", skip_serializing_if = "Option::is_none")]
153 pub corner_radius: Option<f64>,
154 /// A value that lets you control how \"smooth\" the corners are. Ranges from 0 to 1. 0 is the default and means that the corner is perfectly circular. A value of 0.6 means the corner matches the iOS 7 \"squircle\" icon shape. Other values produce various other curves.
155 #[serde(rename = "cornerSmoothing", skip_serializing_if = "Option::is_none")]
156 pub corner_smoothing: Option<f64>,
157 /// Array of length 4 of the radius of each corner of the frame, starting in the top left and proceeding clockwise. Values are given in the order top-left, top-right, bottom-right, bottom-left.
158 #[serde(rename = "rectangleCornerRadii", skip_serializing_if = "Option::is_none")]
159 pub rectangle_corner_radii: Option<Vec<f64>>,
160}
161
162impl RegularPolygonNode {
163 pub fn new(id: String, name: String, scroll_behavior: ScrollBehavior, blend_mode: models::BlendMode, fills: Vec<models::Paint>, effects: Vec<models::Effect>) -> RegularPolygonNode {
164 RegularPolygonNode {
165 id,
166 name,
167 visible: None,
168 locked: None,
169 is_fixed: None,
170 scroll_behavior,
171 rotation: None,
172 component_property_references: None,
173 plugin_data: None,
174 shared_plugin_data: None,
175 bound_variables: None,
176 explicit_variable_modes: None,
177 blend_mode,
178 opacity: None,
179 preserve_ratio: None,
180 constraints: None,
181 relative_transform: None,
182 size: None,
183 layout_align: None,
184 layout_grow: None,
185 layout_positioning: None,
186 min_width: None,
187 max_width: None,
188 min_height: None,
189 max_height: None,
190 layout_sizing_horizontal: None,
191 layout_sizing_vertical: None,
192 fills,
193 styles: None,
194 strokes: None,
195 stroke_weight: None,
196 stroke_align: None,
197 stroke_join: None,
198 stroke_dashes: None,
199 fill_geometry: None,
200 stroke_geometry: None,
201 stroke_cap: None,
202 stroke_miter_angle: None,
203 export_settings: None,
204 effects,
205 is_mask: None,
206 mask_type: None,
207 is_mask_outline: None,
208 transition_node_id: None,
209 transition_duration: None,
210 transition_easing: None,
211 corner_radius: None,
212 corner_smoothing: None,
213 rectangle_corner_radii: None,
214 }
215 }
216}
217/// How layer should be treated when the frame is resized
218#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
219pub enum ScrollBehavior {
220 #[serde(rename = "SCROLLS")]
221 Scrolls,
222 #[serde(rename = "FIXED")]
223 Fixed,
224 #[serde(rename = "STICKY_SCROLLS")]
225 StickyScrolls,
226}
227
228impl Default for ScrollBehavior {
229 fn default() -> ScrollBehavior {
230 Self::Scrolls
231 }
232}
233/// Determines if the layer should stretch along the parent's counter axis. This property is only provided for direct children of auto-layout frames. - `INHERIT` - `STRETCH` In previous versions of auto layout, determined how the layer is aligned inside an auto-layout frame. This property is only provided for direct children of auto-layout frames. - `MIN` - `CENTER` - `MAX` - `STRETCH` In horizontal auto-layout frames, \"MIN\" and \"MAX\" correspond to \"TOP\" and \"BOTTOM\". In vertical auto-layout frames, \"MIN\" and \"MAX\" correspond to \"LEFT\" and \"RIGHT\".
234#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
235pub enum LayoutAlign {
236 #[serde(rename = "INHERIT")]
237 Inherit,
238 #[serde(rename = "STRETCH")]
239 Stretch,
240 #[serde(rename = "MIN")]
241 Min,
242 #[serde(rename = "CENTER")]
243 Center,
244 #[serde(rename = "MAX")]
245 Max,
246}
247
248impl Default for LayoutAlign {
249 fn default() -> LayoutAlign {
250 Self::Inherit
251 }
252}
253/// Determines whether a layer's size and position should be determined by auto-layout settings or manually adjustable.
254#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
255pub enum LayoutPositioning {
256 #[serde(rename = "AUTO")]
257 Auto,
258 #[serde(rename = "ABSOLUTE")]
259 Absolute,
260}
261
262impl Default for LayoutPositioning {
263 fn default() -> LayoutPositioning {
264 Self::Auto
265 }
266}
267/// The horizontal sizing setting on this auto-layout frame or frame child. - `FIXED` - `HUG`: only valid on auto-layout frames and text nodes - `FILL`: only valid on auto-layout frame children
268#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
269pub enum LayoutSizingHorizontal {
270 #[serde(rename = "FIXED")]
271 Fixed,
272 #[serde(rename = "HUG")]
273 Hug,
274 #[serde(rename = "FILL")]
275 Fill,
276}
277
278impl Default for LayoutSizingHorizontal {
279 fn default() -> LayoutSizingHorizontal {
280 Self::Fixed
281 }
282}
283/// The vertical sizing setting on this auto-layout frame or frame child. - `FIXED` - `HUG`: only valid on auto-layout frames and text nodes - `FILL`: only valid on auto-layout frame children
284#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
285pub enum LayoutSizingVertical {
286 #[serde(rename = "FIXED")]
287 Fixed,
288 #[serde(rename = "HUG")]
289 Hug,
290 #[serde(rename = "FILL")]
291 Fill,
292}
293
294impl Default for LayoutSizingVertical {
295 fn default() -> LayoutSizingVertical {
296 Self::Fixed
297 }
298}
299/// Position of stroke relative to vector outline, as a string enum - `INSIDE`: stroke drawn inside the shape boundary - `OUTSIDE`: stroke drawn outside the shape boundary - `CENTER`: stroke drawn centered along the shape boundary
300#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
301pub enum StrokeAlign {
302 #[serde(rename = "INSIDE")]
303 Inside,
304 #[serde(rename = "OUTSIDE")]
305 Outside,
306 #[serde(rename = "CENTER")]
307 Center,
308}
309
310impl Default for StrokeAlign {
311 fn default() -> StrokeAlign {
312 Self::Inside
313 }
314}
315/// A string enum with value of \"MITER\", \"BEVEL\", or \"ROUND\", describing how corners in vector paths are rendered.
316#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
317pub enum StrokeJoin {
318 #[serde(rename = "MITER")]
319 Miter,
320 #[serde(rename = "BEVEL")]
321 Bevel,
322 #[serde(rename = "ROUND")]
323 Round,
324}
325
326impl Default for StrokeJoin {
327 fn default() -> StrokeJoin {
328 Self::Miter
329 }
330}
331/// A string enum describing the end caps of vector paths.
332#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
333pub enum StrokeCap {
334 #[serde(rename = "NONE")]
335 None,
336 #[serde(rename = "ROUND")]
337 Round,
338 #[serde(rename = "SQUARE")]
339 Square,
340 #[serde(rename = "LINE_ARROW")]
341 LineArrow,
342 #[serde(rename = "TRIANGLE_ARROW")]
343 TriangleArrow,
344 #[serde(rename = "DIAMOND_FILLED")]
345 DiamondFilled,
346 #[serde(rename = "CIRCLE_FILLED")]
347 CircleFilled,
348 #[serde(rename = "TRIANGLE_FILLED")]
349 TriangleFilled,
350 #[serde(rename = "WASHI_TAPE_1")]
351 WashiTape1,
352 #[serde(rename = "WASHI_TAPE_2")]
353 WashiTape2,
354 #[serde(rename = "WASHI_TAPE_3")]
355 WashiTape3,
356 #[serde(rename = "WASHI_TAPE_4")]
357 WashiTape4,
358 #[serde(rename = "WASHI_TAPE_5")]
359 WashiTape5,
360 #[serde(rename = "WASHI_TAPE_6")]
361 WashiTape6,
362}
363
364impl Default for StrokeCap {
365 fn default() -> StrokeCap {
366 Self::None
367 }
368}
369/// If this layer is a mask, this property describes the operation used to mask the layer's siblings. The value may be one of the following: - ALPHA: the mask node's alpha channel will be used to determine the opacity of each pixel in the masked result. - VECTOR: if the mask node has visible fill paints, every pixel inside the node's fill regions will be fully visible in the masked result. If the mask has visible stroke paints, every pixel inside the node's stroke regions will be fully visible in the masked result. - LUMINANCE: the luminance value of each pixel of the mask node will be used to determine the opacity of that pixel in the masked result.
370#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
371pub enum MaskType {
372 #[serde(rename = "ALPHA")]
373 Alpha,
374 #[serde(rename = "VECTOR")]
375 Vector,
376 #[serde(rename = "LUMINANCE")]
377 Luminance,
378}
379
380impl Default for MaskType {
381 fn default() -> MaskType {
382 Self::Alpha
383 }
384}
385