PathMulticolorGradientBrush Class

Summary: Encapsulates a Brush object with a gradient. This class cannot be inherited.

Module: aspose.imaging.brushes

Full Name: aspose.imaging.brushes.PathMulticolorGradientBrush

Inheritance: PathGradientBrushBase

Constructors

NameDescription
PathMulticolorGradientBrush(path)Initializes a new instance of the PathMulticolorGradientBrush class with the specified points.
PathMulticolorGradientBrush(path_points)Initializes a new instance of the PathMulticolorGradientBrush class with the specified points.
PathMulticolorGradientBrush(path_points)Initializes a new instance of the PathMulticolorGradientBrush class with the specified points.
PathMulticolorGradientBrush(path_points, wrap_mode)Initializes a new instance of the PathMulticolorGradientBrush class with the specified points and wrap mode.
PathMulticolorGradientBrush(path_points, wrap_mode)Initializes a new instance of the PathMulticolorGradientBrush class with the specified points and wrap mode.

Properties

NameTypeAccessDescription
center_pointPointFr/wGets or sets the center point of the path gradient.
disposedboolrGets a value indicating whether this instance is disposed.
focus_scalesPointFr/wGets or sets the focus point for the gradient falloff.
graphics_pathGraphicsPathrGets the graphics path this brush was build upon.
interpolation_colorsColorBlendr/wGets or sets a ColorBlend that defines a multicolor linear gradient.
is_transform_changedboolrGets 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+.
opacityfloatr/wGets 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_pointsPointF[]rGets the path points this brush was build upon.
transformMatrixr/wGets or sets a copy Matrix that defines a local geometric transform for this TransformBrush.
wrap_modeWrapModer/wGets or sets a WrapMode enumeration that indicates the wrap mode for this TransformBrush.

Methods

NameDescription
create_with_path(path)Initializes a new instance of the PathMulticolorGradientBrush class with the specified path.
create_with_points(path_points)Initializes a new instance of the PathMulticolorGradientBrush class with the specified points.
create_with_points_f(path_points)Initializes a new instance of the PathMulticolorGradientBrush class with the specified points.
create_with_points_f_wrap_mode(path_points, wrap_mode)Initializes a new instance of the PathMulticolorGradientBrush class with the specified points and wrap mode.
create_with_points_wrap_mode(path_points, wrap_mode)Initializes a new instance of the PathMulticolorGradientBrush 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.
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: PathMulticolorGradientBrush(path)

 PathMulticolorGradientBrush(path) 

Initializes a new instance of the PathMulticolorGradientBrush class with the specified points.

Parameters:

ParameterTypeDescription
pathGraphicsPath

Constructor: PathMulticolorGradientBrush(path_points)

 PathMulticolorGradientBrush(path_points) 

Initializes a new instance of the PathMulticolorGradientBrush class with the specified points.

Parameters:

ParameterTypeDescription
path_pointsPointF[]An array of PointF structures that represents the points that make up the vertices of the path.

Constructor: PathMulticolorGradientBrush(path_points)

 PathMulticolorGradientBrush(path_points) 

Initializes a new instance of the PathMulticolorGradientBrush class with the specified points.

Parameters:

ParameterTypeDescription
path_pointsPoint[]An array of PointF structures that represents the points that make up the vertices of the path.

Constructor: PathMulticolorGradientBrush(path_points, wrap_mode)

 PathMulticolorGradientBrush(path_points, wrap_mode) 

Initializes a new instance of the PathMulticolorGradientBrush class with the specified points and wrap mode.

Parameters:

ParameterTypeDescription
path_pointsPointF[]An array of PointF structures that represents the points that make up the vertices of the path.
wrap_modeWrapModeA WrapMode that specifies how fills drawn with this PathMulticolorGradientBrush are tiled.

Constructor: PathMulticolorGradientBrush(path_points, wrap_mode)

 PathMulticolorGradientBrush(path_points, wrap_mode) 

Initializes a new instance of the PathMulticolorGradientBrush class with the specified points and wrap mode.

Parameters:

ParameterTypeDescription
path_pointsPoint[]An array of PointF structures that represents the points that make up the vertices of the path.
wrap_modeWrapModeA WrapMode that specifies how fills drawn with this PathMulticolorGradientBrush are tiled.

Method: create_with_path(path) [static]

 create_with_path(path) 

Initializes a new instance of the PathMulticolorGradientBrush class with the specified path.

Parameters:

ParameterTypeDescription
pathGraphicsPathThe GraphicsPath that defines the area filled by this PathMulticolorGradientBrush.

Returns

TypeDescription
PathMulticolorGradientBrush

Method: create_with_points(path_points) [static]

 create_with_points(path_points) 

Initializes a new instance of the PathMulticolorGradientBrush class with the specified points.

Parameters:

ParameterTypeDescription
path_pointsPointF[]An array of PointF structures that represents the points that make up the vertices of the path.

Returns

TypeDescription
PathMulticolorGradientBrush

Method: create_with_points_f(path_points) [static]

 create_with_points_f(path_points) 

Initializes a new instance of the PathMulticolorGradientBrush class with the specified points.

Parameters:

ParameterTypeDescription
path_pointsPoint[]An array of Point structures that represents the points that make up the vertices of the path.

Returns

TypeDescription
PathMulticolorGradientBrush

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 PathMulticolorGradientBrush class with the specified points and wrap mode.

Parameters:

ParameterTypeDescription
path_pointsPointF[]An array of PointF structures that represents the points that make up the vertices of the path.
wrap_modeWrapModeA WrapMode that specifies how fills drawn with this PathMulticolorGradientBrush are tiled.

Returns

TypeDescription
PathMulticolorGradientBrush

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 PathMulticolorGradientBrush class with the specified points and wrap mode.

Parameters:

ParameterTypeDescription
path_pointsPoint[]An array of Point structures that represents the points that make up the vertices of the path.
wrap_modeWrapModeA WrapMode that specifies how fills drawn with this PathMulticolorGradientBrush are tiled.

Returns

TypeDescription
PathMulticolorGradientBrush

Method: deep_clone()

 deep_clone() 

Creates a new deep clone of the current Brush.

Returns

TypeDescription
BrushA 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:

ParameterTypeDescription
matrixMatrixThe 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:

ParameterTypeDescription
matrixMatrixThe Matrix by which to multiply the geometric transform.
orderMatrixOrderA 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:

ParameterTypeDescription
anglefloatThe 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:

ParameterTypeDescription
anglefloatThe angle of rotation.
orderMatrixOrderA 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:

ParameterTypeDescription
sxfloatThe amount by which to scale the transform in the x-axis direction.
syfloatThe 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:

ParameterTypeDescription
sxfloatThe amount by which to scale the transform in the x-axis direction.
syfloatThe amount by which to scale the transform in the y-axis direction.
orderMatrixOrderA MatrixOrder that specifies whether to append or prepend the scaling matrix.

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:

ParameterTypeDescription
dxfloatThe value of the translation in x.
dyfloatThe 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:

ParameterTypeDescription
dxfloatThe value of the translation in x.
dyfloatThe value of the translation in y.
orderMatrixOrderThe order (prepend or append) in which to apply the translation.