com.aspose.imaging.brushes
Class PathGradientBrush

java.lang.Object
  extended by com.aspose.imaging.DisposableObject
      extended by com.aspose.imaging.Brush
          extended by com.aspose.imaging.brushes.TransformBrush
              extended by com.aspose.imaging.brushes.PathGradientBrushBase
                  extended by com.aspose.imaging.brushes.PathGradientBrush

public final class PathGradientBrush
extends PathGradientBrushBase

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


The center color is white by default. A user can changed this value at any time later.

The surround colors array is initialized by single element containing white color by default. The surround colors may be changed later, however at least single element is required when setting up the surround colors.

See the Blend for more details about its initialization.


Constructor Summary
PathGradientBrush(GraphicsPath path)
           Initializes a new instance of the PathGradientBrush class with the specified path.
PathGradientBrush(Point[] points)
           Initializes a new instance of the PathGradientBrush class with the specified points.
PathGradientBrush(Point[] points, int wrapMode)
           Initializes a new instance of the PathGradientBrush class with the specified points and wrap mode.
PathGradientBrush(PointF[] points)
           Initializes a new instance of the PathGradientBrush class with the specified points.
PathGradientBrush(PointF[] points, int wrapMode)
           Initializes a new instance of the PathGradientBrush class with the specified points and wrap mode.
 
Method Summary
 Blend getBlend()
           Gets a Blend that specifies positions and factors that define a custom falloff for the gradient.
 Color getCenterColor()
           Gets the color at the center of the path gradient.
 ColorBlend getInterpolationColors()
          Deprecated. 
 Color[] getSurroundColors()
           Gets an array of colors that correspond to the points in the path this PathGradientBrush fills.
 void setBlend(Blend value)
           Sets a Blend that specifies positions and factors that define a custom falloff for the gradient.
 void setBlendTriangularShape(float focus)
           Creates a gradient with a center color and a linear falloff to one surrounding color.
 void setBlendTriangularShape(float focus, float scale)
           Creates a gradient with a center color and a linear falloff to each surrounding color.
 void setCenterColor(Color value)
           Sets the color at the center of the path gradient.
 void setInterpolationColors(ColorBlend value)
          Deprecated. 
 void setSigmaBellShape(float focus)
           Creates a gradient brush that changes color starting from the center of the path outward to the path's boundary.
 void setSigmaBellShape(float focus, float scale)
           Creates a gradient brush that changes color starting from the center of the path outward to the path's boundary.
 void setSurroundColors(Color[] value)
           Sets an array of colors that correspond to the points in the path this PathGradientBrush fills.
 
Methods inherited from class com.aspose.imaging.brushes.PathGradientBrushBase
getCenterPoint, getFocusScales, getGraphicsPath, getPathPoints, setCenterPoint, setFocusScales
 
Methods inherited from class com.aspose.imaging.brushes.TransformBrush
getTransform, getWrapMode, isTransformChanged, multiplyTransform, multiplyTransform, resetTransform, rotateTransform, rotateTransform, scaleTransform, scaleTransform, setTransform, setWrapMode, translateTransform, translateTransform
 
Methods inherited from class com.aspose.imaging.Brush
deepClone, getOpacity, setOpacity
 
Methods inherited from class com.aspose.imaging.DisposableObject
dispose, getDisposed, releaseManagedResources, releaseUnmanagedResources, verifyNotDisposed
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PathGradientBrush

public PathGradientBrush(GraphicsPath path)

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

Parameters:
path - The GraphicsPath that defines the area filled by this PathGradientBrush.

PathGradientBrush

public PathGradientBrush(Point[] points)

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

Parameters:
points - An array of Point structures that represents the points that make up the vertices of the path.

PathGradientBrush

public PathGradientBrush(Point[] points,
                         int wrapMode)

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

Parameters:
points - An array of Point structures that represents the points that make up the vertices of the path.
wrapMode - A WrapMode that specifies how fills drawn with this PathGradientBrush are tiled.

PathGradientBrush

public PathGradientBrush(PointF[] points)

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

Parameters:
points - An array of PointF structures that represents the points that make up the vertices of the path.

PathGradientBrush

public PathGradientBrush(PointF[] points,
                         int wrapMode)

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

Parameters:
points - An array of PointF structures that represents the points that make up the vertices of the path.
wrapMode - A WrapMode that specifies how fills drawn with this PathGradientBrush are tiled.
Method Detail

getBlend

public Blend getBlend()

Gets a Blend that specifies positions and factors that define a custom falloff for the gradient.

Value: A Blend that represents a custom falloff for the gradient.


getCenterColor

public Color getCenterColor()

Gets the color at the center of the path gradient.

Value: A Color that represents the color at the center of the path gradient.


getInterpolationColors

@Deprecated
public ColorBlend getInterpolationColors()
Deprecated. 

Gets or sets a ColorBlend that defines a multicolor linear gradient.

Value: A ColorBlend that defines a multicolor linear gradient.


getSurroundColors

public Color[] getSurroundColors()

Gets an array of colors that correspond to the points in the path this PathGradientBrush fills.

Value: An array of Color structures that represents the colors associated with each point in the path this PathGradientBrush fills.


setBlend

public void setBlend(Blend value)

Sets a Blend that specifies positions and factors that define a custom falloff for the gradient.

Value: A Blend that represents a custom falloff for the gradient.


setBlendTriangularShape

public void setBlendTriangularShape(float focus)

Creates a gradient with a center color and a linear falloff to one surrounding color.

Parameters:
focus - 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.

setBlendTriangularShape

public void setBlendTriangularShape(float focus,
                                    float scale)

Creates a gradient with a center color and a linear falloff to each surrounding color.

Parameters:
focus - 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 - 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.

setCenterColor

public void setCenterColor(Color value)

Sets the color at the center of the path gradient.

Value: A Color that represents the color at the center of the path gradient.


setInterpolationColors

@Deprecated
public void setInterpolationColors(ColorBlend value)
Deprecated. 


setSigmaBellShape

public void setSigmaBellShape(float 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:
focus - 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.

setSigmaBellShape

public void setSigmaBellShape(float focus,
                              float 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:
focus - 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 - 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.

setSurroundColors

public void setSurroundColors(Color[] value)

Sets an array of colors that correspond to the points in the path this PathGradientBrush fills.

Value: An array of Color structures that represents the colors associated with each point in the path this PathGradientBrush fills.