References a hatch pattern used for section-fill rendering in SketchUp models. More...

#include <SketchUpAPI/model/hatch_pattern.h>

Related Functions
(Note that these are not member functions.)
SUEntityRef	SUHatchPatternToEntity (SUHatchPatternRef hatch_pattern)
	Converts from an SUHatchPatternRef to an SUEntityRef. This is essentially an upcast operation. More...

SUHatchPatternRef	SUHatchPatternFromEntity (SUEntityRef entity)
	Converts from an SUEntityRef to an SUHatchPatternRef. This is essentially a downcast operation so the given SUEntityRef must be convertible to an SUHatchPatternRef. More...

enum SUResult	SUHatchPatternCreate (SUHatchPatternRef *hatch_pattern)
	Creates a new empty hatch pattern object. More...

enum SUResult	SUHatchPatternCreateFromFile (SUHatchPatternRef hatch_pattern, const char file_name)
	Creates a hatch pattern object from a `.skh` file. More...

enum SUResult	SUHatchPatternRelease (SUHatchPatternRef *hatch_pattern)
	Releases a hatch pattern object that has not been added to a model. More...

enum SUResult	SUHatchPatternGetName (SUHatchPatternRef hatch_pattern, SUStringRef *name)
	Retrieves the name of a hatch pattern object. More...

enum SUResult	SUHatchPatternSetName (SUHatchPatternRef hatch_pattern, const char *name)
	Sets the name of a hatch pattern object. More...

enum SUResult	SUHatchPatternGetData (SUHatchPatternRef hatch_pattern, SUHatchPatternDataRef *hatch_pattern_data)
	Retrieves the fill properties of a hatch pattern object. More...

enum SUResult	SUHatchPatternGetFillColor (SUHatchPatternRef hatch_pattern, SUColor *color)
	Retrieves the solid fill color of a hatch pattern object. More...

enum SUResult	SUHatchPatternSetFillColor (SUHatchPatternRef hatch_pattern, const SUColor *color)
	Sets the solid fill color of a hatch pattern object. More...

enum SUResult	SUHatchPatternGetFillTextureImage (SUHatchPatternRef hatch_pattern, SUImageRepRef *image)
	Retrieves the fill texture image of a hatch pattern object. More...

enum SUResult	SUHatchPatternGetFillTextureFileName (SUHatchPatternRef hatch_pattern, SUStringRef *file_name)
	Retrieves the file name that the fill texture image of a hatch pattern was loaded from. More...

enum SUResult	SUHatchPatternSetFillTextureImageAndFileName (SUHatchPatternRef hatch_pattern, SUImageRepRef image, const char *file_name)
	Sets the fill texture image of a hatch pattern object along with the file name it came from. More...

enum SUResult	SUHatchPatternClearFillTexture (SUHatchPatternRef hatch_pattern)
	Removes the fill texture image from a hatch pattern object. More...

enum SUResult	SUHatchPatternGetUVScale (SUHatchPatternRef hatch_pattern, float u_scale, float v_scale)
	Retrieves the UV scale of a hatch pattern object. More...

enum SUResult	SUHatchPatternSetUVScale (SUHatchPatternRef hatch_pattern, float u_scale, float v_scale)
	Sets the UV scale of a hatch pattern object. More...

enum SUResult	SUHatchPatternGetRotationAngle (SUHatchPatternRef hatch_pattern, float *angle)
	Retrieves the rotation angle of a hatch pattern object, in degrees. More...

enum SUResult	SUHatchPatternSetRotationAngle (SUHatchPatternRef hatch_pattern, float angle)
	Sets the rotation angle of a hatch pattern object, in degrees. More...

enum SUResult	SUHatchPatternGetFillPatternFileName (SUHatchPatternRef hatch_pattern, SUStringRef *file_name)
	Retrieves the file name that the `.pat` line-pattern definition of a hatch pattern was loaded from. More...

enum SUResult	SUHatchPatternSetFillPatternFromFile (SUHatchPatternRef hatch_pattern, const char *file_name)
	Loads the `.pat` line-pattern definition of a hatch pattern object from a file. More...

enum SUResult	SUHatchPatternSaveFillPatternToFile (SUHatchPatternRef hatch_pattern, const char *file_name)
	Writes the `.pat` line-pattern definition of a hatch pattern object to a file. More...

enum SUResult	SUHatchPatternClearFillPattern (SUHatchPatternRef hatch_pattern)
	Removes the `.pat` line-pattern definition from a hatch pattern object. More...

enum SUResult	SUHatchPatternGetThumbnailImage (SUHatchPatternRef hatch_pattern, SUImageRepRef *image)
	Retrieves the thumbnail preview image of a hatch pattern object. More...

enum SUResult	SUHatchPatternWriteToFile (SUHatchPatternRef hatch_pattern, const char *file_name)
	Writes a hatch pattern object to a `.skh` file. More...

Detailed Description

References a hatch pattern used for section-fill rendering in SketchUp models.

Since: SketchUp 2027.0, API 15.0

Friends And Related Function Documentation

enum SUResult SUHatchPatternClearFillPattern ( SUHatchPatternRef hatch_pattern )

Since: SketchUp 2027.0, API 15.0

Parameters

[in] hatch_pattern The hatch pattern object.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object

enum SUResult SUHatchPatternClearFillTexture ( SUHatchPatternRef hatch_pattern )

Since: SketchUp 2027.0, API 15.0

Parameters

[in] hatch_pattern The hatch pattern object.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object

enum SUResult SUHatchPatternCreate ( SUHatchPatternRef * hatch_pattern )

The created hatch pattern is not owned by any model. Either add it to a model's hatch patterns collection with SUHatchPatternsAdd(), which transfers ownership, or release it with SUHatchPatternRelease().

Since: SketchUp 2027.0, API 15.0

Parameters

[out] hatch_pattern The hatch pattern object created.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_OUTPUT if hatch_pattern is NULL
SU_ERROR_OVERWRITE_VALID if hatch_pattern already refers to a valid object

enum SUResult SUHatchPatternCreateFromFile	(	SUHatchPatternRef *	hatch_pattern,
		const char *	file_name
	)

The created hatch pattern is not owned by any model. Either add it to a model's hatch patterns collection with SUHatchPatternsAdd(), which transfers ownership, or release it with SUHatchPatternRelease().

Since: SketchUp 2027.0, API 15.0

Parameters

[out]	hatch_pattern	The hatch pattern object created.
[in]	file_name	The path of the `.skh` file to load. Assumed to be UTF-8 encoded.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_OUTPUT if hatch_pattern is NULL
SU_ERROR_OVERWRITE_VALID if hatch_pattern already refers to a valid object
SU_ERROR_NULL_POINTER_INPUT if file_name is NULL
SU_ERROR_INVALID_ARGUMENT if file_name is empty or does not have a .skh extension
SU_ERROR_SERIALIZATION if the file could not be read or contains no usable definition

SUHatchPatternRef SUHatchPatternFromEntity ( SUEntityRef entity )

Since: SketchUp 2027.0, API 15.0

Parameters

[in] entity The given entity reference.

Returns

The converted SUHatchPatternRef if the downcast operation succeeds
If not, the returned reference will be invalid

enum SUResult SUHatchPatternGetData	(	SUHatchPatternRef	hatch_pattern,
		SUHatchPatternDataRef *	hatch_pattern_data
	)

See Also: SURenderingOptionsSetHatchPattern()

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[out]	hatch_pattern_data	The fill properties retrieved.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if hatch_pattern_data is NULL
SU_ERROR_INVALID_OUTPUT if hatch_pattern_data does not refer to a valid object

enum SUResult SUHatchPatternGetFillColor	(	SUHatchPatternRef	hatch_pattern,
		SUColor *	color
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[out]	color	The color retrieved.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if color is NULL

enum SUResult SUHatchPatternGetFillPatternFileName	(	SUHatchPatternRef	hatch_pattern,
		SUStringRef *	file_name
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[out]	file_name	The file name retrieved. Empty if no definition has been set.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if file_name is NULL
SU_ERROR_INVALID_OUTPUT if file_name does not point to a valid SUStringRef object

enum SUResult SUHatchPatternGetFillTextureFileName	(	SUHatchPatternRef	hatch_pattern,
		SUStringRef *	file_name
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[out]	file_name	The file name retrieved. Empty if no texture has been set.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if file_name is NULL
SU_ERROR_INVALID_OUTPUT if file_name does not point to a valid SUStringRef object

enum SUResult SUHatchPatternGetFillTextureImage	(	SUHatchPatternRef	hatch_pattern,
		SUImageRepRef *	image
	)

image must refer to a valid SUImageRepRef object. The image data is copied into it.

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[out]	image	The image retrieved.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if image is NULL
SU_ERROR_INVALID_OUTPUT if image does not refer to a valid object
SU_ERROR_NO_DATA if hatch_pattern has no fill texture image

enum SUResult SUHatchPatternGetName	(	SUHatchPatternRef	hatch_pattern,
		SUStringRef *	name
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[out]	name	The name retrieved.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if name is NULL
SU_ERROR_INVALID_OUTPUT if name does not point to a valid SUStringRef object

enum SUResult SUHatchPatternGetRotationAngle	(	SUHatchPatternRef	hatch_pattern,
		float *	angle
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[out]	angle	The angle retrieved, in degrees.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if angle is NULL

enum SUResult SUHatchPatternGetThumbnailImage	(	SUHatchPatternRef	hatch_pattern,
		SUImageRepRef *	image
	)

The thumbnail is generated from the hatch pattern's own properties, so it is read only. image must refer to a valid SUImageRepRef object created with SUImageRepCreate(); the image data is copied into it.

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[out]	image	The image retrieved.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if image is NULL
SU_ERROR_INVALID_OUTPUT if image does not refer to a valid object
SU_ERROR_NO_DATA if no thumbnail is available

enum SUResult SUHatchPatternGetUVScale	(	SUHatchPatternRef	hatch_pattern,
		float *	u_scale,
		float *	v_scale
	)

Both values are scale factors applied to the pattern's repeat.

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[out]	u_scale	The scale along the u axis.
[out]	v_scale	The scale along the v axis.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if u_scale or v_scale is NULL

enum SUResult SUHatchPatternRelease ( SUHatchPatternRef * hatch_pattern )

Only call this on a hatch pattern that SUHatchPatternsAdd() has not taken ownership of. hatch_pattern is set to invalid by this function.

Since: SketchUp 2027.0, API 15.0

Parameters

[in,out] hatch_pattern The hatch pattern object.

Returns

SU_ERROR_NONE on success
SU_ERROR_NULL_POINTER_INPUT if hatch_pattern is NULL
SU_ERROR_INVALID_INPUT if hatch_pattern does not refer to a valid object

enum SUResult SUHatchPatternSaveFillPatternToFile	(	SUHatchPatternRef	hatch_pattern,
		const char *	file_name
	)

This writes only the line-pattern definition. To write the whole hatch pattern, use SUHatchPatternWriteToFile().

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[in]	file_name	The path of the `.pat` file to write. Assumed to be UTF-8 encoded.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_NULL_POINTER_INPUT if file_name is NULL
SU_ERROR_INVALID_ARGUMENT if file_name is empty
SU_ERROR_SERIALIZATION if hatch_pattern has no line-pattern definition or the file could not be written

enum SUResult SUHatchPatternSetFillColor	(	SUHatchPatternRef	hatch_pattern,
		const SUColor *	color
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[in]	color	The color to set.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_NULL_POINTER_INPUT if color is NULL

enum SUResult SUHatchPatternSetFillPatternFromFile	(	SUHatchPatternRef	hatch_pattern,
		const char *	file_name
	)

Since: SketchUp 2027.0, API 15.0

Note: A .pat file may hold more than one pattern definition. Only the first definition in the file is loaded; any others are ignored.

Parameters

[in]	hatch_pattern	The hatch pattern object.
[in]	file_name	The path of the `.pat` file to load. Assumed to be UTF-8 encoded.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_NULL_POINTER_INPUT if file_name is NULL
SU_ERROR_INVALID_ARGUMENT if file_name is empty
SU_ERROR_SERIALIZATION if the file could not be read or contains no usable definition

enum SUResult SUHatchPatternSetFillTextureImageAndFileName	(	SUHatchPatternRef	hatch_pattern,
		SUImageRepRef	image,
		const char *	file_name
	)

The image and its source file name are a unit, so they are set together. file_name records where the image came from and may be empty for an image that has no file on disk.

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[in]	image	The image to set.
[in]	file_name	The file name the image came from. Assumed to be UTF-8 encoded.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern or image is not a valid object
SU_ERROR_NULL_POINTER_INPUT if file_name is NULL
SU_ERROR_INVALID_ARGUMENT if image does not contain valid image data

enum SUResult SUHatchPatternSetName	(	SUHatchPatternRef	hatch_pattern,
		const char *	name
	)

The name must not be empty. Once the hatch pattern belongs to a model, the name must also be unique within that model; assigning a hatch pattern its own current name is allowed and does nothing.

See Also: SUHatchPatternsGetHatchPatternByName(); SUHatchPatternsAdd()

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[in]	name	The name to set. Assumed to be UTF-8 encoded.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_NULL_POINTER_INPUT if name is NULL
SU_ERROR_INVALID_ARGUMENT if name is empty, or if another hatch pattern in the same model already uses name

enum SUResult SUHatchPatternSetRotationAngle	(	SUHatchPatternRef	hatch_pattern,
		float	angle
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[in]	angle	The angle to set, in degrees. Defaults to 0.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object

enum SUResult SUHatchPatternSetUVScale	(	SUHatchPatternRef	hatch_pattern,
		float	u_scale,
		float	v_scale
	)

Both values are scale factors applied to the pattern's repeat, and both must be positive.

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[in]	u_scale	The scale to set along the u axis.
[in]	v_scale	The scale to set along the v axis.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_OUT_OF_RANGE if u_scale or v_scale is not positive

SUEntityRef SUHatchPatternToEntity ( SUHatchPatternRef hatch_pattern )

Since: SketchUp 2027.0, API 15.0

Parameters

[in] hatch_pattern The given hatch pattern reference.

Returns

The converted SUEntityRef if hatch_pattern is a valid object
If not, the returned reference will be invalid

enum SUResult SUHatchPatternWriteToFile	(	SUHatchPatternRef	hatch_pattern,
		const char *	file_name
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern	The hatch pattern object.
[in]	file_name	The path of the `.skh` file to write. Assumed to be UTF-8 encoded.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern is not a valid object
SU_ERROR_NULL_POINTER_INPUT if file_name is NULL
SU_ERROR_INVALID_ARGUMENT if file_name is empty or does not have a .skh extension
SU_ERROR_SERIALIZATION if the file could not be written

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

SketchUpAPI/model/defs.h
SketchUpAPI/model/hatch_pattern.h

Related Functions

Detailed Description

Friends And Related Function Documentation