SketchUp C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Functions
entities.h File Reference
#include <SketchUpAPI/geometry.h>
#include <SketchUpAPI/common.h>
#include <SketchUpAPI/unicodestring.h>
#include <SketchUpAPI/model/curve.h>
#include <SketchUpAPI/model/defs.h>

Go to the source code of this file.

Functions

SU_RESULT SUEntitiesClear (SUEntitiesRef entities)
 Removes all entities in the container. More...
 
SU_RESULT SUEntitiesFill (SUEntitiesRef entities, SUGeometryInputRef geom_input, bool weld_vertices)
 SUEntitiesFill is the fastest way to populate an entities object. The important precondition is that no duplicate data should be given. More...
 
SU_RESULT SUEntitiesGetBoundingBox (SUEntitiesRef entities, struct SUBoundingBox3D *bbox)
 Retrieves the bounding box of the entities. More...
 
SU_RESULT SUEntitiesGetBoundingBoxLLA (SUEntitiesRef entities, struct SUBoundingBox3D *bbox)
 Retrieves the LLA coordinates (Latidue, Longitude and Altitude) bounding box of the given entities object. Note that the altitude is calculated based on the model origin, Example: If an entities object has a bounding box with the following values {{100,100,100}, {200,200,200}} the result will be something like the following: {{Latitude, Longitude, 100/METERS_TO_INCHES}, {Latitude, Longitude, 200/METERS_TO_INCHES}} where Latitude and Longitude are the geographical coordinates and altitude is just a conversion from inches to meters. More...
 
SU_RESULT SUEntitiesGetNumFaces (SUEntitiesRef entities, size_t *count)
 Retrieves the number of faces in the entities object. More...
 
SU_RESULT SUEntitiesGetFaces (SUEntitiesRef entities, size_t len, SUFaceRef faces[], size_t *count)
 Retrieves the faces in the entities object. More...
 
SU_RESULT SUEntitiesGetNumCurves (SUEntitiesRef entities, size_t *count)
 Retrieves the number of curves in the entities object that are not associated with a face. More...
 
SU_RESULT SUEntitiesGetCurves (SUEntitiesRef entities, size_t len, SUCurveRef curves[], size_t *count)
 Retrieves the curves in the entities object that are not associated with a face. More...
 
SU_RESULT SUEntitiesGetNumArcCurves (SUEntitiesRef entities, size_t *count)
 Retrieves the number of arccurves in the entities object that are not associated with a face. More...
 
SU_RESULT SUEntitiesGetArcCurves (SUEntitiesRef entities, size_t len, SUArcCurveRef arccurves[], size_t *count)
 Retrieves the arccurves in the entities object that are not associated with a face. More...
 
SU_RESULT SUEntitiesGetNumGuidePoints (SUEntitiesRef entities, size_t *count)
 Retrieves the number of guide points in the entities object. More...
 
SU_RESULT SUEntitiesGetGuidePoints (SUEntitiesRef entities, size_t len, SUGuidePointRef guide_points[], size_t *count)
 Retrieves the guide points in the entities object. More...
 
SU_RESULT SUEntitiesGetNumGuideLines (SUEntitiesRef entities, size_t *count)
 Retrieves the number of guide lines in the entities object. More...
 
SU_RESULT SUEntitiesGetGuideLines (SUEntitiesRef entities, size_t len, SUGuideLineRef guide_lines[], size_t *count)
 Retrieves the guide lines in the entities object. More...
 
SU_RESULT SUEntitiesGetNumEdges (SUEntitiesRef entities, bool standalone_only, size_t *count)
 Retrieves the number of edges in the entities object. More...
 
SU_RESULT SUEntitiesGetEdges (SUEntitiesRef entities, bool standalone_only, size_t len, SUEdgeRef edges[], size_t *count)
 Retrieves the edges in the entities object. More...
 
SU_RESULT SUEntitiesGetNumPolyline3ds (SUEntitiesRef entities, size_t *count)
 Retrieves the number of polyline3d's in the entities object. More...
 
SU_RESULT SUEntitiesGetPolyline3ds (SUEntitiesRef entities, size_t len, SUPolyline3dRef lines[], size_t *count)
 Retrieves the polyline3d's in the entities object. More...
 
SU_RESULT SUEntitiesAddFaces (SUEntitiesRef entities, size_t len, const SUFaceRef faces[])
 Adds face objects to a entities object. More...
 
SU_RESULT SUEntitiesAddEdges (SUEntitiesRef entities, size_t len, const SUEdgeRef edges[])
 Adds edge objects to an entities object. More...
 
SU_RESULT SUEntitiesAddCurves (SUEntitiesRef entities, size_t len, const SUCurveRef curves[])
 Adds curve objects to an entities object. More...
 
SU_RESULT SUEntitiesAddArcCurves (SUEntitiesRef entities, size_t len, const SUArcCurveRef curves[])
 Adds arccurve objects to an entities object. More...
 
SU_RESULT SUEntitiesAddGuidePoints (SUEntitiesRef entities, size_t len, const SUGuidePointRef guide_points[])
 Adds guide point objects to an entities object. More...
 
SU_RESULT SUEntitiesAddGuideLines (SUEntitiesRef entities, size_t len, const SUGuideLineRef guide_lines[])
 Adds guide line objects to an entities object. More...
 
SU_RESULT SUEntitiesAddGroup (SUEntitiesRef entities, SUGroupRef group)
 Adds a group object to an entities object. More...
 
SU_RESULT SUEntitiesAddImage (SUEntitiesRef entities, SUImageRef image)
 Adds an image object to an entities object. More...
 
SU_RESULT SUEntitiesAddInstance (SUEntitiesRef entities, SUComponentInstanceRef instance, SUStringRef *name)
 Adds a component instance object to the entities. More...
 
SU_RESULT SUEntitiesAddSectionPlanes (SUEntitiesRef entities, size_t len, const SUSectionPlaneRef section_planes[])
 Adds section plane objects to an entities object. More...
 
SU_RESULT SUEntitiesAddTexts (SUEntitiesRef entities, size_t len, const SUTextRef texts[])
 Adds text objects to an entities object. More...
 
SU_RESULT SUEntitiesGetNumGroups (SUEntitiesRef entities, size_t *count)
 Retrieves the number of groups in the entities. More...
 
SU_RESULT SUEntitiesGetGroups (SUEntitiesRef entities, size_t len, SUGroupRef groups[], size_t *count)
 Retrieves the groups in the entities. More...
 
SU_RESULT SUEntitiesGetNumImages (SUEntitiesRef entities, size_t *count)
 Retrieves the number of images in the entities. More...
 
SU_RESULT SUEntitiesGetImages (SUEntitiesRef entities, size_t len, SUImageRef images[], size_t *count)
 Retrieves the array of image objects of a entities object. More...
 
SU_RESULT SUEntitiesGetNumInstances (SUEntitiesRef entities, size_t *count)
 Retrieves the number of component instances in the entities. More...
 
SU_RESULT SUEntitiesGetInstances (SUEntitiesRef entities, size_t len, SUComponentInstanceRef instances[], size_t *count)
 Retrieves the component instances in the entities. More...
 
SU_RESULT SUEntitiesGetNumSectionPlanes (SUEntitiesRef entities, size_t *count)
 Retrieves the number of section planes in the entities object. More...
 
SU_RESULT SUEntitiesGetNumTexts (SUEntitiesRef entities, size_t *count)
 Retrieves the number of texts in the entities object. More...
 
SU_RESULT SUEntitiesGetSectionPlanes (SUEntitiesRef entities, size_t len, SUSectionPlaneRef section_planes[], size_t *count)
 Retrieves the section planes in the entities. More...
 
SU_RESULT SUEntitiesGetNumDimensions (SUEntitiesRef entities, size_t *count)
 Retrieves the number of dimensions in the entities object. More...
 
SU_RESULT SUEntitiesGetDimensions (SUEntitiesRef entities, size_t len, SUDimensionRef *dimensions, size_t *count)
 Retrieves the dimensions in the entities object. More...
 
SU_RESULT SUEntitiesGetTexts (SUEntitiesRef entities, size_t len, SUTextRef texts[], size_t *count)
 Retrieves the texts in the entities. More...
 
SU_RESULT SUEntitiesTransform (SUEntitiesRef entities, size_t len, SUEntityRef elements[], const struct SUTransformation *trans)
 Applies a 3D transformation to the elements of the provided entity array. More...
 
SU_RESULT SUEntitiesTransformMultiple (SUEntitiesRef entities, size_t len, SUEntityRef elements[], const struct SUTransformation tranforms[])
 Applies a 3D transformations to the elements of the provided entity array. The arrays of elements and transformations must be the same length. More...
 
SU_RESULT SUEntitiesErase (SUEntitiesRef entities, size_t len, SUEntityRef elements[])
 Erases elements from an entities object. The input elements are destroyed, so the array elements are invalidated to prevent user from attempting to use destroyed entities. More...
 
SU_RESULT SUEntitiesIsRecursivelyEmpty (SUEntitiesRef entities, bool *is_empty)
 Retrieves a boolean indicating whether the entities object is recursively empty. A recursively empty entities object is defined as one that either has zero entities or contains only instances of definitions with recursively empty entities objects. More...
 
SU_RESULT SUEntitiesHasSectionCuts (SUEntitiesRef entities, bool *has_section_cuts)
 Retrieves a boolean by recursively searching through the entities determining whether the entities has an active section plane or any of its nested components have an active section plane. More...
 
SU_RESULT SUEntitiesEntityListFill (SUEntitiesRef entities, enum SURefType type, SUEntityListRef list)
 Fills the list with all entities of the specified type in the instance. The list is not in any specific order. More...
 

Function Documentation

SU_RESULT SUEntitiesAddArcCurves ( SUEntitiesRef  entities,
size_t  len,
const SUArcCurveRef  curves[] 
)

Adds arccurve objects to an entities object.

Since
SketchUp 2016, API 4.0

NOTE: This function does not merge geometry, which will likely create an invalid SketchUp model. It is recommended to use SUGeometryInput instead which does correctly merge geometry.

Parameters
[in]entitiesThe entities object.
[in]lenThe length of the array of curve objects.
[in]curvesThe array of arccurve objects to add.
Returns
SU_RESULT SUEntitiesAddCurves ( SUEntitiesRef  entities,
size_t  len,
const SUCurveRef  curves[] 
)

Adds curve objects to an entities object.

NOTE: This function does not merge geometry, which will likely create an invalid SketchUp model. It is recommended to use SUGeometryInput instead which does correctly merge geometry.

Parameters
[in]entitiesThe entities object.
[in]lenThe length of the array of curve objects.
[in]curvesThe array of curve objects to add.
Returns
SU_RESULT SUEntitiesAddEdges ( SUEntitiesRef  entities,
size_t  len,
const SUEdgeRef  edges[] 
)

Adds edge objects to an entities object.

NOTE: This function does not merge geometry, which will likely create an invalid SketchUp model. It is recommended to use SUGeometryInput instead which does correctly merge geometry.

Parameters
[in]entitiesThe entities object.
[in]lenThe length of the array of edge objects.
[in]edgesThe array of edge objects to add.
Returns
SU_RESULT SUEntitiesAddFaces ( SUEntitiesRef  entities,
size_t  len,
const SUFaceRef  faces[] 
)

Adds face objects to a entities object.

NOTE: This function does not merge geometry, which will likely create an invalid SketchUp model. It is recommended to use SUGeometryInput instead which does correctly merge geometry.

Parameters
[in]entitiesThe entities object.
[in]lenThe length of the array of face objects.
[in]facesThe array of face objects to add.
Returns
SU_RESULT SUEntitiesAddGroup ( SUEntitiesRef  entities,
SUGroupRef  group 
)

Adds a group object to an entities object.

Parameters
[in]entitiesThe entities object.
[in]groupThe group object to add.
Returns
SU_RESULT SUEntitiesAddGuideLines ( SUEntitiesRef  entities,
size_t  len,
const SUGuideLineRef  guide_lines[] 
)

Adds guide line objects to an entities object.

Since
SketchUp 2016, API 4.0
Parameters
[in]entitiesThe entities object.
[in]lenThe length of the array of guide line objects.
[in]guide_linesThe array of guide line objects to add.
Returns
SU_RESULT SUEntitiesAddGuidePoints ( SUEntitiesRef  entities,
size_t  len,
const SUGuidePointRef  guide_points[] 
)

Adds guide point objects to an entities object.

Since
SketchUp 2014 M1, API 2.1
Parameters
[in]entitiesThe entities object.
[in]lenThe length of the array of guide point objects.
[in]guide_pointsThe array of guide point objects to add.
Returns
SU_RESULT SUEntitiesAddImage ( SUEntitiesRef  entities,
SUImageRef  image 
)

Adds an image object to an entities object.

Parameters
[in]entitiesThe entities object.
[in]imageThe image object to add.
Returns
SU_RESULT SUEntitiesAddInstance ( SUEntitiesRef  entities,
SUComponentInstanceRef  instance,
SUStringRef name 
)

Adds a component instance object to the entities.

Parameters
[in]entitiesThe entities object.
[in]instanceThe component instance object to add.
[out]nameThe unique name that is assigned to definition of the component instance. This can be NULL in which case the caller does not need to retrieve the assigned name.
Returns
SU_RESULT SUEntitiesAddSectionPlanes ( SUEntitiesRef  entities,
size_t  len,
const SUSectionPlaneRef  section_planes[] 
)

Adds section plane objects to an entities object.

Since
SketchUp 2016, API 4.0
Parameters
[in]entitiesThe entities object.
[in]lenThe length of the array of section planes objects.
[in]section_planesThe array of section planes objects to add.
Returns
SU_RESULT SUEntitiesAddTexts ( SUEntitiesRef  entities,
size_t  len,
const SUTextRef  texts[] 
)

Adds text objects to an entities object.

Since
SketchUp 2018, API 6.0
Parameters
[in]entitiesThe entities object.
[in]lenThe length of the array of text objects.
[in]textsThe array of text objects to add.
Returns
SU_RESULT SUEntitiesClear ( SUEntitiesRef  entities)

Removes all entities in the container.

Since
SketchUp 2019, API 7.0
Parameters
[in]entitiesThe entities to clear.
Returns
SU_RESULT SUEntitiesEntityListFill ( SUEntitiesRef  entities,
enum SURefType  type,
SUEntityListRef  list 
)

Fills the list with all entities of the specified type in the instance. The list is not in any specific order.

Since
SketchUp 2018, API 6.0
Parameters
[in]entitiesThe entities object to be queried.
[in]typeThe type of entities to be collected.
[out]listThe list object to be filled.
Returns
SU_RESULT SUEntitiesErase ( SUEntitiesRef  entities,
size_t  len,
SUEntityRef  elements[] 
)

Erases elements from an entities object. The input elements are destroyed, so the array elements are invalidated to prevent user from attempting to use destroyed entities.

Since
SketchUp 2017, API 5.0
Parameters
[in]entitiesThe entities object.
[in]lenThe number of entities in the array.
[in]elementsThe elements to be destroyed.
Returns
SU_RESULT SUEntitiesFill ( SUEntitiesRef  entities,
SUGeometryInputRef  geom_input,
bool  weld_vertices 
)

SUEntitiesFill is the fastest way to populate an entities object. The important precondition is that no duplicate data should be given.

NOTE: Faces included in the geometry input object will be merged together when using this function. This only applies to geometry in the geometry input object and not to any already-existing geometry in the entities object. Examples of merging are:

  • If weld_vertices is true, duplicated vertices are merged.
  • Coincident faces are merged.
  • Coincident faces with opposite normals are merged into a single face using the appropriate materials from both faces as the front and back materials.
  • Faces are created from coplanar edge loops.
  • Conincident edges are merged. Visibility is retained when visible and invisible edges are welded together. Hardness is retained when hard and soft edges are welded together.
Parameters
[in]entitiesThe entities to populate. Must be an empty entities object.
[in]geom_inputThe geometry input that the entities object is to be populated with.
[in]weld_verticesFlag indicating whether to join coincident vertices.
Returns
SU_RESULT SUEntitiesGetArcCurves ( SUEntitiesRef  entities,
size_t  len,
SUArcCurveRef  arccurves[],
size_t *  count 
)

Retrieves the arccurves in the entities object that are not associated with a face.

Since
SketchUp 2016, API 4.0
Parameters
[in]entitiesThe entities object.
[in]lenThe number of arccurves to retrieve.
[out]arccurvesThe arccurves retrieved.
[out]countThe number of curves retrieved.
Returns
SU_RESULT SUEntitiesGetBoundingBox ( SUEntitiesRef  entities,
struct SUBoundingBox3D bbox 
)

Retrieves the bounding box of the entities.

Parameters
[in]entitiesThe entities object.
[out]bboxThe bounding box retrieved.
Returns
SU_RESULT SUEntitiesGetBoundingBoxLLA ( SUEntitiesRef  entities,
struct SUBoundingBox3D bbox 
)

Retrieves the LLA coordinates (Latidue, Longitude and Altitude) bounding box of the given entities object. Note that the altitude is calculated based on the model origin, Example: If an entities object has a bounding box with the following values {{100,100,100}, {200,200,200}} the result will be something like the following: {{Latitude, Longitude, 100/METERS_TO_INCHES}, {Latitude, Longitude, 200/METERS_TO_INCHES}} where Latitude and Longitude are the geographical coordinates and altitude is just a conversion from inches to meters.

Since
SketchUp 2018 M0, API 6.0
Parameters
[in]entitiesThe entities object.
[out]bboxThe latidue longitude and altitude bounding box retrieved.
Returns
SU_RESULT SUEntitiesGetCurves ( SUEntitiesRef  entities,
size_t  len,
SUCurveRef  curves[],
size_t *  count 
)

Retrieves the curves in the entities object that are not associated with a face.

Parameters
[in]entitiesThe entities object.
[in]lenThe number of curves to retrieve.
[out]curvesThe curves retrieved.
[out]countThe number of curves retrieved.
Returns
SU_RESULT SUEntitiesGetDimensions ( SUEntitiesRef  entities,
size_t  len,
SUDimensionRef dimensions,
size_t *  count 
)

Retrieves the dimensions in the entities object.

Since
SketchUp 2017, API 5.0
Parameters
[in]entitiesThe entities object.
[in]lenThe number of dimensions to retrieve.
[out]dimensionsThe dimensions retrieved.
[out]countThe number of dimensions retrieved.
Returns
SU_RESULT SUEntitiesGetEdges ( SUEntitiesRef  entities,
bool  standalone_only,
size_t  len,
SUEdgeRef  edges[],
size_t *  count 
)

Retrieves the edges in the entities object.

Parameters
[in]entitiesThe entities object.
[in]standalone_onlyWhether to get all edges (false) or only the edges not attached to curves and faces (true).
[in]lenThe number of edges to retrieve.
[out]edgesThe edges retrieved.
[out]countThe number of edges retrieved.
Returns
SU_RESULT SUEntitiesGetFaces ( SUEntitiesRef  entities,
size_t  len,
SUFaceRef  faces[],
size_t *  count 
)

Retrieves the faces in the entities object.

Parameters
[in]entitiesThe entities object.
[in]lenThe number of faces to retrieve.
[out]facesThe faces retrieved.
[out]countThe number of faces retrieved.
Returns
SU_RESULT SUEntitiesGetGroups ( SUEntitiesRef  entities,
size_t  len,
SUGroupRef  groups[],
size_t *  count 
)

Retrieves the groups in the entities.

Parameters
[in]entitiesThe entities object.
[in]lenThe number of groups to retrieve.
[out]groupsThe groups retrieved.
[out]countThe number of groups retrieved.
Returns
SU_RESULT SUEntitiesGetGuideLines ( SUEntitiesRef  entities,
size_t  len,
SUGuideLineRef  guide_lines[],
size_t *  count 
)

Retrieves the guide lines in the entities object.

Since
SketchUp 2016, API 4.0
Parameters
[in]entitiesThe entities object.
[in]lenThe number of guide lines to retrieve.
[out]guide_linesThe guide_lines retrieved.
[out]countThe number of guide_lines retrieved.
Returns
SU_RESULT SUEntitiesGetGuidePoints ( SUEntitiesRef  entities,
size_t  len,
SUGuidePointRef  guide_points[],
size_t *  count 
)

Retrieves the guide points in the entities object.

Since
SketchUp 2014 M1, API 2.1
Parameters
[in]entitiesThe entities object.
[in]lenThe number of guide points to retrieve.
[out]guide_pointsThe guide_points retrieved.
[out]countThe number of guide_points retrieved.
Returns
SU_RESULT SUEntitiesGetImages ( SUEntitiesRef  entities,
size_t  len,
SUImageRef  images[],
size_t *  count 
)

Retrieves the array of image objects of a entities object.

Parameters
[in]entitiesThe entities object.
[in]lenThe number of image objects to retrieve.
[out]imagesThe image objects retrieved.
[out]countThe number of image objects retrieved.
Returns
SU_RESULT SUEntitiesGetInstances ( SUEntitiesRef  entities,
size_t  len,
SUComponentInstanceRef  instances[],
size_t *  count 
)

Retrieves the component instances in the entities.

Parameters
[in]entitiesThe entities object.
[in]lenThe number of component instances to retrieve.
[out]instancesThe component instances retrieved.
[out]countThe number of component instances retrieved.
Returns
SU_RESULT SUEntitiesGetNumArcCurves ( SUEntitiesRef  entities,
size_t *  count 
)

Retrieves the number of arccurves in the entities object that are not associated with a face.

Since
SketchUp 2016, API 4.0
Parameters
[in]entitiesThe entities object.
[out]countThe number of arccurves.
Returns
SU_RESULT SUEntitiesGetNumCurves ( SUEntitiesRef  entities,
size_t *  count 
)

Retrieves the number of curves in the entities object that are not associated with a face.

Parameters
[in]entitiesThe entities object.
[out]countThe number of curves.
Returns
SU_RESULT SUEntitiesGetNumDimensions ( SUEntitiesRef  entities,
size_t *  count 
)

Retrieves the number of dimensions in the entities object.

Since
SketchUp 2017, API 5.0
Parameters
[in]entitiesThe entities object.
[out]countThe number of dimensions.
Returns
SU_RESULT SUEntitiesGetNumEdges ( SUEntitiesRef  entities,
bool  standalone_only,
size_t *  count 
)

Retrieves the number of edges in the entities object.

Parameters
[in]entitiesThe entities object.
[in]standalone_onlyWhether to count all edges (false) or only the edges not attached to curves and faces (true).
[out]countThe number of edges.
Returns
SU_RESULT SUEntitiesGetNumFaces ( SUEntitiesRef  entities,
size_t *  count 
)

Retrieves the number of faces in the entities object.

Parameters
[in]entitiesThe entities object.
[out]countThe number of faces.
Returns
SU_RESULT SUEntitiesGetNumGroups ( SUEntitiesRef  entities,
size_t *  count 
)

Retrieves the number of groups in the entities.

Parameters
[in]entitiesThe entities object.
[out]countThe number of groups.
Returns
SU_RESULT SUEntitiesGetNumGuideLines ( SUEntitiesRef  entities,
size_t *  count 
)

Retrieves the number of guide lines in the entities object.

Since
SketchUp 2016, API 4.0
Parameters
[in]entitiesThe entities object.
[out]countThe number of guide_lines.
Returns
SU_RESULT SUEntitiesGetNumGuidePoints ( SUEntitiesRef  entities,
size_t *  count 
)

Retrieves the number of guide points in the entities object.

Since
SketchUp 2014 M1, API 2.1
Parameters
[in]entitiesThe entities object.
[out]countThe number of guide_points.
Returns
SU_RESULT SUEntitiesGetNumImages ( SUEntitiesRef  entities,
size_t *  count 
)

Retrieves the number of images in the entities.

Parameters
[in]entitiesThe entities object.
[out]countThe number of image objects.
Returns
SU_RESULT SUEntitiesGetNumInstances ( SUEntitiesRef  entities,
size_t *  count 
)

Retrieves the number of component instances in the entities.

Parameters
[in]entitiesThe entities object.
[out]countThe number of component instances.
Returns
SU_RESULT SUEntitiesGetNumPolyline3ds ( SUEntitiesRef  entities,
size_t *  count 
)

Retrieves the number of polyline3d's in the entities object.

Parameters
[in]entitiesThe entities object.
[out]countThe the number of polyline3d's.
Returns
SU_RESULT SUEntitiesGetNumSectionPlanes ( SUEntitiesRef  entities,
size_t *  count 
)

Retrieves the number of section planes in the entities object.

Since
SketchUp 2016, API 4.0
Parameters
[in]entitiesThe entities object.
[out]countThe number of section planes.
Returns
SU_RESULT SUEntitiesGetNumTexts ( SUEntitiesRef  entities,
size_t *  count 
)

Retrieves the number of texts in the entities object.

Since
SketchUp 2018, API 6.0
Parameters
[in]entitiesThe entities object.
[out]countThe number of texts.
Returns
SU_RESULT SUEntitiesGetPolyline3ds ( SUEntitiesRef  entities,
size_t  len,
SUPolyline3dRef  lines[],
size_t *  count 
)

Retrieves the polyline3d's in the entities object.

Parameters
[in]lenThe number of polyline3d's to retrieve.
[in]entitiesThe entities object.
[out]linesThe polyline3d's retrieved.
[out]countThe number of polyline3d's retrieved.
Returns
SU_RESULT SUEntitiesGetSectionPlanes ( SUEntitiesRef  entities,
size_t  len,
SUSectionPlaneRef  section_planes[],
size_t *  count 
)

Retrieves the section planes in the entities.

Since
SketchUp 2016, API 4.0
Parameters
[in]entitiesThe entities object.
[in]lenThe number of section planes to retrieve.
[out]section_planesThe section planes retrieved.
[out]countThe number of section planes retrieved.
Returns
SU_RESULT SUEntitiesGetTexts ( SUEntitiesRef  entities,
size_t  len,
SUTextRef  texts[],
size_t *  count 
)

Retrieves the texts in the entities.

Since
SketchUp 2018, API 6.0
Parameters
[in]entitiesThe entities object.
[in]lenThe number of section planes to retrieve.
[out]textsThe texts retrieved.
[out]countThe number of texts retrieved.
Returns
SU_RESULT SUEntitiesHasSectionCuts ( SUEntitiesRef  entities,
bool *  has_section_cuts 
)

Retrieves a boolean by recursively searching through the entities determining whether the entities has an active section plane or any of its nested components have an active section plane.

Since
SketchUp 2018, API 6.0
Parameters
[in]entitiesThe entities object.
[out]has_section_cutsThe bool value retrieved.
Returns
SU_RESULT SUEntitiesIsRecursivelyEmpty ( SUEntitiesRef  entities,
bool *  is_empty 
)

Retrieves a boolean indicating whether the entities object is recursively empty. A recursively empty entities object is defined as one that either has zero entities or contains only instances of definitions with recursively empty entities objects.

Since
SketchUp 2017, API 5.0
Parameters
[in]entitiesThe entities object.
[out]is_emptyThe bool value retrieved.
Returns
SU_RESULT SUEntitiesTransform ( SUEntitiesRef  entities,
size_t  len,
SUEntityRef  elements[],
const struct SUTransformation trans 
)

Applies a 3D transformation to the elements of the provided entity array.

Since
SketchUp 2017, API 5.0
Parameters
[in]entitiesThe entities object.
[in]lenThe number of entities in the array.
[in]elementsThe elements to be transformed.
[in]transThe transform to be applied.
Returns
SU_RESULT SUEntitiesTransformMultiple ( SUEntitiesRef  entities,
size_t  len,
SUEntityRef  elements[],
const struct SUTransformation  tranforms[] 
)

Applies a 3D transformations to the elements of the provided entity array. The arrays of elements and transformations must be the same length.

Since
SketchUp 2017, API 5.0
Parameters
[in]entitiesThe entities object.
[in]lenThe number of entities in the array.
[in]elementsThe elements to be transformed.
[in]tranformsThe transformations to be applied.
Returns