System::Drawing::TextureBrush Class Reference

Represents a brush that uses an image to fill the interior of a shape. 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...

#include "texture_brush.h"

Inherits System::Drawing::Brush.

Public Member Functions

 TextureBrush (const SharedPtr< Image > &image, Drawing2D::WrapMode wrap_mode=Drawing2D::WrapMode::Tile)
 Constructs a new instance of TextureBrush class that uses the specified image.
 
 TextureBrush (const SharedPtr< Image > &image, RectangleF dst_rect, const SharedPtr< Imaging::ImageAttributes > &image_attrs=nullptr)
 Constructs a new instance of TextureBrush class that uses the specified image.
 
 TextureBrush (const SharedPtr< Image > &image, Rectangle dst_rect, const SharedPtr< Imaging::ImageAttributes > &image_attrs=nullptr)
 Constructs a new instance of TextureBrush class that uses the specified image.
 
 TextureBrush (const SharedPtr< Image > &image, Drawing2D::WrapMode wrap_mode, RectangleF dst_rect)
 Constructs a new instance of TextureBrush class that uses the specified image.
 
 TextureBrush (const SharedPtr< Image > &image, Drawing2D::WrapMode wrap_mode, Rectangle dst_rect)
 Constructs a new instance of TextureBrush class that uses the specified image.
 
virtual ~TextureBrush ()
 Destructor.
 
SharedPtr< Imageget_Image ()
 Returns an image used by the current TextureBrush object.
 
Drawing2D::WrapMode get_WrapMode ()
 Returns a value that specifies how the brush represented by the current object is tiled.
 
void set_WrapMode (Drawing2D::WrapMode wrap_mode)
 Sets a value that specifies how the brush represented by the current object is tiled.
 
System::SharedPtr< Drawing2D::Matrixget_Transform ()
 Returns a copy of a Matrix object that specifies the geometrical transformations for the brush represneted by the current object.
 
void set_Transform (const System::SharedPtr< Drawing2D::Matrix > &matrix)
 Sets a Matrix object that specifies the geometrical transformations for the brush represneted by the current object.
 
void ResetTransform ()
 Resets the current object's transform matrix so that it becomes an identity matrix.
 
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.
 
void RotateTransform (float angle, Drawing2D::MatrixOrder order=Drawing2D::MatrixOrder::Prepend)
 Rotates the local geometric transformation by the specified angle in the specified order.
 
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.
 
void MultiplyTransform (const SharedPtr< Drawing2D::Matrix > &matrix, Drawing2D::MatrixOrder order=Drawing2D::MatrixOrder::Prepend)
 Multiplies current object's transform matrix by the specified matrix.
 
virtual SharedPtr< BrushClone () override
 Creates a copy of the current object.
 
- Public Member Functions inherited from System::Drawing::Brush
void Dispose ()
 Releases operating system resources acquired by the current object.
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures.
 
virtual ~Object ()
 Destroys object. Frees all internal data structures.
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses.
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses.
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value.
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector.
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object.
 
int SharedCount () const
 Gets current value of shared reference counter.
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object.
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics.
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects.
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string.
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types.
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call.
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator.
 
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.
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only.
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr.
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings.
 

Protected Member Functions

virtual 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.
 
void InitBrushSettings (const SharedPtr< Image > &image, Drawing2D::WrapMode wrap_mode, Rectangle dst_rect)
 Initializes a newly created TextureBrush object.
 
- Protected Member Functions inherited from System::Drawing::Brush

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type.
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference.
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference.
 
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.
 
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.
 
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.
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct.
 
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.
 
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.
 

Detailed Description

Represents a brush that uses an image to fill the interior of a shape. 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

◆ TextureBrush() [1/5]

System::Drawing::TextureBrush::TextureBrush ( const SharedPtr< Image > & image,
Drawing2D::WrapMode wrap_mode = Drawing2D::WrapMode::Tile )

Constructs a new instance of TextureBrush class that uses the specified image.

Parameters
imageAn image used by the brush to fill the interior of a shape
wrap_modeSpecifies how the brush object is tiled

◆ TextureBrush() [2/5]

System::Drawing::TextureBrush::TextureBrush ( const SharedPtr< Image > & image,
RectangleF dst_rect,
const SharedPtr< Imaging::ImageAttributes > & image_attrs = nullptr )

Constructs a new instance of TextureBrush class that uses the specified image.

Parameters
imageAn image used by the brush to fill the interior of a shape
dst_rectSpecifies the bounding rectangle for the brush
image_attrsThe image attributes

◆ TextureBrush() [3/5]

System::Drawing::TextureBrush::TextureBrush ( const SharedPtr< Image > & image,
Rectangle dst_rect,
const SharedPtr< Imaging::ImageAttributes > & image_attrs = nullptr )

Constructs a new instance of TextureBrush class that uses the specified image.

Parameters
imageAn image used by the brush to fill the interior of a shape
dst_rectSpecifies the bounding rectangle for the brush
image_attrsThe image attributes

◆ TextureBrush() [4/5]

System::Drawing::TextureBrush::TextureBrush ( const SharedPtr< Image > & image,
Drawing2D::WrapMode wrap_mode,
RectangleF dst_rect )

Constructs a new instance of TextureBrush class that uses the specified image.

Parameters
imageAn image used by the brush to fill the interior of a shape
wrap_modeSpecifies how the brush object is tiled
dst_rectSpecifies the bounding rectangle for the brush

◆ TextureBrush() [5/5]

System::Drawing::TextureBrush::TextureBrush ( const SharedPtr< Image > & image,
Drawing2D::WrapMode wrap_mode,
Rectangle dst_rect )

Constructs a new instance of TextureBrush class that uses the specified image.

Parameters
imageAn image used by the brush to fill the interior of a shape
wrap_modeSpecifies how the brush object is tiled
dst_rectSpecifies the bounding rectangle for the brush

◆ ~TextureBrush()

virtual System::Drawing::TextureBrush::~TextureBrush ( )
virtual

Destructor.

Member Function Documentation

◆ Apply()

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

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

Implements System::Drawing::Brush.

◆ Clone()

virtual SharedPtr< Brush > System::Drawing::TextureBrush::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_Image()

SharedPtr< Image > System::Drawing::TextureBrush::get_Image ( )

Returns an image used by the current TextureBrush object.

◆ get_Transform()

System::SharedPtr< Drawing2D::Matrix > System::Drawing::TextureBrush::get_Transform ( )

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

◆ get_WrapMode()

Drawing2D::WrapMode System::Drawing::TextureBrush::get_WrapMode ( )

Returns a value that specifies how the brush represented by the current object is tiled.

◆ InitBrushSettings()

void System::Drawing::TextureBrush::InitBrushSettings ( const SharedPtr< Image > & image,
Drawing2D::WrapMode wrap_mode,
Rectangle dst_rect )
protected

Initializes a newly created TextureBrush object.

Parameters
imageAn image used by the brush to fill the interior of a shape
wrap_modeSpecifies how the brush object is tiled
dst_rectSpecifies the bounding rectangle for the brush

◆ MultiplyTransform()

void System::Drawing::TextureBrush::MultiplyTransform ( const SharedPtr< Drawing2D::Matrix > & matrix,
Drawing2D::MatrixOrder order = Drawing2D::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::TextureBrush::ResetTransform ( )

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

◆ RotateTransform()

void System::Drawing::TextureBrush::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()

void System::Drawing::TextureBrush::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_Transform()

void System::Drawing::TextureBrush::set_Transform ( const System::SharedPtr< Drawing2D::Matrix > & matrix)

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

Parameters
matrixThe value to set

◆ set_WrapMode()

void System::Drawing::TextureBrush::set_WrapMode ( Drawing2D::WrapMode wrap_mode)

Sets a value that specifies how the brush represented by the current object is tiled.

Parameters
wrap_modeThe value to set

◆ TranslateTransform()

void System::Drawing::TextureBrush::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