SketchUp SDK
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Functions
entities.h File Reference
#include <slapi/geometry.h>
#include <slapi/slapi.h>
#include <slapi/unicodestring.h>
#include <slapi/model/curve.h>
#include <slapi/model/defs.h>

Go to the source code of this file.

Functions

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 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 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 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 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...
 

Function Documentation

SU_RESULT SUEntitiesAddCurves ( SUEntitiesRef  entities,
size_t  len,
const SUCurveRef  curves[] 
)

Adds curve objects to an entities object.

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.

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.

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 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 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.

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 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 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 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 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 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 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 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 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