Asposecpplib
System::Drawing::Drawing2D::LinearGradientBrush Class Reference

Represents a linear gradient brush. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::Drawing::Brush.

Public Member Functions

 LinearGradientBrush (const PointF &point1, const PointF &point2, const Color &color1, const Color &color2)
 Constructs a new instance of LinearGradientBrush. More...
 
 LinearGradientBrush (const Point &point1, const Point &point2, const Color &color1, const Color &color2)
 Constructs a new instance of LinearGradientBrush. More...
 
 LinearGradientBrush (const RectangleF &rect, const Color &color1, const Color &color2, LinearGradientMode linearGradientMode)
 Constructs a new instance of LinearGradientBrush. More...
 
 LinearGradientBrush (const Rectangle &rect, const Color &color1, const Color &color2, LinearGradientMode linearGradientMode)
 Constructs a new instance of LinearGradientBrush. More...
 
 LinearGradientBrush (const RectangleF &rect, const Color &color1, const Color &color2, float angle, bool isAngleScaleable=false)
 Constructs a new instance of LinearGradientBrush. More...
 
 LinearGradientBrush (const Rectangle &rect, const Color &color1, const Color &color2, float angle, bool isAngleScaleable=false)
 Constructs a new instance of LinearGradientBrush. More...
 
void ResetTransform ()
 Resets current object's transformation matrix. More...
 
void MultiplyTransform (const SharedPtr< Matrix > &matrix, MatrixOrder order=MatrixOrder::Prepend)
 Multiplies current object's transform matrix by the specified matrix. More...
 
void RotateTransform (float angle, MatrixOrder order=MatrixOrder::Prepend)
 Rotates current object's transform matrix. More...
 
void ScaleTransform (float sx, float sy, MatrixOrder order=MatrixOrder::Prepend)
 Scales current object's transform matrix. More...
 
void TranslateTransform (float dx, float dy, Drawing2D::MatrixOrder order=Drawing2D::MatrixOrder::Prepend)
 Translates current object's transform matrix. More...
 
WrapMode get_WrapMode () const
 Returns the wrap mode. More...
 
void set_WrapMode (WrapMode value)
 Sets the wrap mode. More...
 
SharedPtr< Blendget_Blend () const
 Returns a blend that specifies factors and positions of base colors for this brush. More...
 
void set_Blend (const SharedPtr< Blend > &value)
 Sets a blend that specifies factors and positions of base colors for this brush. More...
 
SharedPtr< ColorBlendget_InterpolationColors () const
 Returns a ColorBlend object that defines a multicolor linear gradient. More...
 
void set_InterpolationColors (const SharedPtr< ColorBlend > &value)
 Sets a ColorBlend object that defines a multicolor linear gradient. More...
 
SharedPtr< Matrixget_Transform () const
 Returns a copy of a Matrix object that specifies the geometrical transformations for the brush represented by the current object. More...
 
void set_Transform (const SharedPtr< Matrix > &value)
 Sets a Matrix object that specifies the geometrical transformations for the brush represented by the current object. More...
 
void SetSigmaBellShape (float focus, float scale=1.0f)
 NOT IMPLEMENTED. More...
 
RectangleF get_Rectangle ()
 Returns a bounding rectangle. More...
 
bool get_GammaCorrection () const
 Returns a value indicating that gamma correction is enabled for this brush. More...
 
void set_GammaCorrection (bool value)
 Sets gamma correction status for this brush. More...
 
ArrayPtr< Colorget_LinearColors () const
 Returns starting and ending colors of this gradient. More...
 
void set_LinearColors (const ArrayPtr< Color > &value)
 Sets starting and ending colors of this gradient. More...
 
void SetBlendTriangularShape (float focus, float scale=1.0f)
 NOT IMPLEMENTED. More...
 
SharedPtr< BrushClone () override
 Creates a copy of the current object. More...
 
- Public Member Functions inherited from System::Drawing::Brush
void Dispose ()
 Releases operating system resources acquired by the current object. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

void Apply (SkPaint &paint, const SharedPtr< Drawing2D::Matrix > &matrix, bool apply_shift) override
 Sets the properties of the current brush on the specified SkPaint object. More...
 
- Protected Member Functions inherited from System::Drawing::Brush
virtual void Apply (SkPaint &paint, const SharedPtr< Drawing2D::Matrix > &matrix, bool apply_shift=false)=0
 Sets the properties of the current brush on the specified SkPaint object. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Detailed Description

Represents a linear gradient brush. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ LinearGradientBrush() [1/6]

System::Drawing::Drawing2D::LinearGradientBrush::LinearGradientBrush ( const PointF point1,
const PointF point2,
const Color color1,
const Color color2 
)

Constructs a new instance of LinearGradientBrush.

Parameters
point1The start point of the gradient
point2The end point of the gradient
color1The start color of the gradient
color2The end color of the gradient

◆ LinearGradientBrush() [2/6]

System::Drawing::Drawing2D::LinearGradientBrush::LinearGradientBrush ( const Point point1,
const Point point2,
const Color color1,
const Color color2 
)

Constructs a new instance of LinearGradientBrush.

Parameters
point1The start point of the gradient
point2The end point of the gradient
color1The start color of the gradient
color2The end color of the gradient

◆ LinearGradientBrush() [3/6]

System::Drawing::Drawing2D::LinearGradientBrush::LinearGradientBrush ( const RectangleF rect,
const Color color1,
const Color color2,
LinearGradientMode  linearGradientMode 
)

Constructs a new instance of LinearGradientBrush.

Parameters
rectA bounding rectangle of the gradient
color1The start color of the gradient
color2The end color of the gradient
linearGradientModeThe gradient direction

◆ LinearGradientBrush() [4/6]

System::Drawing::Drawing2D::LinearGradientBrush::LinearGradientBrush ( const Rectangle rect,
const Color color1,
const Color color2,
LinearGradientMode  linearGradientMode 
)

Constructs a new instance of LinearGradientBrush.

Parameters
rectA bounding rectangle of the gradient
color1The start color of the gradient
color2The end color of the gradient
linearGradientModeThe gradient direction

◆ LinearGradientBrush() [5/6]

System::Drawing::Drawing2D::LinearGradientBrush::LinearGradientBrush ( const RectangleF rect,
const Color color1,
const Color color2,
float  angle,
bool  isAngleScaleable = false 
)

Constructs a new instance of LinearGradientBrush.

Parameters
rectA bounding rectangle of the gradient
color1The start color of the gradient
color2The end color of the gradient
angleThe angle of the gradient orientation line; measured in degrees clockwise from the x-axis
isAngleScaleableSpecifies if the angle of the gradient is affected by the transformation associated with the brush

◆ LinearGradientBrush() [6/6]

System::Drawing::Drawing2D::LinearGradientBrush::LinearGradientBrush ( const Rectangle rect,
const Color color1,
const Color color2,
float  angle,
bool  isAngleScaleable = false 
)

Constructs a new instance of LinearGradientBrush.

Parameters
rectA bounding rectangle of the gradient
color1The start color of the gradient
color2The end color of the gradient
angleThe angle of the gradient orientation line; measured in degrees clockwise from the x-axis
isAngleScaleableSpecifies if the angle of the gradient is affected by the transformation associated with the brush

Member Function Documentation

◆ Apply()

void System::Drawing::Drawing2D::LinearGradientBrush::Apply ( SkPaint &  paint,
const SharedPtr< Drawing2D::Matrix > &  matrix,
bool  apply_shift 
)
overrideprotected

Sets the properties of the current brush on the specified SkPaint object.

Parameters
paintAn object set the properties on
matrixGraphics world transformation matrix
apply_shiftIs used to make a small brush's texture position shift

◆ Clone()

SharedPtr<Brush> System::Drawing::Drawing2D::LinearGradientBrush::Clone ( )
overridevirtual

Creates a copy of the current object.

Returns
A shared pointer to the copy of the current object.

Implements System::Drawing::Brush.

◆ get_Blend()

SharedPtr<Blend> System::Drawing::Drawing2D::LinearGradientBrush::get_Blend ( ) const

Returns a blend that specifies factors and positions of base colors for this brush.

◆ get_GammaCorrection()

bool System::Drawing::Drawing2D::LinearGradientBrush::get_GammaCorrection ( ) const

Returns a value indicating that gamma correction is enabled for this brush.

◆ get_InterpolationColors()

SharedPtr<ColorBlend> System::Drawing::Drawing2D::LinearGradientBrush::get_InterpolationColors ( ) const

Returns a ColorBlend object that defines a multicolor linear gradient.

◆ get_LinearColors()

ArrayPtr<Color> System::Drawing::Drawing2D::LinearGradientBrush::get_LinearColors ( ) const

Returns starting and ending colors of this gradient.

◆ get_Rectangle()

RectangleF System::Drawing::Drawing2D::LinearGradientBrush::get_Rectangle ( )

Returns a bounding rectangle.

◆ get_Transform()

SharedPtr<Matrix> System::Drawing::Drawing2D::LinearGradientBrush::get_Transform ( ) const

Returns a copy of a Matrix object that specifies the geometrical transformations for the brush represented by the current object.

◆ get_WrapMode()

WrapMode System::Drawing::Drawing2D::LinearGradientBrush::get_WrapMode ( ) const

Returns the wrap mode.

◆ MultiplyTransform()

void System::Drawing::Drawing2D::LinearGradientBrush::MultiplyTransform ( const SharedPtr< Matrix > &  matrix,
MatrixOrder  order = MatrixOrder::Prepend 
)

Multiplies current object's transform matrix by the specified matrix.

Parameters
matrixThe matrix by which the current object's transform matrix is multiplied
orderSpecifies the order of the operation

◆ ResetTransform()

void System::Drawing::Drawing2D::LinearGradientBrush::ResetTransform ( )

Resets current object's transformation matrix.

◆ RotateTransform()

void System::Drawing::Drawing2D::LinearGradientBrush::RotateTransform ( float  angle,
MatrixOrder  order = MatrixOrder::Prepend 
)

Rotates current object's transform matrix.

Parameters
angleThe angle to rotate the matrix by
orderSpecifies the order of the operation

◆ ScaleTransform()

void System::Drawing::Drawing2D::LinearGradientBrush::ScaleTransform ( float  sx,
float  sy,
MatrixOrder  order = MatrixOrder::Prepend 
)

Scales current object's transform matrix.

Parameters
sxThe value by which to scale the matrix in x-axis direction
syThe value by which to scale the matrix in y-axis direction
orderSpecifies the order of the operation

◆ set_Blend()

void System::Drawing::Drawing2D::LinearGradientBrush::set_Blend ( const SharedPtr< Blend > &  value)

Sets a blend that specifies factors and positions of base colors for this brush.

Parameters
valueNew blend value

◆ set_GammaCorrection()

void System::Drawing::Drawing2D::LinearGradientBrush::set_GammaCorrection ( bool  value)

Sets gamma correction status for this brush.

Parameters
valueNew gamma correction value

◆ set_InterpolationColors()

void System::Drawing::Drawing2D::LinearGradientBrush::set_InterpolationColors ( const SharedPtr< ColorBlend > &  value)

Sets a ColorBlend object that defines a multicolor linear gradient.

Parameters
valueA value to set

◆ set_LinearColors()

void System::Drawing::Drawing2D::LinearGradientBrush::set_LinearColors ( const ArrayPtr< Color > &  value)

Sets starting and ending colors of this gradient.

Parameters
valueArray of two colors

◆ set_Transform()

void System::Drawing::Drawing2D::LinearGradientBrush::set_Transform ( const SharedPtr< Matrix > &  value)

Sets a Matrix object that specifies the geometrical transformations for the brush represented by the current object.

Parameters
valueThe value to set

◆ set_WrapMode()

void System::Drawing::Drawing2D::LinearGradientBrush::set_WrapMode ( WrapMode  value)

Sets the wrap mode.

Parameters
valueThe value to set

◆ SetBlendTriangularShape()

void System::Drawing::Drawing2D::LinearGradientBrush::SetBlendTriangularShape ( float  focus,
float  scale = 1.0f 
)

NOT IMPLEMENTED.

Exceptions
NotImplementedExceptionAlways

◆ SetSigmaBellShape()

void System::Drawing::Drawing2D::LinearGradientBrush::SetSigmaBellShape ( float  focus,
float  scale = 1.0f 
)

NOT IMPLEMENTED.

Exceptions
NotImplementedExceptionAlways

◆ TranslateTransform()

void System::Drawing::Drawing2D::LinearGradientBrush::TranslateTransform ( float  dx,
float  dy,
Drawing2D::MatrixOrder  order = Drawing2D::MatrixOrder::Prepend 
)

Translates current object's transform matrix.

Parameters
dxThe X value by which the matrix is translated
dyThe Y value by which the matrix is translated
orderSpecifies the order of the operation