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
@@ -82,90 +82,91 @@ SU_RESULT SURenderingOptionsSetValue(
|
|
82
82
|
|
83
83
|
The breakdown of rendering options and value types is shown in the table below.
|
84
84
|
|
85
|
-
Rendering Option
|
86
|
-
|
87
|
-
BackgroundColor | SUTypedValueType_Color
|
88
|
-
BandColor | SUTypedValueType_Color
|
89
|
-
ConstructionColor | SUTypedValueType_Color
|
90
|
-
DepthQueWidth | SUTypedValueType_Int32
|
91
|
-
DisplayColorByLayer | SUTypedValueType_Bool
|
92
|
-
DisplayDims | SUTypedValueType_Bool
|
93
|
-
DisplayFog | SUTypedValueType_Bool
|
94
|
-
DisplayInstanceAxes | SUTypedValueType_Bool
|
95
|
-
DisplaySectionPlanes
|
96
|
-
DisplaySectionCuts
|
97
|
-
DisplaySketchAxes | SUTypedValueType_Bool
|
98
|
-
DisplayText | SUTypedValueType_Bool
|
99
|
-
DisplayWatermarks | SUTypedValueType_Bool
|
100
|
-
DrawBackEdges
|
101
|
-
DrawDepthQue | SUTypedValueType_Bool
|
102
|
-
DrawGround | SUTypedValueType_Bool
|
103
|
-
DrawHidden | SUTypedValueType_Bool
|
104
|
-
DrawHiddenGeometry
|
105
|
-
DrawHiddenObjects
|
106
|
-
DrawHorizon | SUTypedValueType_Bool
|
107
|
-
DrawLineEnds | SUTypedValueType_Bool
|
108
|
-
DrawProfilesOnly | SUTypedValueType_Bool
|
109
|
-
DrawSilhouettes | SUTypedValueType_Bool
|
110
|
-
DrawUnderground | SUTypedValueType_Bool
|
111
|
-
EdgeColorMode | SUTypedValueType_Int32
|
112
|
-
EdgeDisplayMode | SUTypedValueType_Int32
|
113
|
-
EdgeType | SUTypedValueType_Int32
|
114
|
-
ExtendLines | SUTypedValueType_Bool
|
115
|
-
FaceBackColor | SUTypedValueType_Color
|
116
|
-
FaceFrontColor | SUTypedValueType_Color
|
117
|
-
FogColor | SUTypedValueType_Color
|
118
|
-
FogEndDist | SUTypedValueType_Double
|
119
|
-
FogStartDist | SUTypedValueType_Double
|
120
|
-
FogUseBkColor | SUTypedValueType_Bool
|
121
|
-
ForegroundColor | SUTypedValueType_Color
|
122
|
-
GroundColor | SUTypedValueType_Color
|
123
|
-
GroundTransparency | SUTypedValueType_Int32
|
124
|
-
HideConstructionGeometry | SUTypedValueType_Bool
|
125
|
-
HighlightColor | SUTypedValueType_Color
|
126
|
-
HorizonColor | SUTypedValueType_Color
|
127
|
-
InactiveFade | SUTypedValueType_Double
|
128
|
-
InactiveHidden | SUTypedValueType_Bool
|
129
|
-
InstanceFade | SUTypedValueType_Double
|
130
|
-
InstanceHidden | SUTypedValueType_Bool
|
131
|
-
JitterEdges | SUTypedValueType_Bool
|
132
|
-
LineEndWidth | SUTypedValueType_Int32
|
133
|
-
LineExtension | SUTypedValueType_Int32
|
134
|
-
LockedColor | SUTypedValueType_Color
|
135
|
-
MaterialTransparency | SUTypedValueType_Bool
|
136
|
-
ModelTransparency | SUTypedValueType_Bool
|
137
|
-
RenderMode | SUTypedValueType_Int32
|
138
|
-
SectionActiveColor | SUTypedValueType_Color
|
139
|
-
SectionCutDrawEdges
|
140
|
-
SectionCutFilled
|
141
|
-
SectionCutWidth | SUTypedValueType_Int32
|
142
|
-
SectionDefaultCutColor | SUTypedValueType_Color
|
143
|
-
SectionDefaultFillColor
|
144
|
-
SectionInactiveColor | SUTypedValueType_Color
|
145
|
-
ShowViewName | SUTypedValueType_Bool
|
146
|
-
SilhouetteWidth | SUTypedValueType_Int32
|
147
|
-
SkyColor | SUTypedValueType_Color
|
148
|
-
Texture | SUTypedValueType_Bool
|
149
|
-
TransparencySort | SUTypedValueType_Int32
|
85
|
+
Rendering Option | Value Type | Since
|
86
|
+
---------------------------- | ---------------------------- | -------------------------
|
87
|
+
`"BackgroundColor"` | \ref SUTypedValueType_Color |
|
88
|
+
`"BandColor"` | \ref SUTypedValueType_Color |
|
89
|
+
`"ConstructionColor"` | \ref SUTypedValueType_Color |
|
90
|
+
`"DepthQueWidth"` | \ref SUTypedValueType_Int32 |
|
91
|
+
`"DisplayColorByLayer"` | \ref SUTypedValueType_Bool |
|
92
|
+
`"DisplayDims"` | \ref SUTypedValueType_Bool |
|
93
|
+
`"DisplayFog"` | \ref SUTypedValueType_Bool |
|
94
|
+
`"DisplayInstanceAxes"` | \ref SUTypedValueType_Bool |
|
95
|
+
`"DisplaySectionPlanes"` | \ref SUTypedValueType_Bool | SketchUp 2014, API 2.0
|
96
|
+
`"DisplaySectionCuts"` | \ref SUTypedValueType_Bool | SketchUp 2015, API 3.0
|
97
|
+
`"DisplaySketchAxes"` | \ref SUTypedValueType_Bool |
|
98
|
+
`"DisplayText"` | \ref SUTypedValueType_Bool |
|
99
|
+
`"DisplayWatermarks"` | \ref SUTypedValueType_Bool |
|
100
|
+
`"DrawBackEdges"` | \ref SUTypedValueType_Bool | SketchUp 2015, API 3.0
|
101
|
+
`"DrawDepthQue"` | \ref SUTypedValueType_Bool |
|
102
|
+
`"DrawGround"` | \ref SUTypedValueType_Bool |
|
103
|
+
`"DrawHidden"` | \ref SUTypedValueType_Bool |
|
104
|
+
`"DrawHiddenGeometry"` | \ref SUTypedValueType_Bool | SketchUp 2020, API 8.0
|
105
|
+
`"DrawHiddenObjects"` | \ref SUTypedValueType_Bool | SketchUp 2020, API 8.0
|
106
|
+
`"DrawHorizon"` | \ref SUTypedValueType_Bool |
|
107
|
+
`"DrawLineEnds"` | \ref SUTypedValueType_Bool |
|
108
|
+
`"DrawProfilesOnly"` | \ref SUTypedValueType_Bool |
|
109
|
+
`"DrawSilhouettes"` | \ref SUTypedValueType_Bool |
|
110
|
+
`"DrawUnderground"` | \ref SUTypedValueType_Bool |
|
111
|
+
`"EdgeColorMode"` | \ref SUTypedValueType_Int32 |
|
112
|
+
`"EdgeDisplayMode"` | \ref SUTypedValueType_Int32 |
|
113
|
+
`"EdgeType"` | \ref SUTypedValueType_Int32 |
|
114
|
+
`"ExtendLines"` | \ref SUTypedValueType_Bool |
|
115
|
+
`"FaceBackColor"` | \ref SUTypedValueType_Color |
|
116
|
+
`"FaceFrontColor"` | \ref SUTypedValueType_Color |
|
117
|
+
`"FogColor"` | \ref SUTypedValueType_Color |
|
118
|
+
`"FogEndDist"` | \ref SUTypedValueType_Double |
|
119
|
+
`"FogStartDist"` | \ref SUTypedValueType_Double |
|
120
|
+
`"FogUseBkColor"` | \ref SUTypedValueType_Bool |
|
121
|
+
`"ForegroundColor"` | \ref SUTypedValueType_Color |
|
122
|
+
`"GroundColor"` | \ref SUTypedValueType_Color |
|
123
|
+
`"GroundTransparency"` | \ref SUTypedValueType_Int32 |
|
124
|
+
`"HideConstructionGeometry"` | \ref SUTypedValueType_Bool |
|
125
|
+
`"HighlightColor"` | \ref SUTypedValueType_Color |
|
126
|
+
`"HorizonColor"` | \ref SUTypedValueType_Color |
|
127
|
+
`"InactiveFade"` | \ref SUTypedValueType_Double |
|
128
|
+
`"InactiveHidden"` | \ref SUTypedValueType_Bool |
|
129
|
+
`"InstanceFade"` | \ref SUTypedValueType_Double |
|
130
|
+
`"InstanceHidden"` | \ref SUTypedValueType_Bool |
|
131
|
+
`"JitterEdges"` | \ref SUTypedValueType_Bool |
|
132
|
+
`"LineEndWidth"` | \ref SUTypedValueType_Int32 |
|
133
|
+
`"LineExtension"` | \ref SUTypedValueType_Int32 |
|
134
|
+
`"LockedColor"` | \ref SUTypedValueType_Color |
|
135
|
+
`"MaterialTransparency"` | \ref SUTypedValueType_Bool |
|
136
|
+
`"ModelTransparency"` | \ref SUTypedValueType_Bool |
|
137
|
+
`"RenderMode"` | \ref SUTypedValueType_Int32 |
|
138
|
+
`"SectionActiveColor"` | \ref SUTypedValueType_Color |
|
139
|
+
`"SectionCutDrawEdges"` | \ref SUTypedValueType_Bool | SketchUp 2015, API 3.0
|
140
|
+
`"SectionCutFilled"` | \ref SUTypedValueType_Bool | SketchUp 2018, API 6.0
|
141
|
+
`"SectionCutWidth"` | \ref SUTypedValueType_Int32 |
|
142
|
+
`"SectionDefaultCutColor"` | \ref SUTypedValueType_Color |
|
143
|
+
`"SectionDefaultFillColor"` | \ref SUTypedValueType_Color | SketchUp 2018, API 6.0
|
144
|
+
`"SectionInactiveColor"` | \ref SUTypedValueType_Color |
|
145
|
+
`"ShowViewName"` | \ref SUTypedValueType_Bool |
|
146
|
+
`"SilhouetteWidth"` | \ref SUTypedValueType_Int32 |
|
147
|
+
`"SkyColor"` | \ref SUTypedValueType_Color |
|
148
|
+
`"Texture"` | \ref SUTypedValueType_Bool |
|
149
|
+
`"TransparencySort"` | \ref SUTypedValueType_Int32 |
|
150
150
|
|
151
151
|
Some of the options map to enumerated values, as shown in the table below.
|
152
152
|
|
153
|
-
Option
|
154
|
-
|
155
|
-
EdgeColorMode | 0
|
156
|
-
|
157
|
-
|
158
|
-
EdgeDisplayMode | 0
|
159
|
-
|
160
|
-
|
161
|
-
RenderMode | 0
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
153
|
+
Option | Value | Meaning | Since
|
154
|
+
------------------ | ----- | --------------------- | --------------------------
|
155
|
+
\b EdgeColorMode | `0` | ObjectColor |
|
156
|
+
| `1` | ForegroundColor |
|
157
|
+
| `2` | DirectionColor |
|
158
|
+
\b EdgeDisplayMode | `0` | EdgeDisplayNone |
|
159
|
+
| `1` | EdgeDisplayAll |
|
160
|
+
| `2` | EdgeDisplayStandalone |
|
161
|
+
\b RenderMode | `0` | RenderWireframe |
|
162
|
+
| `1` | RenderHidden |
|
163
|
+
| `2` | RenderFlat |
|
164
|
+
| `3` | RenderSmooth |
|
165
|
+
| `4` | RenderTextureObsolete |
|
166
|
+
| `5` | RenderNoMaterials |
|
167
|
+
| `6` | RenderPhysicallyBased | SketchUp 2025.0, API 13.0
|
168
|
+
\b EdgeType | `0` | EdgeStandard |
|
169
|
+
| `1` | EdgeNPR |
|
169
170
|
|
170
171
|
@note The rendering option FaceColorMode was removed in SketchUp 2019.1.
|
171
172
|
*/
|
@@ -1,4 +1,4 @@
|
|
1
|
-
// Copyright 2013 Trimble Inc. All Rights Reserved.
|
1
|
+
// Copyright 2013-2025 Trimble Inc. All Rights Reserved.
|
2
2
|
|
3
3
|
/**
|
4
4
|
* @file
|
@@ -20,6 +20,9 @@ extern "C" {
|
|
20
20
|
@extends SUEntityRef
|
21
21
|
@brief Used to get and set a scene's camera views, using the \ref SUCameraRef
|
22
22
|
object.
|
23
|
+
|
24
|
+
@note Add the scene to the model before setting its properties, except for the name which should
|
25
|
+
be set before adding it.
|
23
26
|
*/
|
24
27
|
|
25
28
|
/**
|
@@ -30,18 +33,23 @@ extern "C" {
|
|
30
33
|
* @see SUSceneRef
|
31
34
|
* @{
|
32
35
|
*/
|
33
|
-
#define FLAG_USE_CAMERA 0x0001
|
34
|
-
#define FLAG_USE_RENDERING_OPTIONS 0x0002
|
35
|
-
#define FLAG_USE_SHADOWINFO 0x0004
|
36
|
-
#define FLAG_USE_AXES 0x0008
|
36
|
+
#define FLAG_USE_CAMERA 0x0001 ///< @since SketchUp 2017, API 5.0
|
37
|
+
#define FLAG_USE_RENDERING_OPTIONS 0x0002 ///< @since SketchUp 2017, API 5.0
|
38
|
+
#define FLAG_USE_SHADOWINFO 0x0004 ///< @since SketchUp 2017, API 5.0
|
39
|
+
#define FLAG_USE_AXES 0x0008 ///< @since SketchUp 2017, API 5.0
|
40
|
+
/// @deprecated Obsolete since SketchUp 2020.1, API 8.1. Instead, use
|
41
|
+
/// \ref FLAG_USE_HIDDEN_GEOMETRY and \ref FLAG_USE_HIDDEN_OBJECTS.
|
42
|
+
///
|
43
|
+
/// @since SketchUp 2017, API 5.0
|
37
44
|
#define FLAG_USE_HIDDEN 0x0010
|
38
|
-
#define FLAG_USE_LAYER_VISIBILITY 0x0020
|
39
|
-
#define FLAG_USE_SECTION_PLANES 0x0040
|
40
|
-
#define FLAG_USE_HIDDEN_GEOMETRY 0x0080
|
41
|
-
#define FLAG_USE_HIDDEN_OBJECTS 0x0100
|
42
|
-
|
43
|
-
|
44
|
-
#define
|
45
|
+
#define FLAG_USE_LAYER_VISIBILITY 0x0020 ///< @since SketchUp 2017, API 5.0
|
46
|
+
#define FLAG_USE_SECTION_PLANES 0x0040 ///< @since SketchUp 2017, API 5.0
|
47
|
+
#define FLAG_USE_HIDDEN_GEOMETRY 0x0080 ///< @since SketchUp 2020.1, API 8.1
|
48
|
+
#define FLAG_USE_HIDDEN_OBJECTS 0x0100 ///< @since SketchUp 2020.1, API 8.1
|
49
|
+
#define FLAG_USE_ENVIRONMENT 0x0200 ///< @since SketchUp 2025.0, API 13.0
|
50
|
+
|
51
|
+
#define FLAG_USE_ALL 0x0fff ///< @since SketchUp 2017, API 5.0
|
52
|
+
#define FLAG_NO_CAMERA 0x0ffe ///< @since SketchUp 2017, API 5.0
|
45
53
|
/**@}*/
|
46
54
|
|
47
55
|
/**
|
@@ -69,12 +77,31 @@ SU_EXPORT SUSceneRef SUSceneFromEntity(SUEntityRef entity);
|
|
69
77
|
|
70
78
|
/**
|
71
79
|
@brief Creates an empty scene object.
|
80
|
+
|
81
|
+
@note The created scene will not save any scene properties until
|
82
|
+
the \ref SUSceneFlags bits are set.
|
83
|
+
|
72
84
|
@param[out] scene The scene object created.
|
73
85
|
@related SUSceneRef
|
74
86
|
@return
|
75
87
|
- \ref SU_ERROR_NONE on success
|
76
88
|
- \ref SU_ERROR_NULL_POINTER_INPUT if scene is NULL
|
77
89
|
- \ref SU_ERROR_OVERWRITE_VALID if face already refers to a valid object
|
90
|
+
|
91
|
+
@see SUSceneSetFlags
|
92
|
+
@see SUModelAddScenes
|
93
|
+
|
94
|
+
@code
|
95
|
+
SUScene scene = SU_INVALID;
|
96
|
+
SUSceneCreate(&scene);
|
97
|
+
SUSceneSetName(scene, "Example"); // Must be unique.
|
98
|
+
SUSceneSetFlags(scene, FLAG_USE_ALL); // Set the properties to remember.
|
99
|
+
SUModelAddScenes(model, 1, &scene); // This will also update the scene based on the flags set.
|
100
|
+
|
101
|
+
// Set scene properties after adding it to the model.
|
102
|
+
// ...
|
103
|
+
SUSceneSetCamera(scene, eye, target, up);
|
104
|
+
@endcode
|
78
105
|
*/
|
79
106
|
SU_RESULT SUSceneCreate(SUSceneRef* scene);
|
80
107
|
|
@@ -115,9 +142,11 @@ SU_RESULT SUSceneGetUseCamera(SUSceneRef scene, bool* use_camera);
|
|
115
142
|
SU_RESULT SUSceneSetUseCamera(SUSceneRef scene, bool use_camera);
|
116
143
|
|
117
144
|
/**
|
118
|
-
@brief Retrieves the camera of a scene object.
|
119
|
-
|
120
|
-
|
145
|
+
@brief Retrieves the camera of a scene object.
|
146
|
+
|
147
|
+
@note The returned camera object points to scene's internal camera. So the
|
148
|
+
camera must not be released via SUCameraRelease().
|
149
|
+
|
121
150
|
@param[in] scene The scene object.
|
122
151
|
@param[out] camera The camera object retrieved.
|
123
152
|
@related SUSceneRef
|
@@ -129,10 +158,12 @@ SU_RESULT SUSceneSetUseCamera(SUSceneRef scene, bool use_camera);
|
|
129
158
|
SU_RESULT SUSceneGetCamera(SUSceneRef scene, SUCameraRef* camera);
|
130
159
|
|
131
160
|
/**
|
132
|
-
@brief Sets a given scene's camera object.
|
133
|
-
|
134
|
-
|
135
|
-
|
161
|
+
@brief Sets a given scene's camera object.
|
162
|
+
|
163
|
+
@note The scene does not take ownership of the provided camera, it just copies
|
164
|
+
the properties to the scene's owned camera. If the input camera was created
|
165
|
+
using SUCameraCreate() it must be released using SUCameraRelease().
|
166
|
+
|
136
167
|
@since SketchUp 2016, API 4.0
|
137
168
|
@param[in] scene The scene object.
|
138
169
|
@param[in] camera The camera object to be set.
|
@@ -188,7 +219,7 @@ SU_RESULT SUSceneGetName(SUSceneRef scene, SUStringRef* name);
|
|
188
219
|
@brief Sets the name of a scene object.
|
189
220
|
|
190
221
|
@warning Breaking Change: The behavior of SUSceneSetName changed in
|
191
|
-
SketchUp
|
222
|
+
SketchUp 2018, API 6.0 to return \ref SU_ERROR_INVALID_ARGUMENT if the
|
192
223
|
given name already exists in the scene's model.
|
193
224
|
|
194
225
|
@param[in] scene The scene object.
|
@@ -293,6 +324,8 @@ SU_RESULT SUSceneSetUseRenderingOptions(SUSceneRef scene, bool use_rendering_opt
|
|
293
324
|
@param[out] use_hidden The current setting for whether or not the hidden
|
294
325
|
property of entities is used.
|
295
326
|
@related SUSceneRef
|
327
|
+
@see SUSceneGetUseHiddenGeometry
|
328
|
+
@see SUSceneGetUseHiddenObjects
|
296
329
|
@return
|
297
330
|
- \ref SU_ERROR_NONE on success
|
298
331
|
- \ref SU_ERROR_INVALID_INPUT if scene is not a valid object
|
@@ -309,6 +342,8 @@ SU_RESULT SUSceneGetUseHidden(SUSceneRef scene, bool* use_hidden);
|
|
309
342
|
@param[in] use_hidden The new setting for whether or not the hidden
|
310
343
|
property of entities is used.
|
311
344
|
@related SUSceneRef
|
345
|
+
@see SUSceneSetUseHiddenGeometry
|
346
|
+
@see SUSceneSetUseHiddenObjects
|
312
347
|
@return
|
313
348
|
- \ref SU_ERROR_NONE on success
|
314
349
|
- \ref SU_ERROR_INVALID_INPUT if scene is not a valid object
|
@@ -322,6 +357,9 @@ SU_RESULT SUSceneSetUseHidden(SUSceneRef scene, bool use_hidden);
|
|
322
357
|
@param[out] use_hidden The current setting for whether or not the hidden
|
323
358
|
property of root-level entities is used.
|
324
359
|
@related SUSceneRef
|
360
|
+
@see SUSceneSetUseHiddenGeometry
|
361
|
+
@see SUSceneGetUseHiddenObjects
|
362
|
+
@see SUSceneSetUseHiddenObjects
|
325
363
|
@return
|
326
364
|
- \ref SU_ERROR_NONE on success
|
327
365
|
- \ref SU_ERROR_INVALID_INPUT if scene is not a valid object
|
@@ -336,6 +374,9 @@ SU_RESULT SUSceneGetUseHiddenGeometry(SUSceneRef scene, bool* use_hidden);
|
|
336
374
|
@param[in] use_hidden The new setting for whether or not the hidden
|
337
375
|
property of root-level entities is used.
|
338
376
|
@related SUSceneRef
|
377
|
+
@see SUSceneGetUseHiddenGeometry
|
378
|
+
@see SUSceneGetUseHiddenObjects
|
379
|
+
@see SUSceneSetUseHiddenObjects
|
339
380
|
@return
|
340
381
|
- \ref SU_ERROR_NONE on success
|
341
382
|
- \ref SU_ERROR_INVALID_INPUT if scene is not a valid object
|
@@ -349,6 +390,9 @@ SU_RESULT SUSceneSetUseHiddenGeometry(SUSceneRef scene, bool use_hidden);
|
|
349
390
|
@param[out] use_hidden The current setting for whether or not the hidden
|
350
391
|
property of objects is used.
|
351
392
|
@related SUSceneRef
|
393
|
+
@see SUSceneGetUseHiddenGeometry
|
394
|
+
@see SUSceneSetUseHiddenGeometry
|
395
|
+
@see SUSceneSetUseHiddenObjects
|
352
396
|
@return
|
353
397
|
- \ref SU_ERROR_NONE on success
|
354
398
|
- \ref SU_ERROR_INVALID_INPUT if scene is not a valid object
|
@@ -363,6 +407,9 @@ SU_RESULT SUSceneGetUseHiddenObjects(SUSceneRef scene, bool* use_hidden);
|
|
363
407
|
@param[in] use_hidden The new setting for whether or not the hidden
|
364
408
|
property of objects is used.
|
365
409
|
@related SUSceneRef
|
410
|
+
@see SUSceneGetUseHiddenGeometry
|
411
|
+
@see SUSceneSetUseHiddenGeometry
|
412
|
+
@see SUSceneGetUseHiddenObjects
|
366
413
|
@return
|
367
414
|
- \ref SU_ERROR_NONE on success
|
368
415
|
- \ref SU_ERROR_INVALID_INPUT if scene is not a valid object
|
@@ -454,11 +501,13 @@ SU_RESULT SUSceneGetLayers(SUSceneRef scene, size_t len, SULayerRef layers[], si
|
|
454
501
|
/**
|
455
502
|
@brief Adds the specified layer to the provided scene.
|
456
503
|
|
457
|
-
|
458
|
-
|
459
|
-
|
504
|
+
@note Adding a layer to a scene will flag the layer to be the opposite of its
|
505
|
+
default scene visibility. See \ref SULayerVisibilityDefaultType. This
|
506
|
+
function does not take ownership of the specified layer.
|
507
|
+
|
460
508
|
@note Prior to SketchUp 2020.0, API 8.0 this function did not return
|
461
|
-
SU_ERROR_INVALID_ARGUMENT.
|
509
|
+
\ref SU_ERROR_INVALID_ARGUMENT.
|
510
|
+
|
462
511
|
@since SketchUp 2016, API 4.0
|
463
512
|
@param[in] scene The scene object.
|
464
513
|
@param[in] layer The new layer to be added to the scene.
|
@@ -475,11 +524,13 @@ SU_RESULT SUSceneAddLayer(SUSceneRef scene, SULayerRef layer);
|
|
475
524
|
/**
|
476
525
|
@brief Removes the specified layer from the provided scene.
|
477
526
|
|
478
|
-
|
479
|
-
|
480
|
-
|
527
|
+
@note Removing a layer from a scene will flag the layer to use its default
|
528
|
+
scene visibility. See \ref SULayerVisibilityDefaultType. Scenes do not
|
529
|
+
own their layers so removing them doesn't release them.
|
530
|
+
|
481
531
|
@note Prior to SketchUp 2020.0, API 8.0 this function did not return
|
482
|
-
SU_ERROR_INVALID_ARGUMENT.
|
532
|
+
\ref SU_ERROR_INVALID_ARGUMENT.
|
533
|
+
|
483
534
|
@since SketchUp 2016, API 4.0
|
484
535
|
@param[in] scene The scene object.
|
485
536
|
@param[in] layer The layer to be removed from the scene.
|
@@ -535,11 +586,12 @@ SU_RESULT SUSceneGetLayerFolders(
|
|
535
586
|
/**
|
536
587
|
@brief Adds the specified layer folder to the provided scene.
|
537
588
|
|
538
|
-
|
539
|
-
|
540
|
-
|
541
|
-
|
542
|
-
|
589
|
+
@note Adding a layer folder to a scene will cause that layer folder to be
|
590
|
+
flagged as HIDDEN for the specified scene. Any layers or layer folders
|
591
|
+
within that layer folder will also be hidden, and therefore don't need to
|
592
|
+
be added to the scene. This function does not take ownership of the
|
593
|
+
specified layer folder.
|
594
|
+
|
543
595
|
@since SketchUp 2021.0, API 9.0
|
544
596
|
@param[in] scene The scene object.
|
545
597
|
@param[in] layer_folder The new layer folder to be added to \p scene.
|
@@ -556,9 +608,10 @@ SU_RESULT SUSceneAddLayerFolder(SUSceneRef scene, SULayerFolderRef layer_folder)
|
|
556
608
|
/**
|
557
609
|
@brief Removes the specified layer folder from the provided scene.
|
558
610
|
|
559
|
-
|
560
|
-
|
561
|
-
|
611
|
+
@note Removing a layer folder from a scene will cause that layer folder to be
|
612
|
+
flagged as VISIBLE for the specified scene. Scenes do not own their layer
|
613
|
+
folders so removing them doesn't release them.
|
614
|
+
|
562
615
|
@since SketchUp 2021.0, API 9.0
|
563
616
|
@param[in] scene The scene object.
|
564
617
|
@param[in] layer_folder The layer folder to be removed from \p scene.
|
@@ -652,31 +705,43 @@ SU_RESULT SUSceneGetHiddenEntities(
|
|
652
705
|
/**
|
653
706
|
@brief Sets the flags for a scene object.
|
654
707
|
|
655
|
-
|
708
|
+
@note If this function is called after the scene has been added to the model the API user *must*
|
709
|
+
call SUSceneUpdate(). Otherwise it can lead to a crash while interacting with the model.
|
710
|
+
In general it is recommended to use the separate `SUSceneSetUse*` setters after the scene has
|
711
|
+
been added to the model.
|
712
|
+
|
713
|
+
@note \ref FLAG_USE_HIDDEN is deprecated and the bits for \ref FLAG_USE_HIDDEN_GEOMETRY and
|
714
|
+
\ref FLAG_USE_HIDDEN_OBJECTS will take precedence.
|
656
715
|
|
657
716
|
@since SketchUp 2017, API 5.0
|
658
717
|
@param[in] scene The scene object.
|
659
|
-
@param[in] flags
|
718
|
+
@param[in] flags A bitwise combination of \ref SUSceneFlags.
|
660
719
|
@related SUSceneRef
|
661
720
|
@return
|
662
721
|
- \ref SU_ERROR_NONE on success
|
663
722
|
- \ref SU_ERROR_INVALID_INPUT if scene is not a valid object
|
723
|
+
|
724
|
+
@see SUSceneFlags
|
725
|
+
@see SUSceneGetFlags
|
726
|
+
@see SUSceneUpdate
|
664
727
|
*/
|
665
728
|
SU_RESULT SUSceneSetFlags(SUSceneRef scene, uint32_t flags);
|
666
729
|
|
667
730
|
/**
|
668
731
|
@brief Retrieves the flags in the scene object.
|
669
732
|
|
670
|
-
See \ref SUSceneFlags "Scene Flags" for available flags that can be combined bitwise.
|
671
|
-
|
672
733
|
@since SketchUp 2017, API 5.0
|
673
734
|
@param[in] scene The scene object.
|
674
|
-
@param[out] flags
|
735
|
+
@param[out] flags A bitwise combination of \ref SUSceneFlags.
|
675
736
|
@related SUSceneRef
|
676
737
|
@return
|
677
738
|
- \ref SU_ERROR_NONE on success
|
678
739
|
- \ref SU_ERROR_INVALID_INPUT if scene is not a valid object
|
679
740
|
- \ref SU_ERROR_NULL_POINTER_OUTPUT if flags is NULL
|
741
|
+
|
742
|
+
@see SUSceneFlags
|
743
|
+
@see SUSceneSetFlags
|
744
|
+
|
680
745
|
*/
|
681
746
|
SU_RESULT SUSceneGetFlags(SUSceneRef scene, uint32_t* flags);
|
682
747
|
|
@@ -771,7 +836,7 @@ SU_RESULT SUSceneActivate(SUSceneRef scene);
|
|
771
836
|
@brief Set the visibility of a drawing element in a scene.
|
772
837
|
@since SketchUp 2020, API 8.0
|
773
838
|
@note Only drawing elements at the root of the model, or nested instances of
|
774
|
-
|
839
|
+
components, groups, and images are controlled by scene visibility.
|
775
840
|
@param[in] scene The scene object.
|
776
841
|
@param[in] drawing_element The drawing element object.
|
777
842
|
@param[in] is_hidden The new setting for whether or not the
|
@@ -829,6 +894,121 @@ SU_RESULT SUSceneGetDescription(SUSceneRef scene, SUStringRef* desc);
|
|
829
894
|
*/
|
830
895
|
SU_RESULT SUSceneSetDescription(SUSceneRef scene, const char* desc);
|
831
896
|
|
897
|
+
/**
|
898
|
+
* @brief Enables the use of an environment for a scene.
|
899
|
+
* @since SketchUp 2025.0, API 13.0
|
900
|
+
* @param[in] scene The scene object.
|
901
|
+
* @param[in] use_environment The setting whether a scene should use an environment.
|
902
|
+
* @related SUSceneRef
|
903
|
+
* @return
|
904
|
+
* - \ref SU_ERROR_NONE on success
|
905
|
+
* - \ref SU_ERROR_INVALID_INPUT if \p scene is not a valid object
|
906
|
+
*/
|
907
|
+
SU_RESULT SUSceneSetUseEnvironment(SUSceneRef scene, bool use_environment);
|
908
|
+
|
909
|
+
/**
|
910
|
+
* @brief Retrieves the setting whether a scene uses an environment.
|
911
|
+
* @since SketchUp 2025.0, API 13.0
|
912
|
+
* @param[in] scene The scene object.
|
913
|
+
* @param[out] use_environment The setting whether a scene should use an environment.
|
914
|
+
* @related SUSceneRef
|
915
|
+
* @return
|
916
|
+
* - \ref SU_ERROR_NONE on success
|
917
|
+
* - \ref SU_ERROR_INVALID_INPUT if \p scene is not a valid object
|
918
|
+
* - \ref SU_ERROR_NULL_POINTER_OUTPUT if \p use_environment is `NULL`
|
919
|
+
*/
|
920
|
+
SU_RESULT SUSceneGetUseEnvironment(SUSceneRef scene, bool* use_environment);
|
921
|
+
|
922
|
+
/**
|
923
|
+
* @brief Sets the environment for a scene.
|
924
|
+
* @since SketchUp 2025.0, API 13.0
|
925
|
+
* @param[in] scene The scene object.
|
926
|
+
* @param[in] environment The environment object to be set.
|
927
|
+
* @related SUSceneRef
|
928
|
+
* @return
|
929
|
+
* - \ref SU_ERROR_NONE on success
|
930
|
+
* - \ref SU_ERROR_INVALID_INPUT if \p scene is not a valid object
|
931
|
+
*/
|
932
|
+
SU_RESULT SUSceneSetEnvironment(SUSceneRef scene, SUEnvironmentRef environment);
|
933
|
+
|
934
|
+
/**
|
935
|
+
* @brief Retrieves the environment of a scene.
|
936
|
+
* @since SketchUp 2025.0, API 13.0
|
937
|
+
* @param[in] scene The scene object.
|
938
|
+
* @param[out] environment The environment object to be retrieved.
|
939
|
+
* @related SUSceneRef
|
940
|
+
* @return
|
941
|
+
* - \ref SU_ERROR_NONE on success
|
942
|
+
* - \ref SU_ERROR_INVALID_INPUT if \p scene is not a valid object
|
943
|
+
* - \ref SU_ERROR_NULL_POINTER_OUTPUT if \p environment is `NULL`
|
944
|
+
* - \ref SU_ERROR_NO_DATA if the scene does not have an environment
|
945
|
+
*/
|
946
|
+
SU_RESULT SUSceneGetEnvironment(SUSceneRef scene, SUEnvironmentRef* environment);
|
947
|
+
|
948
|
+
/**
|
949
|
+
* @brief Retrieves the number of section planes that will be activated when the scene is activated.
|
950
|
+
* @since SketchUp 2025.1, API 13.1
|
951
|
+
* @param[in] scene The scene object.
|
952
|
+
* @param[out] count The number of section planes.
|
953
|
+
* @related SUSceneRef
|
954
|
+
* @return
|
955
|
+
* - \ref SU_ERROR_NONE on success
|
956
|
+
* - \ref SU_ERROR_INVALID_INPUT if \p scene is not a valid object
|
957
|
+
* - \ref SU_ERROR_NULL_POINTER_OUTPUT if \p count is `NULL`
|
958
|
+
*/
|
959
|
+
SU_RESULT SUSceneGetNumActiveSectionPlanes(SUSceneRef scene, size_t* count);
|
960
|
+
|
961
|
+
/**
|
962
|
+
* @brief Retrieves the section planes that will be activated when the scene is activated.
|
963
|
+
* @since SketchUp 2025.1, API 13.1
|
964
|
+
* @param[in] scene The scene object.
|
965
|
+
* @param[in] len The number of section planes to retrieve.
|
966
|
+
* @param[out] active_section_planes The section planes retrieved.
|
967
|
+
* @param[out] count The number of section planes retrieved.
|
968
|
+
* @related SUSceneRef
|
969
|
+
* @return
|
970
|
+
* - \ref SU_ERROR_NONE on success
|
971
|
+
* - \ref SU_ERROR_INVALID_INPUT if \p scene is not a valid object
|
972
|
+
* - \ref SU_ERROR_NULL_POINTER_OUTPUT if \p active_section_planes or \p count is `NULL`
|
973
|
+
*/
|
974
|
+
SU_RESULT SUSceneGetActiveSectionPlanes(
|
975
|
+
SUSceneRef scene, size_t len, SUSectionPlaneRef active_section_planes[], size_t* count);
|
976
|
+
|
977
|
+
/**
|
978
|
+
* @brief Performs an update on the scene properties based on the current view that the use has.
|
979
|
+
*
|
980
|
+
* What properties of the Scene get updated are controlled via an integer whose bits corresponds to
|
981
|
+
* different properties. These flags can be used individually or combined using bitwise OR.
|
982
|
+
*
|
983
|
+
* @note The properties updated is determined by the AND operation of the passed in \p flags and
|
984
|
+
* the flags on the scene set by SUSceneSetFlags() or the separate `SUSceneSetUse*` setters.
|
985
|
+
*
|
986
|
+
* @since SketchUp 2025.0, API 13.0
|
987
|
+
*
|
988
|
+
* @param[in] scene The \p scene object.
|
989
|
+
* @param[in] flags The bitwise OR of \ref SUSceneFlags.
|
990
|
+
* @return
|
991
|
+
* - \ref SU_ERROR_NONE on success
|
992
|
+
* - \ref SU_ERROR_INVALID_INPUT if \p scene is not a valid object
|
993
|
+
* - \ref SU_ERROR_INVALID_ARGUMENT if \p scene is not added to a model
|
994
|
+
*
|
995
|
+
* @related SUSceneRef
|
996
|
+
*
|
997
|
+
* @see \ref SUSceneFlags
|
998
|
+
* @see SUSceneSetFlags
|
999
|
+
*
|
1000
|
+
* @code
|
1001
|
+
* SUScene scene = SU_INVALID;
|
1002
|
+
* SUSceneCreate(&scene);
|
1003
|
+
* SUSceneSetName(scene, "Example");
|
1004
|
+
* SUSceneSetFlags(scene, FLAG_USE_ALL); // Set the properties to remember.
|
1005
|
+
* SUModelAddScenes(model, 1, &scene);
|
1006
|
+
* // ...
|
1007
|
+
* SUSceneUpdate(scene, FLAG_USE_CAMERA | FLAG_USE_SECTION_PLANES);
|
1008
|
+
* @endcode
|
1009
|
+
*/
|
1010
|
+
SU_RESULT SUSceneUpdate(SUSceneRef scene, unsigned int flags);
|
1011
|
+
|
832
1012
|
#ifdef __cplusplus
|
833
1013
|
}
|
834
1014
|
#endif
|