SketchUp C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Related Functions
SUModelRef Struct Reference

A SketchUp model. More...

#include <SketchUpAPI/model/model.h>

Related Functions

(Note that these are not member functions.)

enum SUResult SUModelCreate (SUModelRef *model)
 Creates an empty model object for the purposes of writing a SketchUp document. This model object must be released with SUModelRelease(). More...
 
enum SUResult SUModelCreateFromFile (SUModelRef *model, const char *file_path)
 Creates a model from a SketchUp file on local disk. This model object must be released with SUModelRelease(). More...
 
enum SUResult SUModelCreateFromFileWithStatus (SUModelRef *model, const char *file_path, enum SUModelLoadStatus *status)
 Creates a model from a SketchUp file on local disk. This model object must be released with SUModelRelease(). More...
 
enum SUResult SUModelCreateFromBuffer (SUModelRef *model, const unsigned char *buffer, size_t buffer_size)
 Creates a model from a SketchUp skp file buffer. This model object must be released with SUModelRelease(). More...
 
enum SUResult SUModelCreateFromBufferWithStatus (SUModelRef *model, const unsigned char *buffer, size_t buffer_size, enum SUModelLoadStatus *status)
 Creates a model from a SketchUp skp file buffer. This model object must be released with SUModelRelease(). More...
 
enum SUResult SUModelRelease (SUModelRef *model)
 Releases a model object and its associated resources. The root component of the model object and all its child objects must not be released explicitly. More...
 
enum SUResult SUModelGetEntities (SUModelRef model, SUEntitiesRef *entities)
 Retrieves the root model entities. More...
 
enum SUResult SUModelGetActiveEntities (SUModelRef model, SUEntitiesRef *entities)
 Retrieves the model entities of the active context (open group or component). More...
 
enum SUResult SUModelGetActivePath (SUModelRef model, SUInstancePathRef *instance_path)
 Retrieves the instance path of the active context (open group or component). More...
 
enum SUResult SUModelGetNumMaterials (SUModelRef model, size_t *count)
 Retrieves the number of materials in a model object. More...
 
enum SUResult SUModelGetMaterials (SUModelRef model, size_t len, SUMaterialRef materials[], size_t *count)
 Retrieves all the materials associated with a model object. More...
 
enum SUResult SUModelAddMaterials (SUModelRef model, size_t len, const SUMaterialRef materials[])
 Adds materials to a model object. Note that the materials cannot be already owned. More...
 
enum SUResult SUModelGetNumComponentDefinitions (SUModelRef model, size_t *count)
 Retrieves the number of components associated with a model. More...
 
enum SUResult SUModelGetComponentDefinitions (SUModelRef model, size_t len, SUComponentDefinitionRef definitions[], size_t *count)
 Retrieves the component definitions that define component instances but not groups. More...
 
enum SUResult SUModelGetNumGroupDefinitions (SUModelRef model, size_t *count)
 Retrieves the number of component definitions that define groups. More...
 
enum SUResult SUModelGetGroupDefinitions (SUModelRef model, size_t len, SUComponentDefinitionRef definitions[], size_t *count)
 Retrieves the component definitions that define groups. More...
 
enum SUResult SUModelGetNumImageDefinitions (SUModelRef model, size_t *count)
 Retrieves the number of component definitions that define images. More...
 
enum SUResult SUModelGetImageDefinitions (SUModelRef model, size_t len, SUComponentDefinitionRef definitions[], size_t *count)
 Retrieves the component definitions that define images. More...
 
enum SUResult SUModelAddComponentDefinitions (SUModelRef model, size_t len, const SUComponentDefinitionRef components[])
 Adds component definitions to a model object. More...
 
enum SUResult SUModelRemoveComponentDefinitions (SUModelRef model, size_t len, SUComponentDefinitionRef components[])
 Remove definitions of components, images, and groups from a model object. All component definitions, their geometry, and attached instances will be released. More...
 
enum SUResult SUModelSaveToFile (SUModelRef model, const char *file_path)
 Saves the model to a file. More...
 
enum SUResult SUModelSaveToFileWithVersion (SUModelRef model, const char *file_path, enum SUModelVersion version)
 Saves the model to a file using a specific SketchUp version format. More...
 
enum SUResult SUModelGetCamera (SUModelRef model, SUCameraRef *camera)
 Retrieves the camera of a model object. The returned camera object points to model's internal camera. So it must not be released via SUCameraRelease(). More...
 
enum SUResult SUModelSetCamera (SUModelRef model, SUCameraRef *camera)
 Sets the current camera of a model object. More...
 
enum SUResult SUModelGetNumScenes (SUModelRef model, size_t *num_scenes)
 Retrieves the number of scene cameras of a model object. More...
 
enum SUResult SUModelGetNumLayers (SUModelRef model, size_t *count)
 Retrieves the number of layers in a model object. More...
 
enum SUResult SUModelGetLayers (SUModelRef model, size_t len, SULayerRef layers[], size_t *count)
 Retrieves the layers in a model object. More...
 
enum SUResult SUModelAddLayers (SUModelRef model, size_t len, const SULayerRef layers[])
 Adds layer objects to a model object. More...
 
enum SUResult SUModelGetDefaultLayer (SUModelRef model, SULayerRef *layer)
 Retrieves the default layer object of a model object. More...
 
enum SUResult SUModelRemoveLayers (SUModelRef model, size_t len, SULayerRef layers[])
 Removes all layers provided in the array. The default layer cannot be removed. All entities on the deleted layers will be moved to the default layer. More...
 
enum SUResult SUModelGetActiveLayer (SUModelRef model, SULayerRef *layer)
 Retrieves the active layer object of a model object. More...
 
enum SUResult SUModelSetActiveLayer (SUModelRef model, SULayerRef layer)
 Sets the active layer object of a model object. More...
 
enum SUResult SUModelGetVersion (SUModelRef model, int *major, int *minor, int *build)
 Retrieves the version of a model object. The version consists of three numbers: major version number, minor version number, and the build number. More...
 
enum SUResult SUModelGetNumAttributeDictionaries (SUModelRef model, size_t *count)
 Retrieves the number of attribute dictionaries of a model object. More...
 
enum SUResult SUModelGetAttributeDictionaries (SUModelRef model, size_t len, SUAttributeDictionaryRef dictionaries[], size_t *count)
 Retrieves the attribute dictionaries of a model object. More...
 
enum SUResult SUModelGetAttributeDictionary (SUModelRef model, const char *name, SUAttributeDictionaryRef *dictionary)
 Retrieves the attribute dictionary of a model object that has the given name. If a dictionary with the given name does not exist, one is added to the model object. More...
 
enum SUResult SUModelIsGeoReferenced (SUModelRef model, bool *is_geo_ref)
 Retrieves whether the model is georeferenced. More...
 
enum SUResult SUModelGetLocation (SUModelRef model, SULocationRef *location)
 Retrieves the location information of a given model. More...
 
enum SUResult SUModelGetStatistics (SUModelRef model, struct SUModelStatistics *statistics)
 Calculates the sum of all entities by type in the model. More...
 
enum SUResult SUModelSetGeoReference (SUModelRef model, double latitude, double longitude, double altitude, bool is_z_value_centered, bool is_on_ocean_floor)
 Georeferences the model. More...
 
enum SUResult SUModelGetRenderingOptions (SUModelRef model, SURenderingOptionsRef *rendering_options)
 Retrieves the rendering options of a model object. More...
 
enum SUResult SUModelGetShadowInfo (SUModelRef model, SUShadowInfoRef *shadow_info)
 Retrieves the shadow info of a model object. More...
 
enum SUResult SUModelGetOptionsManager (SUModelRef model, SUOptionsManagerRef *options_manager)
 Retrieves options manager associated with the model. More...
 
enum SUResult SUModelGetNorthCorrection (SUModelRef model, double *north_correction)
 Retrieves the angle which will rotate the north direction to the y-axis for a given model. More...
 
enum SUResult SUModelMergeCoplanarFaces (SUModelRef model)
 Merges all adjacent, coplanar faces in the model. More...
 
enum SUResult SUModelGetScenes (SUModelRef model, size_t len, SUSceneRef scenes[], size_t *count)
 Retrieves all the scenes associated with a model object. More...
 
enum SUResult SUModelGetSceneWithName (SUModelRef model, const char *name, SUSceneRef *scene)
 Retrieves the scenes with the given name associated with a model object. More...
 
enum SUResult SUModelAddScenes (SUModelRef model, size_t len, const SUSceneRef scenes[])
 Adds scenes to a model object. More...
 
enum SUResult SUModelAddScene (SUModelRef model, int index, SUSceneRef scene, int *out_index)
 Adds scenes to a model object. More...
 
enum SUResult SUModelGetActiveScene (SUModelRef model, SUSceneRef *scene)
 Retrieves the active scene associated with a model object. More...
 
enum SUResult SUModelSetActiveScene (SUModelRef model, SUSceneRef scene)
 Sets the provided scene as the active scene. More...
 
enum SUResult SUModelAddMatchPhotoScene (SUModelRef model, const char *image_file, SUCameraRef camera, const char *scene_name, SUSceneRef *scene)
 Adds a single matched photo scene to a model object. More...
 
enum SUResult SUModelGetName (SUModelRef model, SUStringRef *name)
 Retrieves the name of a model object. More...
 
enum SUResult SUModelSetName (SUModelRef model, const char *name)
 Sets the name of a model object. More...
 
enum SUResult SUModelGetPath (SUModelRef model, SUStringRef *path)
 Retrieves the file path of a model object. More...
 
enum SUResult SUModelGetTitle (SUModelRef model, SUStringRef *title)
 Retrieves the title of a model object. More...
 
enum SUResult SUModelGetDescription (SUModelRef model, SUStringRef *description)
 Retrieves the description of a model object. More...
 
enum SUResult SUModelSetDescription (SUModelRef model, const char *description)
 Sets the description of a model object. More...
 
enum SUResult SUModelGetUnits (SUModelRef model, enum SUModelUnits *units)
 Returns the units associated with the given model. More...
 
enum SUResult SUModelGetClassifications (SUModelRef model, SUClassificationsRef *classifications)
 Retrieves the classifications of a model object. More...
 
enum SUResult SUModelGetAxes (SUModelRef model, SUAxesRef *axes)
 Retrieves the axes of a model object. More...
 
enum SUResult SUModelGetStyles (SUModelRef model, SUStylesRef *styles)
 Retrieves the styles of a model object. More...
 
enum SUResult SUModelGetInstancePathByPid (SUModelRef model, SUStringRef pid_ref, SUInstancePathRef *instance_path_ref)
 Retrieves the instance path (including an entity) corresponding to a given persistent id. More...
 
enum SUResult SUModelGetNumFonts (SUModelRef model, size_t *count)
 Retrieves the number of fonts in a model object. More...
 
enum SUResult SUModelGetFonts (SUModelRef model, size_t len, SUFontRef fonts[], size_t *count)
 Retrieves all the fonts associated with a model object. More...
 
enum SUResult SUModelGetDimensionStyle (SUModelRef model, SUDimensionStyleRef *style)
 Retrieves the dimension style associated with a model object. More...
 
enum SUResult SUModelGetLengthFormatter (SUModelRef model, SULengthFormatterRef *formatter)
 Retrieves length formatter settings from the model. The given length formatter object must have been constructed using SULengthFormatterCreate(). It must be released using SULengthFormatterRelease(). More...
 
enum SUResult SUModelGenerateUniqueMaterialName (SUModelRef model, const char *in_name, SUStringRef *out_name)
 Retrieves a unique material name from the model that is based on the provided one. If the provided name is unique it will be returned, otherwise any trailing indices will be replaced by a new index. More...
 
enum SUResult SUModelFixErrors (SUModelRef model)
 Fixes any errors found in the given model. More...
 
enum SUResult SUModelOrientFacesConsistently (SUModelRef model, bool recurse_components)
 Updates the faces in the model so that they are oriented consistently. More...
 
enum SUResult SUModelGetLineStyles (SUModelRef model, SULineStylesRef *line_styles)
 Retrieves line styles from the model. More...
 
enum SUResult SUModelLoadDefinition (SUModelRef model, const char *filename, SUComponentDefinitionRef *definition)
 Loads a component from a file. More...
 
enum SUResult SUModelLoadDefinitionWithStatus (SUModelRef model, const char *filename, SUComponentDefinitionRef *definition, enum SUModelLoadStatus *status)
 Loads a component from a file. More...
 
enum SUResult SUModelRemoveMaterials (SUModelRef model, size_t len, SUMaterialRef materials[])
 Removes all materials provided in the array. More...
 
enum SUResult SUModelRemoveScenes (SUModelRef model, size_t len, SUSceneRef scenes[])
 Removes selected scenes from a model. More...
 
enum SUResult SUModelGetNumAllMaterials (SUModelRef model, size_t *count)
 Retrieves the number of all the materials in a model including those belonging to SUImageRef and SULayerRef. More...
 
enum SUResult SUModelGetAllMaterials (SUModelRef model, size_t len, SUMaterialRef materials[], size_t *count)
 Retrieves all the materials associated with a model object including those belonging to SUImageRef and SULayerRef. More...
 
enum SUResult SUModelGetGuid (SUModelRef model, SUStringRef *guid)
 Retrieves the guid of a model object. More...
 
enum SUResult SUModelGetLayersByPersistentIDs (SUModelRef model, size_t num_pids, const int64_t pids[], SULayerRef layers[])
 Retrieves layers by their persistent ids. The layers retrieved will be in the same order as to the peristent ids passed in. If a persistent id doesn't belong to a layer, then a SU_INVALID element will be returned along with SU_ERROR_PARTIAL_SUCCESS. More...
 
enum SUResult SUModelIsDrawingElementVisible (SUModelRef model, SUInstancePathRef path, bool *visible)
 Reports whether the given SUDrawingElementRef in an SUInstancePathRef is visible given the model's rendering options. This will take into account "DrawHiddenGeometry" and "DrawHiddenObjects" to determine if the drawing element is visible in the viewport. More...
 
enum SUResult SUModelGetEntitiesByPersistentIDs (SUModelRef model, size_t num_pids, const int64_t pids[], SUEntityRef entities[])
 Retrieves entities by their persistent ids. The entities retrieved will be in the same order as to the peristent ids passed in. If a persistent id doesn't belong to a entity, then a SU_INVALID element will be returned along with SU_ERROR_PARTIAL_SUCCESS. More...
 
enum SUResult SUModelGetSelection (SUModelRef model, SUSelectionRef *selection)
 Retrieves the selection object for a model. More...
 
enum SUResult SUModelGetNumLayerFolders (SUModelRef model, size_t *count)
 Gets the number of SULayerFolderRef objects owned by the given model. More...
 
enum SUResult SUModelGetLayerFolders (SUModelRef model, size_t len, SULayerFolderRef *layer_folders, size_t *count)
 Gets the SULayerFolderRef objects that are owned by the given model. More...
 
enum SUResult SUModelPurgeEmptyLayerFolders (SUModelRef model, size_t *count)
 Removes empty SULayerFolderRef objects from the model. More...
 
enum SUResult SUModelAddLayerFolder (SUModelRef model, SULayerFolderRef layer_folder)
 Adds a SULayerFolderRef object to the model. More...
 
enum SUResult SUModelPurgeUnusedLayers (SUModelRef model, size_t *count)
 Removes unused SULayerRef objects from the model. More...
 
enum SUResult SUModelGetNumTopLevelLayers (SUModelRef model, size_t *count)
 Retrieves the number of layers in a model object that have not been added to any layer folder. More...
 
enum SUResult SUModelGetTopLevelLayers (SUModelRef model, size_t len, SULayerRef layers[], size_t *count)
 Retrieves the layers in a model that have not been added to a layer folder. More...
 
enum SUResult SUModelRemoveLayerFolders (SUModelRef model, size_t len, SULayerFolderRef layer_folders[])
 Removes all layer folders provided in the array. All children of the deleted layer folders will be moved to the parent of the deleted folder. More...
 
enum SUResult SUModelGetEntitiesOfTypeByPersistentIDs (SUModelRef model, const uint32_t type_flags, const size_t num_pids, const int64_t pids[], SUEntityRef entities[])
 Retrieves entities of a given type by their persistent ids. The entities retrieved will be in the same order as to the peristent ids passed in. If a persistent id doesn't belong to an entity, then a SU_INVALID element will be returned along with SU_ERROR_PARTIAL_SUCCESS. More...
 
enum SUResult SUModelGetBehavior (SUModelRef model, struct SUComponentBehavior *behavior)
 Retrieves the component behavior of a SketchUp model. More...
 
enum SUResult SUModelSetBehavior (SUModelRef model, const struct SUComponentBehavior *behavior)
 Sets the component behavior of a SketchUp model. More...
 

Detailed Description

A SketchUp model.

Friends And Related Function Documentation

enum SUResult SUModelAddComponentDefinitions ( SUModelRef  model,
size_t  len,
const SUComponentDefinitionRef  components[] 
)
related

Adds component definitions to a model object.

Parameters
[in]modelThe model object.
[in]lenThe number of component definitions to add.
[in]componentsThe array of component definitions to add.
Returns
enum SUResult SUModelAddLayerFolder ( SUModelRef  model,
SULayerFolderRef  layer_folder 
)
related

Adds a SULayerFolderRef object to the model.

Since
SketchUp 2021.0, API 9.0
Parameters
[in]modelThe model object.
[in]layer_folderThe layer folder to add.
Returns
enum SUResult SUModelAddLayers ( SUModelRef  model,
size_t  len,
const SULayerRef  layers[] 
)
related

Adds layer objects to a model object.

Parameters
[in]modelThe model object.
[in]lenThe number of layers to add.
[in]layersThe layers to add.
Returns
enum SUResult SUModelAddMatchPhotoScene ( SUModelRef  model,
const char *  image_file,
SUCameraRef  camera,
const char *  scene_name,
SUSceneRef scene 
)
related

Adds a single matched photo scene to a model object.

Since
SketchUp 2015, API 3.0
Parameters
[in]modelThe model object.
[in]image_fileThe full path of the image associated with this scene.
[in]cameraThe camera associated with this scene.
[in]scene_nameThe name of the scene to add.
[out]sceneThe scene object created.
Returns
enum SUResult SUModelAddMaterials ( SUModelRef  model,
size_t  len,
const SUMaterialRef  materials[] 
)
related

Adds materials to a model object. Note that the materials cannot be already owned.

Parameters
[in]modelThe model object.
[in]lenThe number of material objects to add.
[in]materialsThe array of material objects to add.
Returns
enum SUResult SUModelAddScene ( SUModelRef  model,
int  index,
SUSceneRef  scene,
int *  out_index 
)
related

Adds scenes to a model object.

Warning
Breaking Change: The behavior of SUModelAddScene changed in SketchUp SDK 2018 API 6.0 to return SU_ERROR_INVALID_ARGUMENT if the given scene name already exists in the model.
Parameters
[in]modelThe model object.
[in]indexWhere in the list to add the scene. -1 to place at the end.
[in]sceneThe scene object to add.
[out]out_indexThe index that the scene was added at.
Returns
enum SUResult SUModelAddScenes ( SUModelRef  model,
size_t  len,
const SUSceneRef  scenes[] 
)
related

Adds scenes to a model object.

Warning
Breaking Change: The behavior of SUModelAddScenes changed in SketchUp SDK 2018 API 6.0 to return SU_ERROR_INVALID_ARGUMENT if at least one scene name already exists in the model or if there are duplicated names in the scenes array.
Parameters
[in]modelThe model object.
[in]lenThe number of scene objects to add.
[in]scenesThe array of scene objects to add.
Returns
enum SUResult SUModelCreate ( SUModelRef model)
related

Creates an empty model object for the purposes of writing a SketchUp document. This model object must be released with SUModelRelease().

Parameters
[out]modelThe model object created.
Returns
enum SUResult SUModelCreateFromBuffer ( SUModelRef model,
const unsigned char *  buffer,
size_t  buffer_size 
)
related

Creates a model from a SketchUp skp file buffer. This model object must be released with SUModelRelease().

Since
SketchUp 2017 M2, API 5.2
Deprecated:
This method will be removed in SketchUp 2022.0. It is replaced by SUModelCreateFromBufferWithStatus() which can read models saved by newer versions of SketchUp.
Parameters
[out]modelThe model object created.
[in]bufferThe SketchUp file buffer.
[in]buffer_sizeThe SketchUp file buffer size.
Returns
enum SUResult SUModelCreateFromBufferWithStatus ( SUModelRef model,
const unsigned char *  buffer,
size_t  buffer_size,
enum SUModelLoadStatus status 
)
related

Creates a model from a SketchUp skp file buffer. This model object must be released with SUModelRelease().

Since
SketchUp 2021, API 9.0
Note
As of SketchUp 2021.0, SketchUp can open .skp files created with newer versions of SketchUp. However, opening newer versions with an older SDK might omit model data. Use the load status value to check if the file was created with a newer version of SketchUp.
Warning
When reading a file created with a newer version of SketchUp, you may lose data if you write over the same file.
Parameters
[out]modelThe model object created.
[in]bufferThe SketchUp file buffer.
[in]buffer_sizeThe SketchUp file buffer size.
[out]statusReturns additional information on the status of a successful operation. Valid when the return value is SU_ERROR_NONE.
Returns
enum SUResult SUModelCreateFromFile ( SUModelRef model,
const char *  file_path 
)
related

Creates a model from a SketchUp file on local disk. This model object must be released with SUModelRelease().

Deprecated:
This method will be removed in SketchUp 2022.0. It is replaced by SUModelCreateFromFileWithStatus() which can read models saved by newer versions of SketchUp.
Parameters
[out]modelThe model object created.
[in]file_pathThe source file path of the SketchUp file. Assumed to be UTF-8 encoded.
Returns
enum SUResult SUModelCreateFromFileWithStatus ( SUModelRef model,
const char *  file_path,
enum SUModelLoadStatus status 
)
related

Creates a model from a SketchUp file on local disk. This model object must be released with SUModelRelease().

Since
SketchUp 2021, API 9.0
Note
As of SketchUp 2021.0, SketchUp can open .skp files created with newer versions of SketchUp. However, opening newer versions with an older SDK might omit model data. Use the load status value to check if the file was created with a newer version of SketchUp.
Warning
When reading a file created with a newer version of SketchUp, you may lose data if you write over the same file.
Parameters
[out]modelThe model object created.
[in]file_pathThe source file path of the SketchUp file. Assumed to be UTF-8 encoded.
[out]statusReturns additional information on the status of a successful operation. Valid when the return value is SU_ERROR_NONE.
Returns
enum SUResult SUModelFixErrors ( SUModelRef  model)
related

Fixes any errors found in the given model.

Since
SketchUp 2018, API 6.0
Parameters
[in]modelThe model object.
Returns
enum SUResult SUModelGenerateUniqueMaterialName ( SUModelRef  model,
const char *  in_name,
SUStringRef out_name 
)
related

Retrieves a unique material name from the model that is based on the provided one. If the provided name is unique it will be returned, otherwise any trailing indices will be replaced by a new index.

Since
SketchUp 2018, API 6.0
Parameters
[in]modelThe model object.
[in]in_nameThe suggested name.
[out]out_nameThe returned name.
Returns
enum SUResult SUModelGetActiveEntities ( SUModelRef  model,
SUEntitiesRef entities 
)
related

Retrieves the model entities of the active context (open group or component).

Since
SketchUp 2020.2, API 8.2
Parameters
[in]modelThe model object.
[out]entitiesThe entities retrieved.
Returns
enum SUResult SUModelGetActiveLayer ( SUModelRef  model,
SULayerRef layer 
)
related

Retrieves the active layer object of a model object.

Since
SketchUp 2020, API 8.0
Parameters
[in]modelThe model object.
[out]layerThe layer object retrieved.
Returns
enum SUResult SUModelGetActivePath ( SUModelRef  model,
SUInstancePathRef instance_path 
)
related

Retrieves the instance path of the active context (open group or component).

Note
This method only works from within the SketchUp application.
Parameters
[in]modelThe model object.
[out]instance_pathThe instance path retrieved. This must be released to avoid memory leak.
Returns
enum SUResult SUModelGetActiveScene ( SUModelRef  model,
SUSceneRef scene 
)
related

Retrieves the active scene associated with a model object.

Since
SketchUp 2016, API 4.0
Parameters
[in]modelThe model object.
[out]sceneThe scene object retrieved.
Returns
enum SUResult SUModelGetAllMaterials ( SUModelRef  model,
size_t  len,
SUMaterialRef  materials[],
size_t *  count 
)
related

Retrieves all the materials associated with a model object including those belonging to SUImageRef and SULayerRef.

Warning
Materials from SUImageRef and SULayerRef should not be applied to any other entity in the model. They are uniquely owned by the image or layer.
Since
SketchUp 2019.2, API 7.1
Parameters
[in]modelThe model object.
[in]lenThe number of material objects to retrieve.
[out]materialsThe material objects retrieved.
[out]countThe number of material objects retrieved.
Returns
enum SUResult SUModelGetAttributeDictionaries ( SUModelRef  model,
size_t  len,
SUAttributeDictionaryRef  dictionaries[],
size_t *  count 
)
related

Retrieves the attribute dictionaries of a model object.

Parameters
[in]modelThe model object.
[in]lenThe number of attribute dictionaries to retrieve.
[out]dictionariesThe dictionaries retrieved.
[out]countThe number of attribute dictionaries retrieved.
Returns
enum SUResult SUModelGetAttributeDictionary ( SUModelRef  model,
const char *  name,
SUAttributeDictionaryRef dictionary 
)
related

Retrieves the attribute dictionary of a model object that has the given name. If a dictionary with the given name does not exist, one is added to the model object.

Parameters
[in]modelThe model object.
[in]nameThe name of the attribute dictionary to retrieve. Assumed to be UTF-8 encoded.
[out]dictionaryThe dictionary object retrieved.
Returns
enum SUResult SUModelGetAxes ( SUModelRef  model,
SUAxesRef axes 
)
related

Retrieves the axes of a model object.

Parameters
[in]modelThe model object.
[out]axesThe axes object retrieved.
Returns
enum SUResult SUModelGetBehavior ( SUModelRef  model,
struct SUComponentBehavior behavior 
)
related

Retrieves the component behavior of a SketchUp model.

Since
SketchUp 2021.1, API 9.1
Parameters
[in]modelThe model object.
[out]behaviorThe behavior retrieved.
Returns
enum SUResult SUModelGetCamera ( SUModelRef  model,
SUCameraRef camera 
)
related

Retrieves the camera of a model object. The returned camera object points to model's internal camera. So it must not be released via SUCameraRelease().

Parameters
[in]modelThe model object.
[out]cameraThe camera object retrieved.
Returns
enum SUResult SUModelGetClassifications ( SUModelRef  model,
SUClassificationsRef classifications 
)
related

Retrieves the classifications of a model object.

Parameters
[in]modelThe model object.
[out]classificationsThe classifications object retrieved.
Returns
enum SUResult SUModelGetComponentDefinitions ( SUModelRef  model,
size_t  len,
SUComponentDefinitionRef  definitions[],
size_t *  count 
)
related

Retrieves the component definitions that define component instances but not groups.

Parameters
[in]modelThe model object.
[in]lenThe number of component definitions to retrieve.
[out]definitionsThe component definitions retrieved.
[out]countThe number of component definitions retrieved.
Returns
enum SUResult SUModelGetDefaultLayer ( SUModelRef  model,
SULayerRef layer 
)
related

Retrieves the default layer object of a model object.

Parameters
[in]modelThe model object.
[out]layerThe layer object retrieved.
Returns
enum SUResult SUModelGetDescription ( SUModelRef  model,
SUStringRef description 
)
related

Retrieves the description of a model object.

Parameters
[in]modelThe model object.
[out]descriptionThe destination of the retrieved description object.
Returns
enum SUResult SUModelGetDimensionStyle ( SUModelRef  model,
SUDimensionStyleRef style 
)
related

Retrieves the dimension style associated with a model object.

Since
SketchUp 2017, API 5.0
Parameters
[in]modelThe model object.
[out]styleThe dimension style retrieved.
Returns
enum SUResult SUModelGetEntities ( SUModelRef  model,
SUEntitiesRef entities 
)
related

Retrieves the root model entities.

Parameters
[in]modelThe model object.
[out]entitiesThe entities retrieved.
Returns
enum SUResult SUModelGetEntitiesByPersistentIDs ( SUModelRef  model,
size_t  num_pids,
const int64_t  pids[],
SUEntityRef  entities[] 
)
related

Retrieves entities by their persistent ids. The entities retrieved will be in the same order as to the peristent ids passed in. If a persistent id doesn't belong to a entity, then a SU_INVALID element will be returned along with SU_ERROR_PARTIAL_SUCCESS.

Since
SketchUp 2020.0, API 8.0
See Also
SUModelGetEntitiesOfTypeByPersistentIDs()
Deprecated:
Prefer the more flexible SUModelGetEntitiesOfTypeByPersistentIDs() which lets you narrow the search scope.
Parameters
[in]modelThe model object.
[in]num_pidsThe number of persistent ids.
[in]pidsThe persistent ids.
[out]entitiesThe retrieved entity objects.
Returns
enum SUResult SUModelGetEntitiesOfTypeByPersistentIDs ( SUModelRef  model,
const uint32_t  type_flags,
const size_t  num_pids,
const int64_t  pids[],
SUEntityRef  entities[] 
)
related

Retrieves entities of a given type by their persistent ids. The entities retrieved will be in the same order as to the peristent ids passed in. If a persistent id doesn't belong to an entity, then a SU_INVALID element will be returned along with SU_ERROR_PARTIAL_SUCCESS.

Note
This method allows the user to search for specific types of entities which allows us to ignore parts of the model for faster results.
Since
SketchUp 2020.2, API 8.2
Parameters
[in]modelThe model object.
[in]type_flagsAn integer made up by combining Entity Type Flag values together with bitwise 'or'. This determines what types of entities to look for.
[in]num_pidsThe number of persistent ids.
[in]pidsThe persistent ids.
[out]entitiesThe retrieved entity objects.
Returns
enum SUResult SUModelGetFonts ( SUModelRef  model,
size_t  len,
SUFontRef  fonts[],
size_t *  count 
)
related

Retrieves all the fonts associated with a model object.

Since
SketchUp 2017, API 5.0
Parameters
[in]modelThe model object.
[in]lenThe number of font objects to retrieve.
[out]fontsThe font objects retrieved.
[out]countThe number of font objects retrieved.
Returns
enum SUResult SUModelGetGroupDefinitions ( SUModelRef  model,
size_t  len,
SUComponentDefinitionRef  definitions[],
size_t *  count 
)
related

Retrieves the component definitions that define groups.

Since
SketchUp 2016, API 4.0
Parameters
[in]modelThe model object.
[in]lenThe number of component definitions to retrieve.
[out]definitionsThe component definitions retrieved.
[out]countThe number of component definitions retrieved.
Returns
enum SUResult SUModelGetGuid ( SUModelRef  model,
SUStringRef guid 
)
related

Retrieves the guid of a model object.

Since
SketchUp 2019.2, API 7.1
See Also
SUComponentDefinitionGetGuid
SUSkpReadGuid
Parameters
[in]modelThe model object.
[out]guidThe guid string.
Returns
enum SUResult SUModelGetImageDefinitions ( SUModelRef  model,
size_t  len,
SUComponentDefinitionRef  definitions[],
size_t *  count 
)
related

Retrieves the component definitions that define images.

Since
SketchUp 2019, API 7.0
Parameters
[in]modelThe model object.
[in]lenThe number of component definitions to retrieve.
[out]definitionsThe component definitions retrieved.
[out]countThe number of component definitions retrieved.
Returns
enum SUResult SUModelGetInstancePathByPid ( SUModelRef  model,
SUStringRef  pid_ref,
SUInstancePathRef instance_path_ref 
)
related

Retrieves the instance path (including an entity) corresponding to a given persistent id.

Parameters
[in]modelThe model object.
[in]pid_refPersistent id of the entity.
[out]instance_path_refInstance path to the entity.
Note
Starting in SketchUp 2020.1, API 8.1, SU_ERROR_NO_DATA will be returned if pid_ref isn't a valid instance path in the model.
Returns
enum SUResult SUModelGetLayerFolders ( SUModelRef  model,
size_t  len,
SULayerFolderRef layer_folders,
size_t *  count 
)
related

Gets the SULayerFolderRef objects that are owned by the given model.

Since
SketchUp 2021.0, API 9.0
Parameters
[in]modelThe model object.
[in]lenThe number of elements in layer_folders.
[out]layer_foldersAn array of layer folder objects.
[out]countThe number of elements written into layer_folders.
Returns
enum SUResult SUModelGetLayers ( SUModelRef  model,
size_t  len,
SULayerRef  layers[],
size_t *  count 
)
related

Retrieves the layers in a model object.

Note
This retrieves all layers regardless of whether or not they are contained in a SULayerFolderRef.
Parameters
[in]modelThe model object.
[in]lenThe number of layers to retrieve.
[out]layersThe layers retrieved.
[out]countThe number of layers retrieved.
See Also
SUModelGetTopLevelLayers()
Returns
enum SUResult SUModelGetLayersByPersistentIDs ( SUModelRef  model,
size_t  num_pids,
const int64_t  pids[],
SULayerRef  layers[] 
)
related

Retrieves layers by their persistent ids. The layers retrieved will be in the same order as to the peristent ids passed in. If a persistent id doesn't belong to a layer, then a SU_INVALID element will be returned along with SU_ERROR_PARTIAL_SUCCESS.

Since
SketchUp 2020.0, API 8.0
See Also
SUModelGetEntitiesOfTypeByPersistentIDs()
Deprecated:
Prefer the more flexible SUModelGetEntitiesOfTypeByPersistentIDs() which lets you narrow the search scope.
Parameters
[in]modelThe model object.
[in]num_pidsThe number of persistent ids.
[in]pidsThe persistent ids.
[out]layersThe retrieved layer objects.
Returns
enum SUResult SUModelGetLengthFormatter ( SUModelRef  model,
SULengthFormatterRef formatter 
)
related

Retrieves length formatter settings from the model. The given length formatter object must have been constructed using SULengthFormatterCreate(). It must be released using SULengthFormatterRelease().

Since
SketchUp 2018, API 6.0
Parameters
[in]modelThe model object.
[out]formatterThe formatter used to retrieve the settings.
Returns
enum SUResult SUModelGetLineStyles ( SUModelRef  model,
SULineStylesRef line_styles 
)
related

Retrieves line styles from the model.

Since
SketchUp 2019, API 7.0
Parameters
[in]modelThe model object.
[out]line_stylesThe line styles of the model.
Returns
enum SUResult SUModelGetLocation ( SUModelRef  model,
SULocationRef location 
)
related

Retrieves the location information of a given model.

Parameters
[in]modelThe model object.
[out]locationThe location retrieved.
Returns
enum SUResult SUModelGetMaterials ( SUModelRef  model,
size_t  len,
SUMaterialRef  materials[],
size_t *  count 
)
related

Retrieves all the materials associated with a model object.

Parameters
[in]modelThe model object.
[in]lenThe number of material objects to retrieve.
[out]materialsThe material objects retrieved.
[out]countThe number of material objects retrieved.
Returns
enum SUResult SUModelGetName ( SUModelRef  model,
SUStringRef name 
)
related

Retrieves the name of a model object.

Parameters
[in]modelThe model object.
[out]nameThe destination of the retrieved name object.
Returns
enum SUResult SUModelGetNorthCorrection ( SUModelRef  model,
double *  north_correction 
)
related

Retrieves the angle which will rotate the north direction to the y-axis for a given model.

Parameters
[in]modelThe model object.
[out]north_correctionThe north correction angle retrieved (in degrees).
Returns
enum SUResult SUModelGetNumAllMaterials ( SUModelRef  model,
size_t *  count 
)
related

Retrieves the number of all the materials in a model including those belonging to SUImageRef and SULayerRef.

Warning
Materials from SUImageRef and SULayerRef should not be applied to any other entity in the model. They are uniquely owned by the image or layer.
Since
SketchUp 2019.2, API 7.1
Parameters
[in]modelThe model object.
[out]countThe number of material objects available.
Returns
enum SUResult SUModelGetNumAttributeDictionaries ( SUModelRef  model,
size_t *  count 
)
related

Retrieves the number of attribute dictionaries of a model object.

Parameters
[in]modelThe model object.
[out]countThe number of attribute dictionaries available.
Returns
enum SUResult SUModelGetNumComponentDefinitions ( SUModelRef  model,
size_t *  count 
)
related

Retrieves the number of components associated with a model.

Parameters
[in]modelThe model object.
[out]countThe number of components available.
Returns
enum SUResult SUModelGetNumFonts ( SUModelRef  model,
size_t *  count 
)
related

Retrieves the number of fonts in a model object.

Since
SketchUp 2017, API 5.0
Parameters
[in]modelThe model object.
[out]countThe number of font objects available.
Returns
enum SUResult SUModelGetNumGroupDefinitions ( SUModelRef  model,
size_t *  count 
)
related

Retrieves the number of component definitions that define groups.

Since
SketchUp 2016, API 4.0
Parameters
[in]modelThe model object.
[out]countThe number of component definitions available.
Returns
enum SUResult SUModelGetNumImageDefinitions ( SUModelRef  model,
size_t *  count 
)
related

Retrieves the number of component definitions that define images.

Since
SketchUp 2019, API 7.0
Parameters
[in]modelThe model object.
[out]countThe number of component definitions available.
Returns
enum SUResult SUModelGetNumLayerFolders ( SUModelRef  model,
size_t *  count 
)
related

Gets the number of SULayerFolderRef objects owned by the given model.

Since
SketchUp 2021.0, API 9.0
Parameters
[in]modelThe model object.
[out]countThe number of layer folder objects.
Returns
enum SUResult SUModelGetNumLayers ( SUModelRef  model,
size_t *  count 
)
related

Retrieves the number of layers in a model object.

Note
This counts all layers regardless of whether or not they are contained in a SULayerFolderRef.
Parameters
[in]modelThe model object.
[out]countThe number of layers available.
See Also
SUModelGetNumTopLevelLayers()
Returns
enum SUResult SUModelGetNumMaterials ( SUModelRef  model,
size_t *  count 
)
related

Retrieves the number of materials in a model object.

Parameters
[in]modelThe model object.
[out]countThe number of material objects available.
Returns
enum SUResult SUModelGetNumScenes ( SUModelRef  model,
size_t *  num_scenes 
)
related

Retrieves the number of scene cameras of a model object.

Parameters
[in]modelThe model object.
[out]num_scenesThe number of scenes available.
Returns
enum SUResult SUModelGetNumTopLevelLayers ( SUModelRef  model,
size_t *  count 
)
related

Retrieves the number of layers in a model object that have not been added to any layer folder.

Since
SketchUp 2021.0, API 9.0
Parameters
[in]modelThe model object.
[out]countThe number of top-level layers available.
See Also
SUModelGetNumLayers()
Returns
enum SUResult SUModelGetOptionsManager ( SUModelRef  model,
SUOptionsManagerRef options_manager 
)
related

Retrieves options manager associated with the model.

Parameters
[in]modelThe model object.
[out]options_managerThe options manager object retrieved.
Returns
enum SUResult SUModelGetPath ( SUModelRef  model,
SUStringRef path 
)
related

Retrieves the file path of a model object.

Since
SketchUp 2018, API 6.0
Parameters
[in]modelThe model object.
[out]pathThe destination of the retrieved path object.
Returns
enum SUResult SUModelGetRenderingOptions ( SUModelRef  model,
SURenderingOptionsRef rendering_options 
)
related

Retrieves the rendering options of a model object.

Parameters
[in]modelThe model object.
[out]rendering_optionsThe rendering options object retrieved. This object is owned by the model and must not be explicitly released.
Returns
enum SUResult SUModelGetScenes ( SUModelRef  model,
size_t  len,
SUSceneRef  scenes[],
size_t *  count 
)
related

Retrieves all the scenes associated with a model object.

Parameters
[in]modelThe model object.
[in]lenThe number of scene objects to retrieve.
[out]scenesThe scene objects retrieved.
[out]countThe number of scene objects retrieved.
Returns
enum SUResult SUModelGetSceneWithName ( SUModelRef  model,
const char *  name,
SUSceneRef scene 
)
related

Retrieves the scenes with the given name associated with a model object.

Parameters
[in]modelThe model object.
[in]nameThe name of scene object to retrieve.
[out]sceneThe scene object retrieved.
Returns
enum SUResult SUModelGetSelection ( SUModelRef  model,
SUSelectionRef selection 
)
related

Retrieves the selection object for a model.

Note
This method only works from within the SketchUp application.
Since
SketchUp 2020.2, API 8.2
Parameters
[in]modelThe model object.
[out]selectionThe retrieved selection object.
Returns
enum SUResult SUModelGetShadowInfo ( SUModelRef  model,
SUShadowInfoRef shadow_info 
)
related

Retrieves the shadow info of a model object.

Since
SketchUp 2015, API 3.0
Parameters
[in]modelThe model object.
[out]shadow_infoThe shadow info object retrieved. This object is owned by the model and must not be explicitly released.
Returns
enum SUResult SUModelGetStatistics ( SUModelRef  model,
struct SUModelStatistics statistics 
)
related

Calculates the sum of all entities by type in the model.

Parameters
[in]modelThe model object.
[out]statisticsThe SUModelStatistics() struct that will be populated with the number of each entity type in the model.
Returns
enum SUResult SUModelGetStyles ( SUModelRef  model,
SUStylesRef styles 
)
related

Retrieves the styles of a model object.

Since
SketchUp 2017, API 5.0
Parameters
[in]modelThe model object.
[out]stylesThe styles object retrieved.
Returns
enum SUResult SUModelGetTitle ( SUModelRef  model,
SUStringRef title 
)
related

Retrieves the title of a model object.

Since
SketchUp 2018, API 6.0
Parameters
[in]modelThe model object.
[out]titleThe destination of the retrieved title object.
Returns
enum SUResult SUModelGetTopLevelLayers ( SUModelRef  model,
size_t  len,
SULayerRef  layers[],
size_t *  count 
)
related

Retrieves the layers in a model that have not been added to a layer folder.

Since
SketchUp 2021.0, API 9.0
Parameters
[in]modelThe model object.
[in]lenThe number of layers to retrieve.
[out]layersThe layers retrieved.
[out]countThe number of layers retrieved.
See Also
SUModelGetLayers()
Returns
enum SUResult SUModelGetUnits ( SUModelRef  model,
enum SUModelUnits units 
)
related

Returns the units associated with the given model.

Parameters
[in]modelThe model object.
[out]unitsThe units retrieved.
Returns
enum SUResult SUModelGetVersion ( SUModelRef  model,
int *  major,
int *  minor,
int *  build 
)
related

Retrieves the version of a model object. The version consists of three numbers: major version number, minor version number, and the build number.

Parameters
[in]modelThe model object.
[out]majorThe major version number retrieved.
[out]minorThe minor version number retrieved.
[out]buildThe build version number retrieved.
Returns
enum SUResult SUModelIsDrawingElementVisible ( SUModelRef  model,
SUInstancePathRef  path,
bool *  visible 
)
related

Reports whether the given SUDrawingElementRef in an SUInstancePathRef is visible given the model's rendering options. This will take into account "DrawHiddenGeometry" and "DrawHiddenObjects" to determine if the drawing element is visible in the viewport.

Since
SketchUp 2020.0, API 8.0
Parameters
[in]modelThe model object.
[in]pathThe instance path to resolve visibility for.
[out]visibleThe retrieved layer objects.
Returns
enum SUResult SUModelIsGeoReferenced ( SUModelRef  model,
bool *  is_geo_ref 
)
related

Retrieves whether the model is georeferenced.

Since
SketchUp 2017, API 5.0
Parameters
[in]modelThe model object.
[out]is_geo_refThe flag retrieved.
Returns
enum SUResult SUModelLoadDefinition ( SUModelRef  model,
const char *  filename,
SUComponentDefinitionRef definition 
)
related

Loads a component from a file.

Deprecated:
This method will be removed in SketchUp 2022.0. It is replaced by SUModelLoadDefinitionWithStatus() which can load components saved by newer versions of SketchUp.
Since
SketchUp 2019.2, API 7.1
Parameters
[in]modelThe model object.
[in]filenameThe full path and filename to a SkethchUp model.
[out]definitionThe component definition that is created after load.
Returns
enum SUResult SUModelLoadDefinitionWithStatus ( SUModelRef  model,
const char *  filename,
SUComponentDefinitionRef definition,
enum SUModelLoadStatus status 
)
related

Loads a component from a file.

Since
SketchUp 2021, API 9.0
Note
As of SketchUp 2021.0, SketchUp can open .skp files created with newer versions of SketchUp. However, opening newer versions with an older SDK might omit model data. Use the load status value to check if the file was created with a newer version of SketchUp.
Warning
When reading a file created with a newer version of SketchUp, you may lose data if you write over the same file.
Parameters
[in]modelThe model object.
[in]filenameThe full path and filename to a SkethchUp model.
[out]definitionThe component definition that is created after load.
[out]statusReturns additional information on the status of a successful operation. Valid when the return value is SU_ERROR_NONE.
Returns
enum SUResult SUModelMergeCoplanarFaces ( SUModelRef  model)
related

Merges all adjacent, coplanar faces in the model.

Parameters
[in]modelThe model object.
Returns
enum SUResult SUModelOrientFacesConsistently ( SUModelRef  model,
bool  recurse_components 
)
related

Updates the faces in the model so that they are oriented consistently.

Since
SketchUp 2018, API 6.0
Parameters
[in]modelThe model object.
[in]recurse_componentsOrient components of the model.
Returns
enum SUResult SUModelPurgeEmptyLayerFolders ( SUModelRef  model,
size_t *  count 
)
related

Removes empty SULayerFolderRef objects from the model.

Since
SketchUp 2021.0, API 9.0
Parameters
[in]modelThe model object.
[out]countThe number of empty layer folders removed. If NULL, count will not be retrieved.
Returns
enum SUResult SUModelPurgeUnusedLayers ( SUModelRef  model,
size_t *  count 
)
related

Removes unused SULayerRef objects from the model.

Since
SketchUp 2020.2, API 8.2
Parameters
[in]modelThe model object.
[out]countThe number of layers deleted. If NULL, count will not be retrieved.
Returns
enum SUResult SUModelRelease ( SUModelRef model)
related

Releases a model object and its associated resources. The root component of the model object and all its child objects must not be released explicitly.

Parameters
[in]modelThe model object.
Returns
enum SUResult SUModelRemoveComponentDefinitions ( SUModelRef  model,
size_t  len,
SUComponentDefinitionRef  components[] 
)
related

Remove definitions of components, images, and groups from a model object. All component definitions, their geometry, and attached instances will be released.

Since
SketchUp 2019.2, API 7.1
Parameters
[in]modelThe model object.
[in]lenThe number of component definitions to remove.
[in]componentsThe array of component definitions to remove.
Returns
enum SUResult SUModelRemoveLayerFolders ( SUModelRef  model,
size_t  len,
SULayerFolderRef  layer_folders[] 
)
related

Removes all layer folders provided in the array. All children of the deleted layer folders will be moved to the parent of the deleted folder.

Since
SketchUp 2021.0, API 9.0
Parameters
[in]modelThe model object.
[in]lenThe length of the array.
[in]layer_foldersThe layer folders to be deleted.
Returns
enum SUResult SUModelRemoveLayers ( SUModelRef  model,
size_t  len,
SULayerRef  layers[] 
)
related

Removes all layers provided in the array. The default layer cannot be removed. All entities on the deleted layers will be moved to the default layer.

Since
SketchUp 2019.2 API 7.1
Parameters
[in]modelThe model object.
[in]lenThe length of the array.
[in]layersThe layers to be deleted.
Returns
enum SUResult SUModelRemoveMaterials ( SUModelRef  model,
size_t  len,
SUMaterialRef  materials[] 
)
related

Removes all materials provided in the array.

Since
SketchUp 2019.2, API 7.1
Parameters
[in]modelThe model object.
[in]lenThe length of the array.
[in]materialsThe materials to be deleted.
Returns
enum SUResult SUModelRemoveScenes ( SUModelRef  model,
size_t  len,
SUSceneRef  scenes[] 
)
related

Removes selected scenes from a model.

Since
SketchUp 2019.2, API 7.1
Parameters
[in]modelThe model object.
[in]lenThe number of scenes in the array for removal.
[in]scenesThe scenes to be deleted from the model.
Returns
enum SUResult SUModelSaveToFile ( SUModelRef  model,
const char *  file_path 
)
related

Saves the model to a file.

Note
Prior to SketchUp 2019.2, API 7.1 this function did not generate a new model GUID.
Parameters
[in]modelThe model object.
[in]file_pathThe file path destination of the serialization operation. Assumed to be UTF-8 encoded.
Returns
enum SUResult SUModelSaveToFileWithVersion ( SUModelRef  model,
const char *  file_path,
enum SUModelVersion  version 
)
related

Saves the model to a file using a specific SketchUp version format.

Note
Prior to SketchUp 2019.2, API 7.1 this function did not generate a new model GUID.
Since
SketchUp 2014, API 2.0
Parameters
[in]modelThe model object.
[in]file_pathThe file path destination of the serialization operation. Assumed to be UTF-8 encoded.
[in]versionThe SKP file format version to use when saving.
Returns
enum SUResult SUModelSetActiveLayer ( SUModelRef  model,
SULayerRef  layer 
)
related

Sets the active layer object of a model object.

Since
SketchUp 2020, API 8.0
Parameters
[in]modelThe model object.
[in]layerThe layer object to be set as the active layer.
Returns
enum SUResult SUModelSetActiveScene ( SUModelRef  model,
SUSceneRef  scene 
)
related

Sets the provided scene as the active scene.

Since
SketchUp 2016, API 4.0
Parameters
[in]modelThe model object.
[in]sceneThe scene object to be set as the active scene.
Returns
enum SUResult SUModelSetBehavior ( SUModelRef  model,
const struct SUComponentBehavior behavior 
)
related

Sets the component behavior of a SketchUp model.

Since
SketchUp 2021.1, API 9.1
Parameters
[in]modelThe model object.
[in]behaviorThe behavior to set.
Returns
enum SUResult SUModelSetCamera ( SUModelRef  model,
SUCameraRef camera 
)
related

Sets the current camera of a model object.

Since
SketchUp 2016, API 4.0
Parameters
[in]modelThe model object.
[in]cameraThe camera object. This reference will become invalid when this function returns.
Returns
enum SUResult SUModelSetDescription ( SUModelRef  model,
const char *  description 
)
related

Sets the description of a model object.

Parameters
[in]modelThe model object.
[in]descriptionThe description of the model object. Assumed to be UTF-8 encoded.
Returns
enum SUResult SUModelSetGeoReference ( SUModelRef  model,
double  latitude,
double  longitude,
double  altitude,
bool  is_z_value_centered,
bool  is_on_ocean_floor 
)
related

Georeferences the model.

Parameters
[in]modelThe model object.
[in]latitudeLatitude of the model.
[in]longitudeLongitude of the model.
[in]altitudeAltitude of the model.
[in]is_z_value_centeredIndicates if z value should be centered.
[in]is_on_ocean_floorIndicates whether the model is on the ocean floor.
Returns
enum SUResult SUModelSetName ( SUModelRef  model,
const char *  name 
)
related

Sets the name of a model object.

Parameters
[in]modelThe model object.
[in]nameThe name of the model object. Assumed to be UTF-8 encoded.
Returns

The documentation for this struct was generated from the following files: