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

References an entity list iterator object. More...

#include <SketchUpAPI/model/entity_list_iterator.h>

Related Functions

(Note that these are not member functions.)

enum SUResult SUEntityListIteratorCreate (SUEntityListIteratorRef *iterator)
 Creates an entity list iterator object. More...
 
enum SUResult SUEntityListIteratorRelease (SUEntityListIteratorRef *iterator)
 Releases a iterator object. More...
 
enum SUResult SUEntityListIteratorGetEntity (SUEntityListIteratorRef iterator, SUEntityRef *entity)
 Retrieves the specified entity pointer from the given iterator. More...
 
enum SUResult SUEntityListIteratorNext (SUEntityListIteratorRef iterator)
 Increments the provided iterator. More...
 
enum SUResult SUEntityListIteratorIsInRange (SUEntityListIteratorRef iterator, bool *in_range)
 Checks if the iterator is still within range of the list. More...
 

Detailed Description

References an entity list iterator object.

Since
SketchUp 2018, API 6.0

Friends And Related Function Documentation

enum SUResult SUEntityListIteratorCreate ( SUEntityListIteratorRef iterator)
related

Creates an entity list iterator object.

Since
SketchUp 2018, API 6.0
Parameters
[in,out]iteratorThe entity list iterator object to be created.
Returns
enum SUResult SUEntityListIteratorGetEntity ( SUEntityListIteratorRef  iterator,
SUEntityRef entity 
)
related

Retrieves the specified entity pointer from the given iterator.

Since
SketchUp 2018, API 6.0
Parameters
[in]iteratorThe iterator from which to retrieve the entity.
[out]entityThe entity reference retrieved.
Returns
enum SUResult SUEntityListIteratorIsInRange ( SUEntityListIteratorRef  iterator,
bool *  in_range 
)
related

Checks if the iterator is still within range of the list.

Since
SketchUp 2018, API 6.0
Parameters
[in]iteratorThe iterator to be queried.
[out]in_rangeA boolean indicating if the iterator is in range.
Returns
enum SUResult SUEntityListIteratorNext ( SUEntityListIteratorRef  iterator)
related

Increments the provided iterator.

Since
SketchUp 2018, API 6.0
Parameters
[in,out]iteratorThe iterator to be incremented.
Returns
enum SUResult SUEntityListIteratorRelease ( SUEntityListIteratorRef iterator)
related

Releases a iterator object.

Since
SketchUp 2018, API 6.0
Parameters
[in,out]iteratorThe iterator object to be released.
Returns

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