References the section-fill properties of a hatch pattern, without the pattern itself. More...

#include <SketchUpAPI/model/hatch_pattern_data.h>

Related Functions
(Note that these are not member functions.)
enum SUResult	SUHatchPatternDataCreate (SUHatchPatternDataRef *hatch_pattern_data)
	Creates a new hatch pattern data object with default fill properties. More...

enum SUResult	SUHatchPatternDataRelease (SUHatchPatternDataRef *hatch_pattern_data)
	Releases a hatch pattern data object. More...

enum SUResult	SUHatchPatternDataGetFillColor (SUHatchPatternDataRef hatch_pattern_data, SUColor *color)
	Retrieves the solid fill color of a hatch pattern data object. More...

enum SUResult	SUHatchPatternDataSetFillColor (SUHatchPatternDataRef hatch_pattern_data, const SUColor *color)
	Sets the solid fill color of a hatch pattern data object. More...

enum SUResult	SUHatchPatternDataGetFillTextureImage (SUHatchPatternDataRef hatch_pattern_data, SUImageRepRef *image)
	Retrieves the fill texture image of a hatch pattern data object. More...

enum SUResult	SUHatchPatternDataGetFillTextureFileName (SUHatchPatternDataRef hatch_pattern_data, SUStringRef *file_name)
	Retrieves the file name that the fill texture image of a hatch pattern data object was loaded from. More...

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

enum SUResult	SUHatchPatternDataClearFillTexture (SUHatchPatternDataRef hatch_pattern_data)
	Removes the fill texture image from a hatch pattern data object. More...

enum SUResult	SUHatchPatternDataGetUVScale (SUHatchPatternDataRef hatch_pattern_data, float u_scale, float v_scale)
	Retrieves the UV scale of a hatch pattern data object. More...

enum SUResult	SUHatchPatternDataSetUVScale (SUHatchPatternDataRef hatch_pattern_data, float u_scale, float v_scale)
	Sets the UV scale of a hatch pattern data object. More...

enum SUResult	SUHatchPatternDataGetRotationAngle (SUHatchPatternDataRef hatch_pattern_data, float *angle)
	Retrieves the rotation angle of a hatch pattern data object, in degrees. More...

enum SUResult	SUHatchPatternDataSetRotationAngle (SUHatchPatternDataRef hatch_pattern_data, float angle)
	Sets the rotation angle of a hatch pattern data object, in degrees. More...

enum SUResult	SUHatchPatternDataGetFillPatternFileName (SUHatchPatternDataRef hatch_pattern_data, SUStringRef *file_name)
	Retrieves the file name that the `.pat` line-pattern definition of a hatch pattern data object was loaded from. More...

enum SUResult	SUHatchPatternDataSetFillPatternFromFile (SUHatchPatternDataRef hatch_pattern_data, const char *file_name)
	Loads the `.pat` line-pattern definition of a hatch pattern data object from a file. More...

enum SUResult	SUHatchPatternDataSaveFillPatternToFile (SUHatchPatternDataRef hatch_pattern_data, const char *file_name)
	Writes the `.pat` line-pattern definition of a hatch pattern data object to a file. More...

enum SUResult	SUHatchPatternDataClearFillPattern (SUHatchPatternDataRef hatch_pattern_data)
	Removes the `.pat` line-pattern definition from a hatch pattern data object. More...

enum SUResult	SUHatchPatternDataIsEqual (SUHatchPatternDataRef hatch_pattern_data, SUHatchPatternDataRef other_hatch_pattern_data, bool *equal)
	Compares two hatch pattern data objects for equal fill properties. More...

Detailed Description

References the section-fill properties of a hatch pattern, without the pattern itself.

A hatch pattern data object holds the same fill properties as an SUHatchPatternRef - color, texture, .pat line-pattern definition, scale and rotation - but it is a standalone value rather than an object owned by a model. It has no name, because it does not appear in a model's hatch pattern collection. This is the type a style's section fill is expressed in; see SURenderingOptionsGetHatchPattern() and SURenderingOptionsSetHatchPattern(). To take the fill properties of a model-owned pattern, use SUHatchPatternGetData().

Since: SketchUp 2027.0, API 15.0

Friends And Related Function Documentation

enum SUResult SUHatchPatternDataClearFillPattern ( SUHatchPatternDataRef hatch_pattern_data )

Since: SketchUp 2027.0, API 15.0

Parameters

[in] hatch_pattern_data The hatch pattern data object.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern_data is not a valid object

enum SUResult SUHatchPatternDataClearFillTexture ( SUHatchPatternDataRef hatch_pattern_data )

Since: SketchUp 2027.0, API 15.0

Parameters

[in] hatch_pattern_data The hatch pattern data object.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern_data is not a valid object

enum SUResult SUHatchPatternDataCreate ( SUHatchPatternDataRef * hatch_pattern_data )

The created object is standalone and is never owned by a model, so release it with SUHatchPatternDataRelease() when it is no longer needed. Passing it to SURenderingOptionsSetHatchPattern() copies its properties and does not transfer ownership.

Since: SketchUp 2027.0, API 15.0

Parameters

[out] hatch_pattern_data The hatch pattern data object created.

Returns

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

enum SUResult SUHatchPatternDataGetFillColor	(	SUHatchPatternDataRef	hatch_pattern_data,
		SUColor *	color
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern_data	The hatch pattern data object.
[out]	color	The color retrieved.

Returns

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

enum SUResult SUHatchPatternDataGetFillPatternFileName	(	SUHatchPatternDataRef	hatch_pattern_data,
		SUStringRef *	file_name
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern_data	The hatch pattern data 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_data 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 SUHatchPatternDataGetFillTextureFileName	(	SUHatchPatternDataRef	hatch_pattern_data,
		SUStringRef *	file_name
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern_data	The hatch pattern data 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_data 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 SUHatchPatternDataGetFillTextureImage	(	SUHatchPatternDataRef	hatch_pattern_data,
		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_data	The hatch pattern data object.
[out]	image	The image retrieved.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern_data 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_data has no fill texture image

enum SUResult SUHatchPatternDataGetRotationAngle	(	SUHatchPatternDataRef	hatch_pattern_data,
		float *	angle
	)

Since: SketchUp 2027.0, API 15.0

Parameters

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

Returns

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

enum SUResult SUHatchPatternDataGetUVScale	(	SUHatchPatternDataRef	hatch_pattern_data,
		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_data	The hatch pattern data 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_data is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if u_scale or v_scale is NULL

enum SUResult SUHatchPatternDataIsEqual	(	SUHatchPatternDataRef	hatch_pattern_data,
		SUHatchPatternDataRef	other_hatch_pattern_data,
		bool *	equal
	)

Two objects compare equal when they would produce the same section fill, regardless of which object each was obtained from.

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern_data	The first hatch pattern data object.
[in]	other_hatch_pattern_data	The second hatch pattern data object.
[out]	equal	Whether the two objects have equal fill properties.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if hatch_pattern_data or other_hatch_pattern_data is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if equal is NULL

enum SUResult SUHatchPatternDataRelease ( SUHatchPatternDataRef * hatch_pattern_data )

hatch_pattern_data is set to invalid by this function.

Since: SketchUp 2027.0, API 15.0

Parameters

[in,out] hatch_pattern_data The hatch pattern data object.

Returns

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

enum SUResult SUHatchPatternDataSaveFillPatternToFile	(	SUHatchPatternDataRef	hatch_pattern_data,
		const char *	file_name
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern_data	The hatch pattern data 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_data 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_data has no line-pattern definition or the file could not be written

enum SUResult SUHatchPatternDataSetFillColor	(	SUHatchPatternDataRef	hatch_pattern_data,
		const SUColor *	color
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern_data	The hatch pattern data object.
[in]	color	The color to set.

Returns

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

enum SUResult SUHatchPatternDataSetFillPatternFromFile	(	SUHatchPatternDataRef	hatch_pattern_data,
		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_data	The hatch pattern data 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_data 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 SUHatchPatternDataSetFillTextureImageAndFileName	(	SUHatchPatternDataRef	hatch_pattern_data,
		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_data	The hatch pattern data 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_data 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 SUHatchPatternDataSetRotationAngle	(	SUHatchPatternDataRef	hatch_pattern_data,
		float	angle
	)

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern_data	The hatch pattern data 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_data is not a valid object

enum SUResult SUHatchPatternDataSetUVScale	(	SUHatchPatternDataRef	hatch_pattern_data,
		float	u_scale,
		float	v_scale
	)

Both values are scale factors applied to the pattern's repeat, and both must be positive. Neither axis is changed when either value is rejected.

Since: SketchUp 2027.0, API 15.0

Parameters

[in]	hatch_pattern_data	The hatch pattern data 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_data is not a valid object
SU_ERROR_OUT_OF_RANGE if u_scale or v_scale is not positive

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

SketchUpAPI/model/defs.h
SketchUpAPI/model/hatch_pattern_data.h

Related Functions

Detailed Description

Friends And Related Function Documentation