Asposecpplib
System::Drawing::Drawing2D::PathGradientBrush Class Reference

Represents a brush that fills the interior of a GraphicsPath object with a gradient. 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

ASPOSECPP_SHARED_API PathGradientBrush (const ArrayPtr< PointF > &points, WrapMode wrapMode=WrapMode::Clamp)
 Constructs a new instance of PathGradientBrush class. More...
 
ASPOSECPP_SHARED_API PathGradientBrush (const ArrayPtr< Point > &points, WrapMode wrapMode=WrapMode::Clamp)
 Constructs a new instance of PathGradientBrush class. More...
 
ASPOSECPP_SHARED_API PathGradientBrush (const SharedPtr< GraphicsPath > &path)
 Constructs a new instance of PathGradientBrush class. More...
 
ASPOSECPP_SHARED_API WrapMode get_WrapMode () const
 Returns the wrap mode. More...
 
ASPOSECPP_SHARED_API void set_WrapMode (WrapMode value)
 Sets the wrap mode. More...
 
ASPOSECPP_SHARED_API SharedPtr< ColorBlendget_InterpolationColors () const
 Returns a value the defines a multicolor linear gradient. More...
 
ASPOSECPP_SHARED_API void set_InterpolationColors (const SharedPtr< ColorBlend > &value)
 Sets a value the defines a multicolor linear gradient. More...
 
ASPOSECPP_SHARED_API PointF get_CenterPoint () const
 Gets the center point of the gradient. More...
 
ASPOSECPP_SHARED_API void set_CenterPoint (const PointF &value)
 Sets the center point of the gradient. More...
 
ASPOSECPP_SHARED_API Color get_CenterColor () const
 Returns a color that is at the center of the path filled by the current object. More...
 
ASPOSECPP_SHARED_API ArrayPtr< Colorget_SurroundColors () const
 Returns colors that correspond to the points in the path this PathGradientBrush fills. More...
 
ASPOSECPP_SHARED_API void ResetTransform ()
 Resets the current object's transform matrix so that it becomes an identity matrix. More...
 
ASPOSECPP_SHARED_API void ScaleTransform (float sx, float sy, Drawing2D::MatrixOrder order=Drawing2D::MatrixOrder::Prepend)
 Scales the local geometric transformation by the specified factors in the specified order. More...
 
ASPOSECPP_SHARED_API void RotateTransform (float angle, Drawing2D::MatrixOrder order=Drawing2D::MatrixOrder::Prepend)
 Rotates the local geometric transformation by the specified angle in the specified order. More...
 
ASPOSECPP_SHARED_API void TranslateTransform (float dx, float dy, Drawing2D::MatrixOrder order=Drawing2D::MatrixOrder::Prepend)
 Translates the local geometric transformation by the specified dimensions in the specified order. More...
 
ASPOSECPP_SHARED_API void MultiplyTransform (const SharedPtr< Matrix > &matrix, MatrixOrder order=MatrixOrder::Prepend)
 Multiplies current object's transform matrix by the specified matrix. More...
 
ASPOSECPP_SHARED_API SharedPtr< Matrixget_Transform () const
 Returns a copy of a Matrix object that specifies the geometrical transformations for the brush represneted by the current object. More...
 
ASPOSECPP_SHARED_API void set_Transform (const SharedPtr< Matrix > &value)
 Sets a Matrix object that specifies the geometrical transformations for the brush represneted by the current object. More...
 
ASPOSECPP_SHARED_API void set_SurroundColors (const ArrayPtr< Color > &value)
 Sets colors that correspond to the points in the path this PathGradientBrush fills. More...
 
ASPOSECPP_SHARED_API void set_CenterColor (Color value)
 Sets a color that is at the center of the path filled by the current object. More...
 
ASPOSECPP_SHARED_API void set_FocusScales (const PointF &value)
 Sets the focus point for the gradient falloff. More...
 
ASPOSECPP_SHARED_API void SetSigmaBellShape (float focus, float scale=1.0f)
 NOT IMPLEMENTED. More...
 
ASPOSECPP_SHARED_API SharedPtr< Blendget_Blend () const
 NOT IMPLEMENTED. More...
 
ASPOSECPP_SHARED_API void set_Blend (const SharedPtr< Blend > &value)
 Sets a blend that specifies factors and positions of base colors for this brush. More...
 
ASPOSECPP_SHARED_API PointF get_FocusScales () const
 Gets the focus point for the gradient falloff. More...
 
ASPOSECPP_SHARED_API RectangleF get_Rectangle ()
 NOT IMPLEMENTED. More...
 
ASPOSECPP_SHARED_API void SetBlendTriangularShape (float focus, float scale=1.0f)
 NOT IMPLEMENTED. More...
 
virtual ASPOSECPP_SHARED_API 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
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API 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 refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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...
 
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...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

Represents a brush that fills the interior of a GraphicsPath object with a gradient. 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

◆ PathGradientBrush() [1/3]

ASPOSECPP_SHARED_API System::Drawing::Drawing2D::PathGradientBrush::PathGradientBrush ( const ArrayPtr< PointF > &  points,
WrapMode  wrapMode = WrapMode::Clamp 
)

Constructs a new instance of PathGradientBrush class.

Parameters
pointsAn array that contains vertices of the path
wrapModeSpecifies how the fills drawn by a brush represented by the object being created should be tiled

◆ PathGradientBrush() [2/3]

ASPOSECPP_SHARED_API System::Drawing::Drawing2D::PathGradientBrush::PathGradientBrush ( const ArrayPtr< Point > &  points,
WrapMode  wrapMode = WrapMode::Clamp 
)

Constructs a new instance of PathGradientBrush class.

Parameters
pointsAn array that contains vertices of the path
wrapModeSpecifies how the fills drawn by a brush represented by the object being created should be tiled

◆ PathGradientBrush() [3/3]

ASPOSECPP_SHARED_API System::Drawing::Drawing2D::PathGradientBrush::PathGradientBrush ( const SharedPtr< GraphicsPath > &  path)

Constructs a new instance of PathGradientBrush class.

Parameters
pathA GraphicsPath object that specifies a path filled by the object being created

Member Function Documentation

◆ Clone()

virtual ASPOSECPP_SHARED_API SharedPtr<Brush> System::Drawing::Drawing2D::PathGradientBrush::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()

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

NOT IMPLEMENTED.

Exceptions
NotImplementedExceptionAlways

◆ get_CenterColor()

ASPOSECPP_SHARED_API Color System::Drawing::Drawing2D::PathGradientBrush::get_CenterColor ( ) const

Returns a color that is at the center of the path filled by the current object.

◆ get_CenterPoint()

ASPOSECPP_SHARED_API PointF System::Drawing::Drawing2D::PathGradientBrush::get_CenterPoint ( ) const

Gets the center point of the gradient.

◆ get_FocusScales()

ASPOSECPP_SHARED_API PointF System::Drawing::Drawing2D::PathGradientBrush::get_FocusScales ( ) const

Gets the focus point for the gradient falloff.

◆ get_InterpolationColors()

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

Returns a value the defines a multicolor linear gradient.

◆ get_Rectangle()

ASPOSECPP_SHARED_API RectangleF System::Drawing::Drawing2D::PathGradientBrush::get_Rectangle ( )

NOT IMPLEMENTED.

Exceptions
NotImplementedExceptionAlways

◆ get_SurroundColors()

ASPOSECPP_SHARED_API ArrayPtr<Color> System::Drawing::Drawing2D::PathGradientBrush::get_SurroundColors ( ) const

Returns colors that correspond to the points in the path this PathGradientBrush fills.

◆ get_Transform()

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

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

◆ get_WrapMode()

ASPOSECPP_SHARED_API WrapMode System::Drawing::Drawing2D::PathGradientBrush::get_WrapMode ( ) const

Returns the wrap mode.

◆ MultiplyTransform()

ASPOSECPP_SHARED_API void System::Drawing::Drawing2D::PathGradientBrush::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()

ASPOSECPP_SHARED_API void System::Drawing::Drawing2D::PathGradientBrush::ResetTransform ( )

Resets the current object's transform matrix so that it becomes an identity matrix.

◆ RotateTransform()

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

Rotates the local geometric transformation by the specified angle in the specified order.

Parameters
angleThe rotation angle
orderSpecifies the order of the operation

◆ ScaleTransform()

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

Scales the local geometric transformation by the specified factors in the specified order.

Parameters
sxScale factor by which to perform scaling in in X-axis direction
syScale factor by which to perform scaling in in Y-axis direction
orderSpecifies the order of the operation

◆ set_Blend()

ASPOSECPP_SHARED_API void System::Drawing::Drawing2D::PathGradientBrush::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_CenterColor()

ASPOSECPP_SHARED_API void System::Drawing::Drawing2D::PathGradientBrush::set_CenterColor ( Color  value)

Sets a color that is at the center of the path filled by the current object.

Parameters
valueThe value to set

◆ set_CenterPoint()

ASPOSECPP_SHARED_API void System::Drawing::Drawing2D::PathGradientBrush::set_CenterPoint ( const PointF value)

Sets the center point of the gradient.

Parameters
valueThe value to set

◆ set_FocusScales()

ASPOSECPP_SHARED_API void System::Drawing::Drawing2D::PathGradientBrush::set_FocusScales ( const PointF value)

Sets the focus point for the gradient falloff.

Parameters
valueThe value to set

◆ set_InterpolationColors()

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

Sets a value the defines a multicolor linear gradient.

Parameters
valueThe value to set

◆ set_SurroundColors()

ASPOSECPP_SHARED_API void System::Drawing::Drawing2D::PathGradientBrush::set_SurroundColors ( const ArrayPtr< Color > &  value)

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

Parameters
valueAn array of colors to set

◆ set_Transform()

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

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

Parameters
valueThe value to set

◆ set_WrapMode()

ASPOSECPP_SHARED_API void System::Drawing::Drawing2D::PathGradientBrush::set_WrapMode ( WrapMode  value)

Sets the wrap mode.

Parameters
valueThe value to set

◆ SetBlendTriangularShape()

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

NOT IMPLEMENTED.

Exceptions
NotImplementedExceptionAlways

◆ SetSigmaBellShape()

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

NOT IMPLEMENTED.

Exceptions
NotImplementedExceptionAlways

◆ TranslateTransform()

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

Translates the local geometric transformation by the specified dimensions in the specified order.

Parameters
dxThe value of translation in x
dyThe value of translation in y
orderSpecifies the order of the operation