A model's collection of hatch patterns. More...

#include <SketchUpAPI/model/hatch_patterns.h>

Related Functions
(Note that these are not member functions.)
enum SUResult	SUHatchPatternsGetCount (SUHatchPatternsRef hatch_patterns, size_t *count)
	Retrieves the number of hatch patterns in a hatch patterns collection. More...

enum SUResult	SUHatchPatternsGetAll (SUHatchPatternsRef hatch_patterns, size_t len, SUHatchPatternRef items[], size_t *count)
	Retrieves the hatch patterns in a hatch patterns collection. More...

enum SUResult	SUHatchPatternsGetHatchPatternByName (SUHatchPatternsRef hatch_patterns, const char name, SUHatchPatternRef hatch_pattern)
	Retrieves a hatch pattern from a hatch patterns collection by name. More...

enum SUResult	SUHatchPatternsGetSelectedHatchPattern (SUHatchPatternsRef hatch_patterns, SUHatchPatternRef *hatch_pattern)
	Retrieves the selected hatch pattern of a hatch patterns collection. More...

enum SUResult	SUHatchPatternsSetSelectedHatchPattern (SUHatchPatternsRef hatch_patterns, SUHatchPatternRef hatch_pattern)
	Sets the selected hatch pattern of a hatch patterns collection. More...

enum SUResult	SUHatchPatternsAdd (SUHatchPatternsRef hatch_patterns, SUHatchPatternRef hatch_pattern)
	Adds a hatch pattern to a hatch patterns collection. More...

enum SUResult	SUHatchPatternsRemove (SUHatchPatternsRef hatch_patterns, SUHatchPatternRef *hatch_pattern)
	Removes a hatch pattern from a hatch patterns collection. More...

enum SUResult	SUHatchPatternsPurgeUnused (SUHatchPatternsRef hatch_patterns)
	Removes the hatch patterns that are not referenced by any entity. More...

Detailed Description

A model's collection of hatch patterns.

Obtained from SUModelGetHatchPatterns(). The collection is owned by the model and must not be released.

Since: SketchUp 2027.0, API 15.0

Friends And Related Function Documentation

enum SUResult SUHatchPatternsAdd	(	SUHatchPatternsRef	hatch_patterns,
		SUHatchPatternRef	hatch_pattern
	)

Note: Ownership transfers to the collection only when this function returns SU_ERROR_NONE. On success the caller must not call SUHatchPatternRelease() on hatch_pattern. On any failure the caller retains ownership and remains responsible for releasing hatch_pattern.

Names must be unique within the collection, compared case insensitively.

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_patterns	The hatch patterns collection object.
[in]	hatch_pattern	The hatch pattern to add.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_patterns or hatch_pattern is not a valid object
SU_ERROR_DUPLICATE if hatch_pattern is already in hatch_patterns
SU_ERROR_INVALID_ARGUMENT if a different hatch pattern in hatch_patterns already has hatch_pattern's name

enum SUResult SUHatchPatternsGetAll	(	SUHatchPatternsRef	hatch_patterns,
		size_t	len,
		SUHatchPatternRef	items[],
		size_t *	count
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_patterns	The hatch patterns collection object.
[in]	len	The number of hatch patterns to retrieve.
[out]	items	The hatch patterns retrieved.
[out]	count	The number of hatch patterns retrieved.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_patterns is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if items or count is NULL
SU_ERROR_NO_DATA if the collection is empty

enum SUResult SUHatchPatternsGetCount	(	SUHatchPatternsRef	hatch_patterns,
		size_t *	count
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_patterns	The hatch patterns collection object.
[out]	count	The number of hatch patterns.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_patterns is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if count is NULL

enum SUResult SUHatchPatternsGetHatchPatternByName	(	SUHatchPatternsRef	hatch_patterns,
		const char *	name,
		SUHatchPatternRef *	hatch_pattern
	)

The comparison is case insensitive, matching how the collection enforces name uniqueness.

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_patterns	The hatch patterns collection object.
[in]	name	The name to look for. Assumed to be UTF-8 encoded.
[out]	hatch_pattern	The hatch pattern retrieved.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_patterns is not a valid object
SU_ERROR_NULL_POINTER_INPUT if name is NULL
SU_ERROR_NULL_POINTER_OUTPUT if hatch_pattern is NULL
SU_ERROR_NO_DATA if no hatch pattern has the given name

enum SUResult SUHatchPatternsGetSelectedHatchPattern	(	SUHatchPatternsRef	hatch_patterns,
		SUHatchPatternRef *	hatch_pattern
	)

The selection is the pattern the UI applies to newly created section fills. It is not persisted with the model.

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_patterns	The hatch patterns collection object.
[out]	hatch_pattern	The hatch pattern retrieved.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_patterns is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if hatch_pattern is NULL
SU_ERROR_NO_DATA if no hatch pattern is selected

enum SUResult SUHatchPatternsPurgeUnused ( SUHatchPatternsRef hatch_patterns )

Any ref to a purged hatch pattern is stale after this call and must not be used or released.

Since: SketchUp 2027.0, API 15.0

Parameters

[in] hatch_patterns The hatch patterns collection object.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_patterns is not a valid object

enum SUResult SUHatchPatternsRemove	(	SUHatchPatternsRef	hatch_patterns,
		SUHatchPatternRef *	hatch_pattern
	)

Entities referencing the removed hatch pattern have their pattern cleared. hatch_pattern is set to an invalid reference on success and must not be used or released afterward.

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_patterns	The hatch patterns collection object.
[in,out]	hatch_pattern	The hatch pattern to remove.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_patterns is not a valid object, or hatch_pattern does not reference a valid object
SU_ERROR_NULL_POINTER_INPUT if hatch_pattern is NULL
SU_ERROR_INVALID_OPERATION if hatch_pattern is not in hatch_patterns

enum SUResult SUHatchPatternsSetSelectedHatchPattern	(	SUHatchPatternsRef	hatch_patterns,
		SUHatchPatternRef	hatch_pattern
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_patterns	The hatch patterns collection object.
[in]	hatch_pattern	The hatch pattern to select. Must belong to this collection.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_patterns or hatch_pattern is not a valid object
SU_ERROR_INVALID_ARGUMENT if hatch_pattern does not belong to hatch_patterns

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

SketchUpAPI/model/defs.h
SketchUpAPI/model/hatch_patterns.h

Related Functions

Detailed Description

Friends And Related Function Documentation