PathGradientBrush Class
Summary: Encapsulates a Brush object with a gradient. This class cannot be inherited.
Module: aspose.imaging.brushes
Full Name: aspose.imaging.brushes.PathGradientBrush
Inheritance: PathGradientBrushBase
Aspose.Imaging Version: 24.5.0
Constructors
| Name | Description |
|---|---|
| PathGradientBrush(path) | Initializes a new instance of the PathGradientBrush class |
| PathGradientBrush(path_points) | Initializes a new instance of the PathGradientBrush class |
| PathGradientBrush(path_points) | Initializes a new instance of the PathGradientBrush class |
| PathGradientBrush(path_points, wrap_mode) | Initializes a new instance of the PathGradientBrush class |
| PathGradientBrush(path_points, wrap_mode) | Initializes a new instance of the PathGradientBrush class |
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| blend | Blend | r/w | Gets or sets a Blend that specifies positions and factors that define a custom falloff for the gradient. |
| center_color | Color | r/w | Gets or sets the color at the center of the path gradient. |
| center_point | PointF | r/w | Gets or sets the center point of the path gradient. |
| disposed | bool | r | Gets a value indicating whether this instance is disposed. |
| focus_scales | PointF | r/w | Gets or sets the focus point for the gradient falloff. |
| graphics_path | GraphicsPath | r | Gets the graphics path this brush was build upon. |
| interpolation_colors | ColorBlend | r/w | Gets or sets a ColorBlend that defines a multicolor linear gradient. |
| is_transform_changed | bool | r | Gets a value indicating whether transformations were changed in some way. For example setting the transformation matrix or calling any of the methods altering the transformation matrix. The property is introduced for backward compatibility with GDI+. |
| opacity | float | r/w | Gets or sets the brush opacity. The value should be between 0 and 1. Value of 0 means that brush is fully visible, value of 1 means the brush is fully opaque. |
| path_points | PointF[] | r | Gets the path points this brush was build upon. |
| surround_colors | Color[] | r/w | Gets or sets an array of colors that correspond to the points in the path this PathGradientBrush fills. |
| transform | Matrix | r/w | Gets or sets a copy Matrix that defines a local geometric transform for this TransformBrush. |
| wrap_mode | WrapMode | r/w | Gets or sets a WrapMode enumeration that indicates the wrap mode for this TransformBrush. |
Methods
| Name | Description |
|---|---|
| create_with_path(path) | Initializes a new instance of the PathGradientBrush class with the specified path. |
| create_with_points(path_points) | Initializes a new instance of the PathGradientBrush class with the specified points. |
| create_with_points_f(path_points) | Initializes a new instance of the PathGradientBrush class with the specified points. |
| create_with_points_f_wrap_mode(path_points, wrap_mode) | Initializes a new instance of the PathGradientBrush class with the specified points and wrap mode. |
| create_with_points_wrap_mode(path_points, wrap_mode) | Initializes a new instance of the PathGradientBrush class with the specified points and wrap mode. |
| deep_clone() | Creates a new deep clone of the current Brush. |
| multiply_transform(matrix) | Multiplies the Matrix that represents the local geometric transform of this LinearGradientBrush by the specified Matrix by prepending the specified Matrix. |
| multiply_transform(matrix, order) | Multiplies the Matrix that represents the local geometric transform of this LinearGradientBrush by the specified Matrix in the specified order. |
| reset_transform() | Resets the TransformBrush.transform property to identity. |
| rotate_transform(angle) | Rotates the local geometric transform by the specified amount. This method prepends the rotation to the transform. |
| rotate_transform(angle, order) | Rotates the local geometric transform by the specified amount in the specified order. |
| scale_transform(sx, sy) | Scales the local geometric transform by the specified amounts. This method prepends the scaling matrix to the transform. |
| scale_transform(sx, sy, order) | Scales the local geometric transform by the specified amounts in the specified order. |
| set_blend_triangular_shape(focus) | Creates a gradient with a center color and a linear falloff to one surrounding color. |
| set_blend_triangular_shape(focus, scale) | Creates a gradient with a center color and a linear falloff to each surrounding color. |
| set_sigma_bell_shape(focus) | Creates a gradient brush that changes color starting from the center of the path outward to the path’s boundary. The transition from one color to another is based on a bell-shaped curve. |
| set_sigma_bell_shape(focus, scale) | Creates a gradient brush that changes color starting from the center of the path outward to the path’s boundary. The transition from one color to another is based on a bell-shaped curve. |
| translate_transform(dx, dy) | Translates the local geometric transform by the specified dimensions. This method prepends the translation to the transform. |
| translate_transform(dx, dy, order) | Translates the local geometric transform by the specified dimensions in the specified order. |
Constructor: PathGradientBrush(path)
PathGradientBrush(path)
Initializes a new instance of the PathGradientBrush class
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | GraphicsPath |
Constructor: PathGradientBrush(path_points)
PathGradientBrush(path_points)
Initializes a new instance of the PathGradientBrush class
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path_points | PointF[] |
Constructor: PathGradientBrush(path_points)
PathGradientBrush(path_points)
Initializes a new instance of the PathGradientBrush class
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path_points | Point[] |
Constructor: PathGradientBrush(path_points, wrap_mode)
PathGradientBrush(path_points, wrap_mode)
Initializes a new instance of the PathGradientBrush class
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path_points | PointF[] | |
| wrap_mode | WrapMode |
Constructor: PathGradientBrush(path_points, wrap_mode)
PathGradientBrush(path_points, wrap_mode)
Initializes a new instance of the PathGradientBrush class
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path_points | Point[] | |
| wrap_mode | WrapMode |
Method: create_with_path(path) [static]
create_with_path(path)
Initializes a new instance of the PathGradientBrush class with the specified path.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path | GraphicsPath | The GraphicsPath that defines the area filled by this PathGradientBrush. |
Returns
| Type | Description |
|---|---|
| PathGradientBrush |
Method: create_with_points(path_points) [static]
create_with_points(path_points)
Initializes a new instance of the PathGradientBrush class with the specified points.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path_points | Point[] | An array of PointF structures that represents the points that make up the vertices of the path. |
Returns
| Type | Description |
|---|---|
| PathGradientBrush |
Method: create_with_points_f(path_points) [static]
create_with_points_f(path_points)
Initializes a new instance of the PathGradientBrush class with the specified points.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path_points | PointF[] | An array of PointF structures that represents the points that make up the vertices of the path. |
Returns
| Type | Description |
|---|---|
| PathGradientBrush |
Method: create_with_points_f_wrap_mode(path_points, wrap_mode) [static]
create_with_points_f_wrap_mode(path_points, wrap_mode)
Initializes a new instance of the PathGradientBrush class with the specified points and wrap mode.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path_points | PointF[] | An array of PointF structures that represents the points that make up the vertices of the path. |
| wrap_mode | WrapMode | A WrapMode that specifies how fills drawn with this PathGradientBrush are tiled. |
Returns
| Type | Description |
|---|---|
| PathGradientBrush |
Method: create_with_points_wrap_mode(path_points, wrap_mode) [static]
create_with_points_wrap_mode(path_points, wrap_mode)
Initializes a new instance of the PathGradientBrush class with the specified points and wrap mode.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| path_points | Point[] | An array of Point structures that represents the points that make up the vertices of the path. |
| wrap_mode | WrapMode | A WrapMode that specifies how fills drawn with this PathGradientBrush are tiled. |
Returns
| Type | Description |
|---|---|
| PathGradientBrush |
Method: deep_clone()
deep_clone()
Creates a new deep clone of the current Brush.
Returns
| Type | Description |
|---|---|
| Brush | A new Brush which is the deep clone of this Brush instance. |
Method: multiply_transform(matrix)
multiply_transform(matrix)
Multiplies the Matrix that represents the local geometric transform of this LinearGradientBrush by the specified Matrix by prepending the specified Matrix.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| matrix | Matrix | The Matrix by which to multiply the geometric transform. |
Method: multiply_transform(matrix, order)
multiply_transform(matrix, order)
Multiplies the Matrix that represents the local geometric transform of this LinearGradientBrush by the specified Matrix in the specified order.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| matrix | Matrix | The Matrix by which to multiply the geometric transform. |
| order | MatrixOrder | A MatrixOrder that specifies in which order to multiply the two matrices. |
Method: rotate_transform(angle)
rotate_transform(angle)
Rotates the local geometric transform by the specified amount. This method prepends the rotation to the transform.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| angle | float | The angle of rotation. |
Method: rotate_transform(angle, order)
rotate_transform(angle, order)
Rotates the local geometric transform by the specified amount in the specified order.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| angle | float | The angle of rotation. |
| order | MatrixOrder | A MatrixOrder that specifies whether to append or prepend the rotation matrix. |
Method: scale_transform(sx, sy)
scale_transform(sx, sy)
Scales the local geometric transform by the specified amounts. This method prepends the scaling matrix to the transform.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| sx | float | The amount by which to scale the transform in the x-axis direction. |
| sy | float | The amount by which to scale the transform in the y-axis direction. |
Method: scale_transform(sx, sy, order)
scale_transform(sx, sy, order)
Scales the local geometric transform by the specified amounts in the specified order.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| sx | float | The amount by which to scale the transform in the x-axis direction. |
| sy | float | The amount by which to scale the transform in the y-axis direction. |
| order | MatrixOrder | A MatrixOrder that specifies whether to append or prepend the scaling matrix. |
Method: set_blend_triangular_shape(focus)
set_blend_triangular_shape(focus)
Creates a gradient with a center color and a linear falloff to one surrounding color.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| focus | float | A value from 0 through 1 that specifies where, along any radial from the center of the path to the path’s boundary, the center color will be at its highest intensity. A value of 1 (the default) places the highest intensity at the center of the path. |
Method: set_blend_triangular_shape(focus, scale)
set_blend_triangular_shape(focus, scale)
Creates a gradient with a center color and a linear falloff to each surrounding color.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| focus | float | A value from 0 through 1 that specifies where, along any radial from the center of the path to the path’s boundary, the center color will be at its highest intensity. A value of 1 (the default) places the highest intensity at the center of the path. |
| scale | float | A value from 0 through 1 that specifies the maximum intensity of the center color that gets blended with the boundary color. A value of 1 causes the highest possible intensity of the center color, and it is the default value. |
Method: set_sigma_bell_shape(focus)
set_sigma_bell_shape(focus)
Creates a gradient brush that changes color starting from the center of the path outward to the path’s boundary. The transition from one color to another is based on a bell-shaped curve.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| focus | float | A value from 0 through 1 that specifies where, along any radial from the center of the path to the path’s boundary, the center color will be at its highest intensity. A value of 1 (the default) places the highest intensity at the center of the path. |
Method: set_sigma_bell_shape(focus, scale)
set_sigma_bell_shape(focus, scale)
Creates a gradient brush that changes color starting from the center of the path outward to the path’s boundary. The transition from one color to another is based on a bell-shaped curve.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| focus | float | A value from 0 through 1 that specifies where, along any radial from the center of the path to the path’s boundary, the center color will be at its highest intensity. A value of 1 (the default) places the highest intensity at the center of the path. |
| scale | float | A value from 0 through 1 that specifies the maximum intensity of the center color that gets blended with the boundary color. A value of 1 causes the highest possible intensity of the center color, and it is the default value. |
Method: translate_transform(dx, dy)
translate_transform(dx, dy)
Translates the local geometric transform by the specified dimensions. This method prepends the translation to the transform.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| dx | float | The value of the translation in x. |
| dy | float | The value of the translation in y. |
Method: translate_transform(dx, dy, order)
translate_transform(dx, dy, order)
Translates the local geometric transform by the specified dimensions in the specified order.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| dx | float | The value of the translation in x. |
| dy | float | The value of the translation in y. |
| order | MatrixOrder | The order (prepend or append) in which to apply the translation. |