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

References a the model selection. This is only available from within the SketchUp application. More...

#include <SketchUpAPI/model/selection.h>

Related Functions

(Note that these are not member functions.)

enum SUResult SUSelectionAdd (SUSelectionRef selection, size_t num_elements, const SUDrawingElementRef elements[])
 Adds items to the selection set. More...
 
enum SUResult SUSelectionRemove (SUSelectionRef selection, size_t num_elements, const SUDrawingElementRef elements[])
 Removes items from the selection set. More...
 
enum SUResult SUSelectionToggle (SUSelectionRef selection, size_t num_elements, const SUDrawingElementRef elements[])
 Toggle items in the selection set. More...
 
enum SUResult SUSelectionClear (SUSelectionRef selection)
 Clears the selection set. More...
 
enum SUResult SUSelectionInvert (SUSelectionRef selection)
 Inverts the selection set. More...
 
enum SUResult SUSelectionGetNumElements (SUSelectionRef selection, size_t *num_elements)
 Gets the number of items in the selection set. More...
 
enum SUResult SUSelectionGetEntityList (SUSelectionRef selection, SUEntityListRef *entity_list)
 Fills the list with items from the selection set. More...
 
enum SUResult SUSelectionIsType (SUSelectionRef selection, enum SUSelectionType type, bool *is_type)
 Used to determine the type of selection. More...
 

Detailed Description

References a the model selection. This is only available from within the SketchUp application.

Friends And Related Function Documentation

enum SUResult SUSelectionAdd ( SUSelectionRef  selection,
size_t  num_elements,
const SUDrawingElementRef  elements[] 
)
related

Adds items to the selection set.

Since
SketchUp 2020.2, API 8.2
Parameters
[in]selectionThe selection object.
[in]num_elementsThe length of the array of drawing elements.
[in]elementsThe array of drawing elements objects to add.
Returns
enum SUResult SUSelectionClear ( SUSelectionRef  selection)
related

Clears the selection set.

Since
SketchUp 2020.2, API 8.2
Parameters
[in]selectionThe selection object.
Returns
enum SUResult SUSelectionGetEntityList ( SUSelectionRef  selection,
SUEntityListRef entity_list 
)
related

Fills the list with items from the selection set.

Since
SketchUp 2020.2, API 8.2
Parameters
[in]selectionThe selection object.
[out]entity_listThe list object to be filled.
Returns
enum SUResult SUSelectionGetNumElements ( SUSelectionRef  selection,
size_t *  num_elements 
)
related

Gets the number of items in the selection set.

Since
SketchUp 2020.2, API 8.2
Parameters
[in]selectionThe selection object.
[out]num_elementsThe number of items in the selection set.
Returns
enum SUResult SUSelectionInvert ( SUSelectionRef  selection)
related

Inverts the selection set.

Since
SketchUp 2020.2, API 8.2
Parameters
[in]selectionThe selection object.
Returns
enum SUResult SUSelectionIsType ( SUSelectionRef  selection,
enum SUSelectionType  type,
bool *  is_type 
)
related

Used to determine the type of selection.

Since
SketchUp 2020.2, API 8.2
Parameters
[in]selectionThe selection object.
[in]typeThe type of selection to query for.
[out]is_typeTrue if the selection is of the type queried for.
See Also
SUSelectionType
Returns
enum SUResult SUSelectionRemove ( SUSelectionRef  selection,
size_t  num_elements,
const SUDrawingElementRef  elements[] 
)
related

Removes items from the selection set.

Since
SketchUp 2020.2, API 8.2
Parameters
[in]selectionThe selection object.
[in]num_elementsThe length of the array of drawing elements.
[in]elementsThe array of drawing elements objects to remove.
Returns
enum SUResult SUSelectionToggle ( SUSelectionRef  selection,
size_t  num_elements,
const SUDrawingElementRef  elements[] 
)
related

Toggle items in the selection set.

Since
SketchUp 2020.2, API 8.2
Parameters
[in]selectionThe selection object.
[in]num_elementsThe length of the array of drawing elements.
[in]elementsThe array of drawing elements objects to toggle.
Returns

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