scriptup 2026.0.0 → 2026.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/ext/entity.c +3 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Frameworks/libCommonGeometry.dylib +0 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/{Libraries → Frameworks}/libCommonGeoutils.dylib +0 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/{Libraries → Frameworks}/libCommonImage.dylib +0 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Frameworks/libCommonPreferences.dylib +0 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Frameworks/libCommonUnits.dylib +0 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Frameworks/libCommonUtils.dylib +0 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Frameworks/libCommonZip.dylib +0 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/application/model.h +4 -4
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/application/overlay.h +20 -6
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/common.h +9 -9
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/extension_license.h +9 -1
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/point2d.h +2 -2
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/point3d.h +2 -2
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/transformation2d.h +3 -3
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/vector2d.h +5 -5
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry/vector3d.h +4 -4
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/geometry.h +9 -7
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/import_export/modelimporterplugin.h +8 -4
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/attribute_dictionary.h +4 -4
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/component_definition.h +74 -33
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/component_definition_snap_to_behavior_private.h +46 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/component_instance.h +11 -11
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/curve.h +4 -4
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/defs.h +7 -2
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/dimension.h +2 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/drawing_element.h +11 -11
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/edge.h +7 -7
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/entities.h +106 -61
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/entity.h +7 -4
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/environment.h +382 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/environments.h +133 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/face.h +43 -27
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/geometry_input.h +126 -116
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/group.h +9 -8
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/image.h +6 -5
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/layer.h +3 -3
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/material.h +432 -25
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/model.h +263 -100
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/model_entity_type_private.h +44 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/rendering_options.h +82 -81
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/scene.h +222 -42
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/snap.h +183 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/space.h +26 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/styles.h +29 -27
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/text.h +14 -6
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/texture.h +23 -1
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/typed_value.h +26 -26
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/model/vertex.h +2 -2
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/sketchup.h +4 -1
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Headers/unicodestring.h +7 -7
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Resources/Info.plist +8 -8
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/SketchUpAPI +0 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/_CodeSignature/CodeResources +144 -88
- data/sketchup-sdk-win/binaries/layout/x64/LayOutAPI.dll +0 -0
- data/sketchup-sdk-win/binaries/layout/x64/LayOutAPI.lib +0 -0
- data/sketchup-sdk-win/binaries/layout/x64/LayOutControllers.dll +0 -0
- data/sketchup-sdk-win/binaries/layout/x64/LayOutModel.dll +0 -0
- data/sketchup-sdk-win/binaries/layout/x64/LayOutRTF.dll +0 -0
- data/sketchup-sdk-win/binaries/layout/x64/LayOutUtils.dll +0 -0
- data/sketchup-sdk-win/binaries/layout/x64/LayOutView.dll +0 -0
- data/sketchup-sdk-win/binaries/layout/x64/SketchUpCommonPreferences.dll +0 -0
- data/sketchup-sdk-win/binaries/layout/x64/SketchUpViewerAPI.dll +0 -0
- data/sketchup-sdk-win/binaries/layout/x64/SketchUpViewerAPI.lib +0 -0
- data/sketchup-sdk-win/binaries/layout/x64/pdflib.dll +0 -0
- data/sketchup-sdk-win/binaries/sketchup/x64/SketchUpAPI.dll +0 -0
- data/sketchup-sdk-win/binaries/sketchup/x64/SketchUpAPI.lib +0 -0
- data/sketchup-sdk-win/binaries/sketchup/x64/SketchUpCommonPreferences.dll +0 -0
- data/sketchup-sdk-win/binaries/sketchup/x64/sketchup.lib +0 -0
- data/sketchup-sdk-win/headers/LayOutAPI/application/application.h +14 -14
- data/sketchup-sdk-win/headers/LayOutAPI/layout.h +1 -1
- data/sketchup-sdk-win/headers/LayOutAPI/model/dictionary.h +1 -1
- data/sketchup-sdk-win/headers/LayOutAPI/model/document.h +73 -0
- data/sketchup-sdk-win/headers/LayOutAPI/model/documentexportoptions.h +21 -2
- data/sketchup-sdk-win/headers/LayOutAPI/model/entity.h +72 -0
- data/sketchup-sdk-win/headers/LayOutAPI/model/group.h +2 -1
- data/sketchup-sdk-win/headers/LayOutAPI/model/lineardimension.h +54 -2
- data/sketchup-sdk-win/headers/LayOutAPI/model/page.h +70 -0
- data/sketchup-sdk-win/headers/LayOutAPI/model/sketchupmodel.h +58 -1
- data/sketchup-sdk-win/headers/LayOutAPI/model/style.h +39 -3
- data/sketchup-sdk-win/headers/LayOutAPI/model/table.h +2 -0
- data/sketchup-sdk-win/headers/LayOutAPI/model/typed_value.h +25 -1
- data/sketchup-sdk-win/headers/SketchUpAPI/application/model.h +4 -4
- data/sketchup-sdk-win/headers/SketchUpAPI/application/overlay.h +20 -6
- data/sketchup-sdk-win/headers/SketchUpAPI/common.h +9 -9
- data/sketchup-sdk-win/headers/SketchUpAPI/extension_license.h +9 -1
- data/sketchup-sdk-win/headers/SketchUpAPI/geometry/point2d.h +2 -2
- data/sketchup-sdk-win/headers/SketchUpAPI/geometry/point3d.h +2 -2
- data/sketchup-sdk-win/headers/SketchUpAPI/geometry/transformation2d.h +3 -3
- data/sketchup-sdk-win/headers/SketchUpAPI/geometry/vector2d.h +5 -5
- data/sketchup-sdk-win/headers/SketchUpAPI/geometry/vector3d.h +4 -4
- data/sketchup-sdk-win/headers/SketchUpAPI/geometry.h +9 -7
- data/sketchup-sdk-win/headers/SketchUpAPI/import_export/modelimporterplugin.h +8 -4
- data/sketchup-sdk-win/headers/SketchUpAPI/model/attribute_dictionary.h +4 -4
- data/sketchup-sdk-win/headers/SketchUpAPI/model/component_definition.h +74 -33
- data/sketchup-sdk-win/headers/SketchUpAPI/model/component_definition_snap_to_behavior_private.h +46 -0
- data/sketchup-sdk-win/headers/SketchUpAPI/model/component_instance.h +11 -11
- data/sketchup-sdk-win/headers/SketchUpAPI/model/curve.h +4 -4
- data/sketchup-sdk-win/headers/SketchUpAPI/model/defs.h +7 -2
- data/sketchup-sdk-win/headers/SketchUpAPI/model/dimension.h +2 -0
- data/sketchup-sdk-win/headers/SketchUpAPI/model/drawing_element.h +11 -11
- data/sketchup-sdk-win/headers/SketchUpAPI/model/edge.h +7 -7
- data/sketchup-sdk-win/headers/SketchUpAPI/model/entities.h +106 -61
- data/sketchup-sdk-win/headers/SketchUpAPI/model/entity.h +7 -4
- data/sketchup-sdk-win/headers/SketchUpAPI/model/environment.h +382 -0
- data/sketchup-sdk-win/headers/SketchUpAPI/model/environments.h +133 -0
- data/sketchup-sdk-win/headers/SketchUpAPI/model/face.h +43 -27
- data/sketchup-sdk-win/headers/SketchUpAPI/model/geometry_input.h +126 -116
- data/sketchup-sdk-win/headers/SketchUpAPI/model/group.h +9 -8
- data/sketchup-sdk-win/headers/SketchUpAPI/model/image.h +6 -5
- data/sketchup-sdk-win/headers/SketchUpAPI/model/layer.h +3 -3
- data/sketchup-sdk-win/headers/SketchUpAPI/model/material.h +432 -25
- data/sketchup-sdk-win/headers/SketchUpAPI/model/model.h +263 -100
- data/sketchup-sdk-win/headers/SketchUpAPI/model/model_entity_type_private.h +44 -0
- data/sketchup-sdk-win/headers/SketchUpAPI/model/rendering_options.h +82 -81
- data/sketchup-sdk-win/headers/SketchUpAPI/model/scene.h +222 -42
- data/sketchup-sdk-win/headers/SketchUpAPI/model/snap.h +183 -0
- data/sketchup-sdk-win/headers/SketchUpAPI/model/space.h +26 -0
- data/sketchup-sdk-win/headers/SketchUpAPI/model/styles.h +29 -27
- data/sketchup-sdk-win/headers/SketchUpAPI/model/text.h +14 -6
- data/sketchup-sdk-win/headers/SketchUpAPI/model/texture.h +23 -1
- data/sketchup-sdk-win/headers/SketchUpAPI/model/typed_value.h +26 -26
- data/sketchup-sdk-win/headers/SketchUpAPI/model/vertex.h +2 -2
- data/sketchup-sdk-win/headers/SketchUpAPI/sketchup.h +4 -1
- data/sketchup-sdk-win/headers/SketchUpAPI/unicodestring.h +7 -7
- metadata +22 -10
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Libraries/libCommonGeometry.dylib +0 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Libraries/libCommonPreferences.dylib +0 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Libraries/libCommonUnits.dylib +0 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Libraries/libCommonUtils.dylib +0 -0
- data/sketchup-sdk-mac/SketchUpAPI.framework/Versions/A/Libraries/libCommonZip.dylib +0 -0
- data/sketchup-sdk-win/headers/LayOutAPI/model/skpfilereference.h +0 -94
@@ -0,0 +1,183 @@
|
|
1
|
+
// Copyright 2024 Trimble Inc. All Rights Reserved.
|
2
|
+
|
3
|
+
/**
|
4
|
+
* @file
|
5
|
+
* @brief Interfaces for SUSnapRef.
|
6
|
+
*/
|
7
|
+
#ifndef SKETCHUP_MODEL_SNAP_H_
|
8
|
+
#define SKETCHUP_MODEL_SNAP_H_
|
9
|
+
|
10
|
+
#include <SketchUpAPI/common.h>
|
11
|
+
#include <SketchUpAPI/geometry.h>
|
12
|
+
#include <SketchUpAPI/model/defs.h>
|
13
|
+
|
14
|
+
#ifdef __cplusplus
|
15
|
+
extern "C" {
|
16
|
+
#endif
|
17
|
+
|
18
|
+
/**
|
19
|
+
@struct SUSnapRef
|
20
|
+
@extends SUDrawingElementRef
|
21
|
+
@brief References a snap.
|
22
|
+
@since SketchUp 2025.0, API 13.0
|
23
|
+
|
24
|
+
A Snap is a custom grip used by SketchUp's Move tool. Snaps can be added at strategic places such
|
25
|
+
as connectors to help assembling objects.
|
26
|
+
|
27
|
+
\image html snaps.png
|
28
|
+
|
29
|
+
SUSnapGetDirection() is the direction a snap is "pointing". This can be thought of as the normal
|
30
|
+
direction of the snap. It can also be thought of as the direction you move an object when plugging
|
31
|
+
it into another object, e.g. inserting a power coord.
|
32
|
+
|
33
|
+
SUSnapGetUp() controls the rotation around the Snap's axis.
|
34
|
+
|
35
|
+
When two objects are snapped together, the Snaps have opposite SUSnapGetDirection() vectors but
|
36
|
+
matching SUSnapGetUp() vectors.
|
37
|
+
*/
|
38
|
+
|
39
|
+
/**
|
40
|
+
@brief Converts from an \ref SUSnapRef to an \ref SUEntityRef.
|
41
|
+
This is essentially an upcast operation.
|
42
|
+
@since SketchUp 2025.0, API 13.0
|
43
|
+
@param[in] snap The given snap reference.
|
44
|
+
@related SUSnapRef
|
45
|
+
@return
|
46
|
+
- The converted SUEntityRef if \p snap is a valid snap.
|
47
|
+
- If not, the returned reference will be invalid.
|
48
|
+
*/
|
49
|
+
SU_EXPORT SUEntityRef SUSnapToEntity(SUSnapRef snap);
|
50
|
+
|
51
|
+
/**
|
52
|
+
@brief Converts from an \ref SUEntityRef to an \ref SUSnapRef.
|
53
|
+
This is essentially a downcast operation so the given entity must be
|
54
|
+
convertible to an \ref SUSnapRef.
|
55
|
+
@since SketchUp 2025.0, API 13.0
|
56
|
+
@param[in] entity The given entity reference.
|
57
|
+
@related SUSnapRef
|
58
|
+
@return
|
59
|
+
- The converted SUSnapRef if the downcast operation succeeds
|
60
|
+
- If not, the returned reference will be invalid
|
61
|
+
*/
|
62
|
+
SU_EXPORT SUSnapRef SUSnapFromEntity(SUEntityRef entity);
|
63
|
+
|
64
|
+
/**
|
65
|
+
@brief Converts from an \ref SUSnapRef to an \ref SUDrawingElementRef.
|
66
|
+
This is essentially an upcast operation.
|
67
|
+
@since SketchUp 2025.0, API 13.0
|
68
|
+
@param[in] snap The given snap reference.
|
69
|
+
@related SUSnapRef
|
70
|
+
@return
|
71
|
+
- The converted \ref SUEntityRef if \p snap is a valid snap.
|
72
|
+
- If not, the returned reference will be invalid.
|
73
|
+
*/
|
74
|
+
SU_EXPORT SUDrawingElementRef SUSnapToDrawingElement(SUSnapRef snap);
|
75
|
+
|
76
|
+
/**
|
77
|
+
@brief Converts from an \ref SUDrawingElementRef to an \ref SUSnapRef.
|
78
|
+
This is essentially a downcast operation so the given element must be
|
79
|
+
convertible to an SUSnapRef.
|
80
|
+
@since SketchUp 2025.0, API 13.0
|
81
|
+
@param[in] drawing_elem The given element reference.
|
82
|
+
@related SUSnapRef
|
83
|
+
@return
|
84
|
+
- The converted \ref SUSnapRef if the downcast operation succeeds
|
85
|
+
- If not, the returned reference will be invalid
|
86
|
+
*/
|
87
|
+
SU_EXPORT SUSnapRef SUSnapFromDrawingElement(SUDrawingElementRef drawing_elem);
|
88
|
+
|
89
|
+
/**
|
90
|
+
@brief Creates a snap at the given position and orientation.
|
91
|
+
@since SketchUp 2025.0, API 13.0
|
92
|
+
@param[out] snap The snap object created.
|
93
|
+
@param[in] position The position of the snap.
|
94
|
+
@param[in] direction The orientation of the snap. Pass `NULL` to use the default orientation.
|
95
|
+
@param[in] up The up vector controls the rotation around the \p orientation of the snap.
|
96
|
+
Pass `NULL` to use the default up vector.
|
97
|
+
@related SUSnapRef
|
98
|
+
@return
|
99
|
+
- \ref SU_ERROR_NONE on success
|
100
|
+
- \ref SU_ERROR_INVALID_ARGUMENT if \p direction an \p up are parallel.
|
101
|
+
- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p snap is `NULL`
|
102
|
+
- \ref SU_ERROR_OVERWRITE_VALID if \p snap already refers to a valid object
|
103
|
+
*/
|
104
|
+
SU_RESULT SUSnapCreate(
|
105
|
+
SUSnapRef* snap, const struct SUPoint3D position, const struct SUVector3D* direction,
|
106
|
+
const struct SUVector3D* up);
|
107
|
+
|
108
|
+
/**
|
109
|
+
@brief Releases a snap object and its associated resources.
|
110
|
+
@since SketchUp 2025.0, API 13.0
|
111
|
+
@param[in] snap The snap object.
|
112
|
+
@related SUSnapRef
|
113
|
+
@return
|
114
|
+
- \ref SU_ERROR_NONE on success
|
115
|
+
- \ref SU_ERROR_NULL_POINTER_INPUT if \p snap points to an `NULL`
|
116
|
+
- \ref SU_ERROR_INVALID_INPUT if the \p snap object is not a valid object.
|
117
|
+
*/
|
118
|
+
SU_RESULT SUSnapRelease(SUSnapRef* snap);
|
119
|
+
|
120
|
+
/**
|
121
|
+
@brief Retrieves the position of a snap.
|
122
|
+
@since SketchUp 2025.0, API 13.0
|
123
|
+
@param[in] snap The snap object.
|
124
|
+
@param[out] position The position retrieved.
|
125
|
+
@related SUSnapRef
|
126
|
+
@return
|
127
|
+
- \ref SU_ERROR_NONE on success
|
128
|
+
- \ref SU_ERROR_INVALID_INPUT if \p snap point is an invalid object
|
129
|
+
- \ref SU_ERROR_NULL_POINTER_OUTPUT if position is `NULL`
|
130
|
+
*/
|
131
|
+
SU_RESULT SUSnapGetPosition(SUSnapRef snap, struct SUPoint3D* position);
|
132
|
+
|
133
|
+
/**
|
134
|
+
@brief Retrieves the orientation of a snap.
|
135
|
+
@since SketchUp 2025.0, API 13.0
|
136
|
+
@param[in] snap The snap object.
|
137
|
+
@param[out] direction The direction of the snap.
|
138
|
+
@related SUSnapRef
|
139
|
+
@return
|
140
|
+
- \ref SU_ERROR_NONE on success
|
141
|
+
- \ref SU_ERROR_INVALID_INPUT if \p snap point is an invalid object
|
142
|
+
- \ref SU_ERROR_NULL_POINTER_OUTPUT if direction is `NULL`
|
143
|
+
*/
|
144
|
+
SU_RESULT SUSnapGetDirection(SUSnapRef snap, struct SUVector3D* direction);
|
145
|
+
|
146
|
+
/**
|
147
|
+
@brief Retrieves the up vector of a snap.
|
148
|
+
@since SketchUp 2025.0, API 13.0
|
149
|
+
@param[in] snap The snap object.
|
150
|
+
@param[out] up The up vector of the snap.
|
151
|
+
@related SUSnapRef
|
152
|
+
@return
|
153
|
+
- \ref SU_ERROR_NONE on success
|
154
|
+
- \ref SU_ERROR_INVALID_INPUT if \p snap point is an invalid object
|
155
|
+
- \ref SU_ERROR_NULL_POINTER_OUTPUT if up is `NULL`
|
156
|
+
*/
|
157
|
+
|
158
|
+
SU_RESULT SUSnapGetUp(SUSnapRef snap, struct SUVector3D* up);
|
159
|
+
/**
|
160
|
+
@brief Sets the position, direction and up vector of the snap.
|
161
|
+
|
162
|
+
If only \p position is provided then \p direction and \p up remains unchanged.
|
163
|
+
|
164
|
+
@since SketchUp 2025.0, API 13.0
|
165
|
+
@param[in] snap The snap object.
|
166
|
+
@param[in] position The position of the snap.
|
167
|
+
@param[in] direction The orientation of the snap. Pass `NULL` to use the default orientation.
|
168
|
+
@param[in] up The up vector of the snap. Pass `NULL` to use the default up vector.
|
169
|
+
@related SUSnapRef
|
170
|
+
@return
|
171
|
+
- \ref SU_ERROR_NONE on success
|
172
|
+
- \ref SU_ERROR_INVALID_ARGUMENT if \p direction an \p up are parallel.
|
173
|
+
- \ref SU_ERROR_NULL_POINTER_INPUT if \p snap is `NULL`
|
174
|
+
*/
|
175
|
+
SU_RESULT SUSnapSet(
|
176
|
+
SUSnapRef snap, const struct SUPoint3D position, const struct SUVector3D* direction,
|
177
|
+
const struct SUVector3D* up);
|
178
|
+
|
179
|
+
#ifdef __cplusplus
|
180
|
+
}
|
181
|
+
#endif
|
182
|
+
|
183
|
+
#endif // SKETCHUP_MODEL_SNAP_H_
|
@@ -0,0 +1,26 @@
|
|
1
|
+
// Copyright 2024 Trimble Inc. All Rights Reserved.
|
2
|
+
|
3
|
+
/**
|
4
|
+
* @file
|
5
|
+
* @brief Interfaces for SUSpaceRef.
|
6
|
+
|
7
|
+
For internal use only at this time. APIs may change.
|
8
|
+
*/
|
9
|
+
#ifndef SKETCHUP_MODEL_SPACE_H_
|
10
|
+
#define SKETCHUP_MODEL_SPACE_H_
|
11
|
+
|
12
|
+
#include <SketchUpAPI/common.h>
|
13
|
+
#include <SketchUpAPI/geometry.h>
|
14
|
+
#include <SketchUpAPI/model/defs.h>
|
15
|
+
|
16
|
+
// Forward declarations
|
17
|
+
|
18
|
+
#ifdef __cplusplus
|
19
|
+
extern "C" {
|
20
|
+
#endif
|
21
|
+
|
22
|
+
#ifdef __cplusplus
|
23
|
+
} // extern "C" {
|
24
|
+
#endif
|
25
|
+
|
26
|
+
#endif // SKETCHUP_MODEL_SPACE_H_
|
@@ -1,4 +1,4 @@
|
|
1
|
-
// Copyright 2015 Trimble Inc. All Rights Reserved.
|
1
|
+
// Copyright 2015-2025 Trimble Inc. All Rights Reserved.
|
2
2
|
|
3
3
|
/**
|
4
4
|
* @file
|
@@ -33,9 +33,9 @@ NOTE: Return value SU_ERROR_SERIALIZATION was added for SketchUp 2019, API 7.0
|
|
33
33
|
@related SUStylesRef
|
34
34
|
@return
|
35
35
|
- \ref SU_ERROR_NONE on success
|
36
|
-
- \ref SU_ERROR_INVALID_INPUT if styles is not a valid object
|
37
|
-
- \ref SU_ERROR_NULL_POINTER_INPUT if name is NULL
|
38
|
-
- \ref SU_ERROR_SERIALIZATION if style couldn't be created from the file at path
|
36
|
+
- \ref SU_ERROR_INVALID_INPUT if \p styles is not a valid object
|
37
|
+
- \ref SU_ERROR_NULL_POINTER_INPUT if \p name is NULL
|
38
|
+
- \ref SU_ERROR_SERIALIZATION if \p style couldn't be created from the file at \p path
|
39
39
|
- \ref SU_ERROR_DUPLICATE if the name corresponds to an existing style
|
40
40
|
*/
|
41
41
|
SU_RESULT SUStylesAddStyle(SUStylesRef styles, const char* path, bool activate);
|
@@ -48,8 +48,8 @@ SU_RESULT SUStylesAddStyle(SUStylesRef styles, const char* path, bool activate);
|
|
48
48
|
@related SUStylesRef
|
49
49
|
@return
|
50
50
|
- \ref SU_ERROR_NONE on success
|
51
|
-
- \ref SU_ERROR_INVALID_INPUT if styles is not a valid object
|
52
|
-
- \ref SU_ERROR_NULL_POINTER_OUTPUT if count is NULL
|
51
|
+
- \ref SU_ERROR_INVALID_INPUT if \p styles is not a valid object
|
52
|
+
- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p count is NULL
|
53
53
|
*/
|
54
54
|
SU_RESULT SUStylesGetNumStyles(SUStylesRef styles, size_t* count);
|
55
55
|
|
@@ -63,8 +63,8 @@ SU_RESULT SUStylesGetNumStyles(SUStylesRef styles, size_t* count);
|
|
63
63
|
@related SUStylesRef
|
64
64
|
@return
|
65
65
|
- \ref SU_ERROR_NONE on success
|
66
|
-
- \ref SU_ERROR_INVALID_INPUT if styles is not a valid object
|
67
|
-
- \ref SU_ERROR_NULL_POINTER_OUTPUT if style_array or count is NULL
|
66
|
+
- \ref SU_ERROR_INVALID_INPUT if \p styles is not a valid object
|
67
|
+
- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p style_array or \p count is NULL
|
68
68
|
*/
|
69
69
|
SU_RESULT SUStylesGetStyles(
|
70
70
|
SUStylesRef styles, size_t len, SUStyleRef style_array[], size_t* count);
|
@@ -77,8 +77,8 @@ SU_RESULT SUStylesGetStyles(
|
|
77
77
|
@related SUStylesRef
|
78
78
|
@return
|
79
79
|
- \ref SU_ERROR_NONE on success
|
80
|
-
- \ref SU_ERROR_INVALID_INPUT if styles is not a valid object
|
81
|
-
- \ref SU_ERROR_NULL_POINTER_OUTPUT if style is NULL
|
80
|
+
- \ref SU_ERROR_INVALID_INPUT if \p styles is not a valid object
|
81
|
+
- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p style is NULL
|
82
82
|
*/
|
83
83
|
SU_RESULT SUStylesGetActiveStyle(SUStylesRef styles, SUStyleRef* style);
|
84
84
|
|
@@ -90,8 +90,8 @@ SU_RESULT SUStylesGetActiveStyle(SUStylesRef styles, SUStyleRef* style);
|
|
90
90
|
@related SUStylesRef
|
91
91
|
@return
|
92
92
|
- \ref SU_ERROR_NONE on success
|
93
|
-
- \ref SU_ERROR_INVALID_INPUT if styles is not a valid object
|
94
|
-
- \ref SU_ERROR_NULL_POINTER_OUTPUT if style is NULL
|
93
|
+
- \ref SU_ERROR_INVALID_INPUT if \p styles is not a valid object
|
94
|
+
- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p style is NULL
|
95
95
|
*/
|
96
96
|
SU_RESULT SUStylesGetSelectedStyle(SUStylesRef styles, SUStyleRef* style);
|
97
97
|
|
@@ -104,9 +104,9 @@ SU_RESULT SUStylesGetSelectedStyle(SUStylesRef styles, SUStyleRef* style);
|
|
104
104
|
@related SUStylesRef
|
105
105
|
@return
|
106
106
|
- \ref SU_ERROR_NONE on success
|
107
|
-
- \ref SU_ERROR_INVALID_INPUT if styles is not a valid object
|
108
|
-
- \ref SU_ERROR_NULL_POINTER_INPUT if guid is NULL
|
109
|
-
- \ref SU_ERROR_NULL_POINTER_OUTPUT if style is NULL
|
107
|
+
- \ref SU_ERROR_INVALID_INPUT if \p styles is not a valid object
|
108
|
+
- \ref SU_ERROR_NULL_POINTER_INPUT if \p guid is NULL
|
109
|
+
- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p style is NULL
|
110
110
|
*/
|
111
111
|
SU_RESULT SUStylesGetStyleByGuid(SUStylesRef styles, const char* guid, SUStyleRef* style);
|
112
112
|
|
@@ -119,10 +119,10 @@ SU_RESULT SUStylesGetStyleByGuid(SUStylesRef styles, const char* guid, SUStyleRe
|
|
119
119
|
@related SUStylesRef
|
120
120
|
@return
|
121
121
|
- \ref SU_ERROR_NONE on success
|
122
|
-
- \ref SU_ERROR_INVALID_INPUT if styles is not a valid object
|
123
|
-
- \ref SU_ERROR_NULL_POINTER_INPUT if path is NULL
|
124
|
-
- \ref SU_ERROR_NULL_POINTER_OUTPUT if style is NULL
|
125
|
-
- \ref SU_ERROR_NO_DATA if no style in styles matches the style at path.
|
122
|
+
- \ref SU_ERROR_INVALID_INPUT if \p styles is not a valid object
|
123
|
+
- \ref SU_ERROR_NULL_POINTER_INPUT if \p path is NULL
|
124
|
+
- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p style is NULL
|
125
|
+
- \ref SU_ERROR_NO_DATA if no style in \p styles matches the \p style at \p path.
|
126
126
|
*/
|
127
127
|
SU_RESULT SUStylesGetStyleByPath(SUStylesRef styles, const char* path, SUStyleRef* style);
|
128
128
|
|
@@ -134,8 +134,8 @@ SU_RESULT SUStylesGetStyleByPath(SUStylesRef styles, const char* path, SUStyleRe
|
|
134
134
|
@related SUStylesRef
|
135
135
|
@return
|
136
136
|
- \ref SU_ERROR_NONE on success
|
137
|
-
- \ref SU_ERROR_INVALID_INPUT if styles is not a valid object
|
138
|
-
- \ref SU_ERROR_NULL_POINTER_OUTPUT if changed is NULL
|
137
|
+
- \ref SU_ERROR_INVALID_INPUT if \p styles is not a valid object
|
138
|
+
- \ref SU_ERROR_NULL_POINTER_OUTPUT if \p changed is NULL
|
139
139
|
*/
|
140
140
|
SU_RESULT SUStylesGetActiveStyleChanged(SUStylesRef styles, bool* changed);
|
141
141
|
|
@@ -148,20 +148,22 @@ SU_RESULT SUStylesGetActiveStyleChanged(SUStylesRef styles, bool* changed);
|
|
148
148
|
@related SUStylesRef
|
149
149
|
@return
|
150
150
|
- \ref SU_ERROR_NONE on success
|
151
|
-
- \ref SU_ERROR_INVALID_INPUT if any of styles, style, or scene are not
|
151
|
+
- \ref SU_ERROR_INVALID_INPUT if any of \p styles, \p style, or \p scene are not
|
152
152
|
valid objects
|
153
153
|
*/
|
154
154
|
SU_RESULT SUStylesApplyStyleToScene(SUStylesRef styles, SUStyleRef style, SUSceneRef scene);
|
155
155
|
|
156
156
|
/**
|
157
157
|
@brief Sets the selected style.
|
158
|
+
@bug Prior to SketchUp 2025.0 setting the selected style to the active style would crash.
|
158
159
|
@since SketchUp 2019.2, API 7.1
|
159
160
|
@param[in] styles The styles object.
|
160
161
|
@param[in] style The style object.
|
161
162
|
@related SUStylesRef
|
162
163
|
@return
|
163
164
|
- \ref SU_ERROR_NONE on success
|
164
|
-
- \ref SU_ERROR_INVALID_INPUT if styles or style are not valid objects
|
165
|
+
- \ref SU_ERROR_INVALID_INPUT if \p styles or \p style are not valid objects
|
166
|
+
- \ref SU_ERROR_INVALID_ARGUMENT if \p style is the active style
|
165
167
|
*/
|
166
168
|
SU_RESULT SUStylesSetSelectedStyle(SUStylesRef styles, SUStyleRef style);
|
167
169
|
|
@@ -176,10 +178,10 @@ SU_RESULT SUStylesSetSelectedStyle(SUStylesRef styles, SUStyleRef style);
|
|
176
178
|
@related SUStylesRef
|
177
179
|
@return
|
178
180
|
- \ref SU_ERROR_NONE on success
|
179
|
-
- \ref SU_ERROR_INVALID_INPUT if styles is not a valid object
|
180
|
-
- \ref SU_ERROR_NULL_POINTER_INPUT if style is NULL
|
181
|
-
- \ref SU_ERROR_INVALID_ARGUMENT if style is not within styles
|
182
|
-
- \ref SU_ERROR_OUT_OF_RANGE if the style is the last style in the manager
|
181
|
+
- \ref SU_ERROR_INVALID_INPUT if \p styles is not a valid object
|
182
|
+
- \ref SU_ERROR_NULL_POINTER_INPUT if \p style is NULL
|
183
|
+
- \ref SU_ERROR_INVALID_ARGUMENT if \p style is not within styles
|
184
|
+
- \ref SU_ERROR_OUT_OF_RANGE if the \p style is the last style in the manager
|
183
185
|
*/
|
184
186
|
SU_RESULT SUStylesRemoveStyle(SUStylesRef styles, SUStyleRef* style);
|
185
187
|
|
@@ -155,7 +155,9 @@ SU_RESULT SUTextGetString(SUTextRef text, SUStringRef* string);
|
|
155
155
|
SU_RESULT SUTextSetFont(SUTextRef text, SUFontRef font);
|
156
156
|
|
157
157
|
/**
|
158
|
-
@brief Retrieves the font from the text object
|
158
|
+
@brief Retrieves the font from the text object.
|
159
|
+
@note The returned font reference may become invalid if another font is
|
160
|
+
assigned to this text object later.
|
159
161
|
@since SketchUp 2018, API 6.0
|
160
162
|
@param[in] text The text object.
|
161
163
|
@param[out] font The font retrieved.
|
@@ -274,16 +276,22 @@ SU_RESULT SUTextGetArrowType(SUTextRef text, enum SUArrowType* arrow_type);
|
|
274
276
|
SU_RESULT SUTextSetPoint(SUTextRef text, const struct SUPoint3D* point, SUInstancePathRef path);
|
275
277
|
|
276
278
|
/**
|
277
|
-
@brief Retrieves the point associated with the text object.
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
|
279
|
+
@brief Retrieves the point associated with the text object.
|
280
|
+
|
281
|
+
The given instance path object either must have been constructed using one of the
|
282
|
+
+SUInstancePathCreate*+ functions or it will be generated on the fly if it
|
283
|
+
is invalid. It must be released using SUInstancePathRelease() when it is no longer needed.
|
284
|
+
|
282
285
|
@since SketchUp 2018, API 6.0
|
286
|
+
|
283
287
|
@param[in] text The text object.
|
284
288
|
@param[out] point The point retrieved.
|
285
289
|
@param[out] path The path retrieved.
|
286
290
|
@related SUTextRef
|
291
|
+
|
292
|
+
@see SUInstancePathCreate
|
293
|
+
@see SUInstancePathCreateCopy
|
294
|
+
|
287
295
|
@return
|
288
296
|
- \ref SU_ERROR_NONE on success
|
289
297
|
- \ref SU_ERROR_INVALID_INPUT if text is not a valid object
|
@@ -124,11 +124,14 @@ SU_RESULT SUTextureRelease(SUTextureRef* texture);
|
|
124
124
|
|
125
125
|
/**
|
126
126
|
@brief Retrieves the pixel width, height, and scale factors of the texture.
|
127
|
-
|
127
|
+
@note The s_scale and t_scale values are useful when a face doesn't have a
|
128
128
|
material applied directly, but instead inherit from a parent group or
|
129
129
|
component instance. Then you want use these values to multiply the
|
130
130
|
result of SUMeshHelperGetFrontSTQCoords() or SUUVHelperGetFrontUVQ().
|
131
131
|
If the material is applied directly then this would not be needed.
|
132
|
+
@note For PBR textures (metallic, roughness, normal, and ambient occlusion)
|
133
|
+
the s_scale and t_scale values are only used when the PBR material
|
134
|
+
doesn't have a base texture.
|
132
135
|
@param[in] texture The texture object whose dimensions are retrieved.
|
133
136
|
@param[out] width The width in pixels.
|
134
137
|
@param[out] height The height in pixels.
|
@@ -146,6 +149,25 @@ SU_RESULT SUTextureRelease(SUTextureRef* texture);
|
|
146
149
|
SU_RESULT SUTextureGetDimensions(
|
147
150
|
SUTextureRef texture, size_t* width, size_t* height, double* s_scale, double* t_scale);
|
148
151
|
|
152
|
+
/**
|
153
|
+
@brief Sets the scale factors of the texture.
|
154
|
+
@note For PBR textures (metallic, roughness, normal, and ambient occlusion)
|
155
|
+
the \p s_scale and \p t_scale values are only used when the PBR material
|
156
|
+
doesn't have a base texture.
|
157
|
+
@since SketchUp 2025.0, API 13.0
|
158
|
+
\param texture The texture object whose dimensions are set.
|
159
|
+
\param s_scale The s coordinate scale factor to map a pixel into model
|
160
|
+
coordinates.
|
161
|
+
\param t_scale The t coordinate scale factor to map a pixel into model
|
162
|
+
coordinates.
|
163
|
+
@related SUTextureRef
|
164
|
+
@return
|
165
|
+
- \ref SU_ERROR_NONE on success
|
166
|
+
- \ref SU_ERROR_INVALID_INPUT if \p texture is an invalid object
|
167
|
+
- \ref SU_ERROR_OUT_OF_RANGE if \p s_scale, or \p t_scale is smaller or equal to 0
|
168
|
+
*/
|
169
|
+
SU_RESULT SUTextureSetDimensions(SUTextureRef texture, double s_scale, double t_scale);
|
170
|
+
|
149
171
|
/**
|
150
172
|
@brief Returns the total size and bits-per-pixel value of a texture's image
|
151
173
|
data. This function is useful to determine the size of the buffer
|
@@ -56,7 +56,7 @@ SU_RESULT SUTypedValueCreate(SUTypedValueRef* typed_value);
|
|
56
56
|
/**
|
57
57
|
@brief Releases a typed value object that was previously created with
|
58
58
|
\ref SUTypedValueCreate().
|
59
|
-
@param[in] typed_value The typed value object.
|
59
|
+
@param[in,out] typed_value The typed value object.
|
60
60
|
@related SUTypedValueRef
|
61
61
|
@return
|
62
62
|
- \ref SU_ERROR_NONE on success
|
@@ -92,8 +92,8 @@ SU_RESULT SUTypedValueGetByte(SUTypedValueRef typed_value, char* byte_value);
|
|
92
92
|
|
93
93
|
/**
|
94
94
|
@brief Sets the byte value of a typed value object.
|
95
|
-
@param[in] typed_value The typed value object.
|
96
|
-
@param[in]
|
95
|
+
@param[in,out] typed_value The typed value object.
|
96
|
+
@param[in] byte_value The byte value that is assigned.
|
97
97
|
@related SUTypedValueRef
|
98
98
|
@return
|
99
99
|
- \ref SU_ERROR_NONE on success
|
@@ -116,8 +116,8 @@ SU_RESULT SUTypedValueGetInt16(SUTypedValueRef typed_value, int16_t* int16_value
|
|
116
116
|
|
117
117
|
/**
|
118
118
|
@brief Sets the int16 value of a typed value object.
|
119
|
-
@param[in] typed_value The typed value object.
|
120
|
-
@param[in]
|
119
|
+
@param[in,out] typed_value The typed value object.
|
120
|
+
@param[in] int16_value The int16 value to set.
|
121
121
|
@related SUTypedValueRef
|
122
122
|
@return
|
123
123
|
- \ref SU_ERROR_NONE on success
|
@@ -140,8 +140,8 @@ SU_RESULT SUTypedValueGetInt32(SUTypedValueRef typed_value, int32_t* int32_value
|
|
140
140
|
|
141
141
|
/**
|
142
142
|
@brief Sets the int32 value of a typed value object.
|
143
|
-
@param[in] typed_value The typed value object.
|
144
|
-
@param[in]
|
143
|
+
@param[in,out] typed_value The typed value object.
|
144
|
+
@param[in] int32_value The int32 value to set.
|
145
145
|
@related SUTypedValueRef
|
146
146
|
@return
|
147
147
|
- \ref SU_ERROR_NONE on success
|
@@ -164,8 +164,8 @@ SU_RESULT SUTypedValueGetFloat(SUTypedValueRef typed_value, float* float_value);
|
|
164
164
|
|
165
165
|
/**
|
166
166
|
@brief Sets the float value of a typed value object.
|
167
|
-
@param[in] typed_value The typed value object.
|
168
|
-
@param[in]
|
167
|
+
@param[in,out] typed_value The typed value object.
|
168
|
+
@param[in] float_value The float value to set.
|
169
169
|
@related SUTypedValueRef
|
170
170
|
@return
|
171
171
|
- \ref SU_ERROR_NONE on success
|
@@ -188,8 +188,8 @@ SU_RESULT SUTypedValueGetDouble(SUTypedValueRef typed_value, double* double_valu
|
|
188
188
|
|
189
189
|
/**
|
190
190
|
@brief Sets the double value of a typed value object.
|
191
|
-
@param[in] typed_value The typed value object.
|
192
|
-
@param[in]
|
191
|
+
@param[in,out] typed_value The typed value object.
|
192
|
+
@param[in] double_value The double value to set.
|
193
193
|
@related SUTypedValueRef
|
194
194
|
@return
|
195
195
|
- \ref SU_ERROR_NONE on success
|
@@ -212,8 +212,8 @@ SU_RESULT SUTypedValueGetBool(SUTypedValueRef typed_value, bool* bool_value);
|
|
212
212
|
|
213
213
|
/**
|
214
214
|
@brief Sets the boolean value of a typed value object.
|
215
|
-
@param[in] typed_value The typed value object.
|
216
|
-
@param[in]
|
215
|
+
@param[in,out] typed_value The typed value object.
|
216
|
+
@param[in] bool_value The boolean value to set.
|
217
217
|
@related SUTypedValueRef
|
218
218
|
@return
|
219
219
|
- \ref SU_ERROR_NONE on success
|
@@ -236,8 +236,8 @@ SU_RESULT SUTypedValueGetColor(SUTypedValueRef typed_value, SUColor* color);
|
|
236
236
|
|
237
237
|
/**
|
238
238
|
@brief Sets the color value of a typed value object.
|
239
|
-
@param[in] typed_value The typed value object.
|
240
|
-
@param[in]
|
239
|
+
@param[in,out] typed_value The typed value object.
|
240
|
+
@param[in] color The color value to set.
|
241
241
|
@related SUTypedValueRef
|
242
242
|
@return
|
243
243
|
- \ref SU_ERROR_NONE on success
|
@@ -263,8 +263,8 @@ SU_RESULT SUTypedValueGetTime(SUTypedValueRef typed_value, int64_t* time_value);
|
|
263
263
|
/**
|
264
264
|
@brief Sets the time value of a typed value object. The time value is in
|
265
265
|
seconds since January 1, 1970.
|
266
|
-
@param[in] typed_value The typed value object.
|
267
|
-
@param[in]
|
266
|
+
@param[in,out] typed_value The typed value object.
|
267
|
+
@param[in] time_value The time value that is set.
|
268
268
|
@related SUTypedValueRef
|
269
269
|
@return
|
270
270
|
- \ref SU_ERROR_NONE on success
|
@@ -289,8 +289,8 @@ SU_RESULT SUTypedValueGetString(SUTypedValueRef typed_value, SUStringRef* string
|
|
289
289
|
|
290
290
|
/**
|
291
291
|
@brief Sets the string value of a typed value object.
|
292
|
-
@param[in] typed_value The typed value object.
|
293
|
-
@param[in]
|
292
|
+
@param[in,out] typed_value The typed value object.
|
293
|
+
@param[in] string_value The string value to set. Assumed to be UTF-8 encoded.
|
294
294
|
@related SUTypedValueRef
|
295
295
|
@return
|
296
296
|
- \ref SU_ERROR_NONE on success
|
@@ -314,8 +314,8 @@ SU_RESULT SUTypedValueGetVector3d(SUTypedValueRef typed_value, double vector3d_v
|
|
314
314
|
|
315
315
|
/**
|
316
316
|
@brief Sets the 3-element vector value of a typed value object.
|
317
|
-
@param[in] typed_value The typed value object.
|
318
|
-
@param[in]
|
317
|
+
@param[in,out] typed_value The typed value object.
|
318
|
+
@param[in] vector3d_value The 3-element vector value to set.
|
319
319
|
@related SUTypedValueRef
|
320
320
|
@return
|
321
321
|
- \ref SU_ERROR_NONE on success
|
@@ -325,8 +325,8 @@ SU_RESULT SUTypedValueSetVector3d(SUTypedValueRef typed_value, const double vect
|
|
325
325
|
|
326
326
|
/**
|
327
327
|
@brief Sets the 3D unit vector value of a typed value object.
|
328
|
-
@param[in] typed_value The typed value object.
|
329
|
-
@param[in]
|
328
|
+
@param[in,out] typed_value The typed value object.
|
329
|
+
@param[in] vector3d_value The 3 vector components. Magnitude is ignored.
|
330
330
|
@related SUTypedValueRef
|
331
331
|
@return
|
332
332
|
- \ref SU_ERROR_NONE on success
|
@@ -356,9 +356,9 @@ SU_RESULT SUTypedValueGetArrayItems(
|
|
356
356
|
/**
|
357
357
|
@brief Sets the array of typed value objects of a typed value object. The
|
358
358
|
elements of the given array are copied to the type value object.
|
359
|
-
@param[in] typed_value The typed value object.
|
360
|
-
@param[in]
|
361
|
-
@param[in]
|
359
|
+
@param[in,out] typed_value The typed value object.
|
360
|
+
@param[in] len The number of typed value objects to set.
|
361
|
+
@param[in] values The array of typed value objects to set.
|
362
362
|
@related SUTypedValueRef
|
363
363
|
@return
|
364
364
|
- \ref SU_ERROR_NONE on success
|
@@ -59,8 +59,8 @@ SU_RESULT SUVertexGetPosition(SUVertexRef vertex, struct SUPoint3D* position);
|
|
59
59
|
|
60
60
|
/**
|
61
61
|
@brief Sets the position of a vertex object.
|
62
|
-
@param[in] vertex The vertex object.
|
63
|
-
@param[in]
|
62
|
+
@param[in,out] vertex The vertex object.
|
63
|
+
@param[in] position The value used to set the vertex position.
|
64
64
|
@related SUVertexRef
|
65
65
|
@return
|
66
66
|
- \ref SU_ERROR_NONE on success
|
@@ -1,4 +1,4 @@
|
|
1
|
-
// Copyright 2015-
|
1
|
+
// Copyright 2015-2024 Trimble Inc., All rights reserved.
|
2
2
|
// This file is intended for public distribution.
|
3
3
|
|
4
4
|
/**
|
@@ -80,6 +80,8 @@
|
|
80
80
|
#include <SketchUpAPI/model/entity.h>
|
81
81
|
#include <SketchUpAPI/model/entity_list.h>
|
82
82
|
#include <SketchUpAPI/model/entity_list_iterator.h>
|
83
|
+
#include <SketchUpAPI/model/environment.h>
|
84
|
+
#include <SketchUpAPI/model/environments.h>
|
83
85
|
#include <SketchUpAPI/model/face.h>
|
84
86
|
#include <SketchUpAPI/model/font.h>
|
85
87
|
#include <SketchUpAPI/model/geometry_input.h>
|
@@ -111,6 +113,7 @@
|
|
111
113
|
#include <SketchUpAPI/model/selection.h>
|
112
114
|
#include <SketchUpAPI/model/skp.h>
|
113
115
|
#include <SketchUpAPI/model/shadow_info.h>
|
116
|
+
#include <SketchUpAPI/model/snap.h>
|
114
117
|
#include <SketchUpAPI/model/style.h>
|
115
118
|
#include <SketchUpAPI/model/styles.h>
|
116
119
|
#include <SketchUpAPI/model/text.h>
|
@@ -39,7 +39,7 @@ SU_RESULT SUStringCreate(SUStringRef* out_string_ref);
|
|
39
39
|
@brief Creates a string from a UTF-8 string.
|
40
40
|
|
41
41
|
Constructs a string and initializes it to a copy of the provided string,
|
42
|
-
which is provided by a
|
42
|
+
which is provided by a <tt>'\0'</tt> (<tt>NULL</tt>) terminated array of 8-bit characters.
|
43
43
|
This string is interpreted as UTF-8.
|
44
44
|
You must use SUStringRelease() on this string object to free its memory.
|
45
45
|
@param[out] out_string_ref The string object to be created
|
@@ -130,8 +130,8 @@ SU_RESULT SUStringGetUTF16Length(SUStringRef string_ref, size_t* out_length);
|
|
130
130
|
/**
|
131
131
|
@brief Sets the value of a string from a NULL-terminated UTF-8 character array.
|
132
132
|
|
133
|
-
@param[in] string_ref The string object.
|
134
|
-
@param[in]
|
133
|
+
@param[in,out] string_ref The string object.
|
134
|
+
@param[in] char_array The character array to be set.
|
135
135
|
@related SUStringRef
|
136
136
|
@return
|
137
137
|
- \ref SU_ERROR_NONE on success
|
@@ -143,8 +143,8 @@ SU_RESULT SUStringSetUTF8(SUStringRef string_ref, const char* char_array);
|
|
143
143
|
/**
|
144
144
|
@brief Sets the value of a string from a NULL-terminated UTF-16 character array.
|
145
145
|
|
146
|
-
@param[in] string_ref The string object.
|
147
|
-
@param[in]
|
146
|
+
@param[in,out] string_ref The string object.
|
147
|
+
@param[in] char_array The character array to be set.
|
148
148
|
@related SUStringRef
|
149
149
|
@return
|
150
150
|
- \ref SU_ERROR_NONE on success
|
@@ -197,7 +197,7 @@ SU_RESULT SUStringGetUTF16(
|
|
197
197
|
/**
|
198
198
|
@brief Trim leading white spaces from the string.
|
199
199
|
@since SketchUp 2017, API 5.0
|
200
|
-
@param[in] string_ref The string object.
|
200
|
+
@param[in,out] string_ref The string object.
|
201
201
|
@related SUStringRef
|
202
202
|
@return
|
203
203
|
- \ref SU_ERROR_NONE on success
|
@@ -208,7 +208,7 @@ SU_RESULT SUStringTrimLeft(SUStringRef string_ref);
|
|
208
208
|
/**
|
209
209
|
@brief Trim tailing white spaces from the string.
|
210
210
|
@since SketchUp 2017, API 5.0
|
211
|
-
@param[in] string_ref The string object.
|
211
|
+
@param[in,out] string_ref The string object.
|
212
212
|
@related SUStringRef
|
213
213
|
@return
|
214
214
|
- \ref SU_ERROR_NONE on success
|