xtd::drawing::drawing_2d::hatch_brush Class Reference

Inheritance diagram for xtd::drawing::drawing_2d::hatch_brush:

Definition

Defines a rectangular xtd::drawing::brush with a hatch style, a foreground color, and a background color. This class cannot be inherited.

Namespace

xtd::drawing::drawing_2d

Library

xtd.drawing

Remarks

The following illustration shows a rectangle filled with the xtd::drawing::drawing_2d::hatch_style::diagonal_brick hatch pattern.

Examples

The following code example demonstrates the use of hatch_brush class.

#include <xtd/xtd>
 
namespace fill_rectangle_example {
  class form1 : public form {
  public:
    form1() {
      text("Fill rectangle example");
      client_size({680, 340});
    }
    
  protected:
    void on_paint(paint_event_args& e) override {
      form::on_paint(e);
      
      auto back_color = color::navy;
      auto fore_color = color::white;
      
      e.graphics().fill_rectangle(solid_brush {color::transparent}, rectangle {10, 10, 150, 150});
      e.graphics().draw_rectangle(pen {fore_color, 4}, rectangle {10, 10, 150, 150});
      
      e.graphics().fill_rectangle(solid_brush {back_color}, rectangle {180, 10, 150, 150});
      e.graphics().draw_rectangle(pen {fore_color, 4}, rectangle {180, 10, 150, 150});
      
      e.graphics().fill_rectangle(texture_brush {create_circle_texture(fore_color, back_color)}, rectangle {350, 10, 150, 150});
      e.graphics().draw_rectangle(pen {fore_color, 4}, rectangle {350, 10, 150, 150});
      
      e.graphics().fill_rectangle(drawing_2d::hatch_brush {drawing_2d::hatch_style::diagonal_brick, color::white, back_color}, rectangle {520, 10, 150, 150});
      e.graphics().draw_rectangle(pen {color::white, 4}, rectangle {520, 10, 150, 150});
      
      e.graphics().fill_rectangle(drawing_2d::conical_gradient_brush {point {85, 255}, back_color, fore_color, 0}, rectangle {10, 180, 150, 150});
      e.graphics().draw_rectangle(pen {color::white, 4}, rectangle {10, 180, 150, 150});
      
      e.graphics().fill_rectangle(drawing_2d::linear_gradient_brush {rectangle {180, 180, 150, 150}, back_color, fore_color, 315}, rectangle {180, 180, 150, 150});
      e.graphics().draw_rectangle(pen {color::white, 4}, rectangle {180, 180, 150, 150});
      
      e.graphics().fill_rectangle(drawing_2d::radial_gradient_brush {point {425, 255}, fore_color, back_color, 73}, rectangle {350, 180, 150, 150});
      e.graphics().draw_rectangle(pen {color::white, 4}, rectangle {350, 180, 150, 150});
    }
    
  private:
    auto create_circle_texture(const color& fore_color, const color& back_color)->image {
      auto texture = bitmap {16, 16};
      auto graphics = texture.create_graphics();
      graphics.fill_ellipse(solid_brush {back_color}, 1, 1, texture.width() - 2, texture.height() - 2);
      graphics.draw_ellipse(pen {fore_color, 2}, 1, 1, texture.width() - 2, texture.height() - 2);
      return texture;
    }
  };
}
 
auto main() -> int {
  application::run(fill_rectangle_example::form1 {});
}

Public Constructors
	hatch_brush (xtd::drawing::drawing_2d::hatch_style hatch_style, const xtd::drawing::color &fore_color)
	Initializes a new instance of the xtd::drawing::drawing_2d::hatch_brush class with the specified xtd::drawing::drawing_2d::hatch_style enumeration and foreground color.
	hatch_brush (xtd::drawing::drawing_2d::hatch_style hatch_style, const xtd::drawing::color &fore_color, const xtd::drawing::color &back_color)
	Initializes a new instance of the xtd::drawing::drawing_2d::hatch_brush class with the specified xtd::drawing::drawing_2d::hatch_style enumeration, foreground color and background color.

Public Properties
xtd::drawing::color	background_color () const noexcept
	Gets the color of spaces between the hatch lines drawn by this hatch_brush object.
xtd::drawing::color	foreground_color () const noexcept
	Gets the color of hatch lines drawn by this hatch_brush object.
xtd::drawing::drawing_2d::hatch_style	hatch_style () const noexcept
	Gets the hatch style of this hatch_brush object.

Additional Inherited Members
intptr	handle () const noexcept
	Gets the handle of the brush.
bool	equals (const xtd::object &obj) const noexcept override
	Determines whether the specified object is equal to the current object.
bool	equals (const brush &other) const noexcept override
	Determines whether the specified object is equal to the current object.
xtd::size	get_hash_code () const noexcept override
	Serves as a hash function for a particular type.
xtd::string	to_string () const noexcept override
	Converts this brush object to a human-readable string.
	object ()=default
	Create a new instance of the ultimate base class object.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<class object_t>
xtd::unique_ptr_object< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual bool	equals (const brush &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.
template<class object_a_t, class object_b_t>
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<class object_a_t, class object_b_t>
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.
	brush ()
	Initialize a new instance of brush class.
void	set_native_brush (intptr brush)
	In a derived class, sets a reference to a GDI+ brush object.

Constructor & Destructor Documentation

hatch_brush() [1/2]

xtd::drawing::drawing_2d::hatch_brush::hatch_brush	(	xtd::drawing::drawing_2d::hatch_style	hatch_style,
		const xtd::drawing::color &	fore_color )

Initializes a new instance of the xtd::drawing::drawing_2d::hatch_brush class with the specified xtd::drawing::drawing_2d::hatch_style enumeration and foreground color.

Parameters

hatch_style	One of the xtd::drawing::drawing_2d::hatch_style values that represents the pattern drawn by this xtd::drawing::drawing_2d::hatch_brush.
fore_color	The xtd::drawing::color structure that represents the color of lines drawn by this xtd::drawing::drawing_2d::hatch_brush.

Remarks

The background color is initialized to black.

hatch_brush() [2/2]

xtd::drawing::drawing_2d::hatch_brush::hatch_brush	(	xtd::drawing::drawing_2d::hatch_style	hatch_style,
		const xtd::drawing::color &	fore_color,
		const xtd::drawing::color &	back_color )

Initializes a new instance of the xtd::drawing::drawing_2d::hatch_brush class with the specified xtd::drawing::drawing_2d::hatch_style enumeration, foreground color and background color.

Parameters

hatch_style	One of the xtd::drawing::drawing_2d::hatch_style values that represents the pattern drawn by this xtd::drawing::drawing_2d::hatch_brush.
fore_color	The xtd::drawing::color structure that represents the color of lines drawn by this xtd::drawing::drawing_2d::hatch_brush.
back_color	The xtd::drawing::color structure that represents the color of spaces between the lines drawn by this xtd::drawing::drawing_2d::hatch_brush.

Member Function Documentation

background_color()

xtd::drawing::color xtd::drawing::drawing_2d::hatch_brush::background_color ( ) const

noexcept

Gets the color of spaces between the hatch lines drawn by this hatch_brush object.

Returns

A xtd::drawing::color structure that represents the background color for this hatch_brush.

foreground_color()

xtd::drawing::color xtd::drawing::drawing_2d::hatch_brush::foreground_color ( ) const

noexcept

Gets the color of hatch lines drawn by this hatch_brush object.

Returns

A xtd::drawing::color structure that represents the foreground color for this hatch_brush.

hatch_style()

xtd::drawing::drawing_2d::hatch_style xtd::drawing::drawing_2d::hatch_brush::hatch_style ( ) const

noexcept

Gets the hatch style of this hatch_brush object.

Returns

One of the xtd::drawing::drawing_2d::hatch_style values that represents the pattern of this hatch_brush.

---

The documentation for this class was generated from the following file:

• xtd.drawing/include/xtd/drawing/drawing_2d/hatch_brush.hpp