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/drawing/drawing_2d/conical_gradient_brush>
#include <xtd/drawing/drawing_2d/hatch_brush>
#include <xtd/drawing/drawing_2d/linear_gradient_brush>
#include <xtd/drawing/drawing_2d/radial_gradient_brush>
#include <xtd/drawing/solid_brush>
#include <xtd/drawing/texture_brush>
#include <xtd/forms/application>
#include <xtd/forms/form>
 
using namespace xtd;
using namespace xtd::drawing;
using namespace xtd::drawing::drawing_2d;
using namespace xtd::forms;
 
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(hatch_brush {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(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(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(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 {});
}

Examples

color_dialog.cpp, color_picker.cpp, fill_ellipse.cpp, fill_rectangle.cpp, fill_rounded_rectangle.cpp, and image_converter.cpp.

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.

Public Methods
bool	equals (const hatch_brush &value) const noexcept override
bool	equals (const brush &value) const noexcept override
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
template<typename object_a_t , typename 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.

Additional Inherited Members
Public Member Functions inherited from xtd::drawing::brush
intptr	handle () const noexcept
	Gets the handle of the brush.
bool	equals (const brush &value) const noexcept override
xtd::string	to_string () const noexcept override
	Converts this brush object to a human-readable string.
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
Public Member Functions inherited from xtd::iequatable< brush >
virtual bool	equals (const brush &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.
Public Member Functions inherited from xtd::iequatable< hatch_brush >
virtual bool	equals (const hatch_brush &) const noexcept=0
	Indicates whether the current object is equal to another object of the same type.
Static Public Member Functions inherited from xtd::drawing::brush
template<typename object_a_t , typename 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.
Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename 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<typename object_a_t , typename 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.
Protected Member Functions inherited from xtd::drawing::brush
	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.

equals() [1/2]

virtual bool xtd::object::equals ( const object &  obj ) const

virtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns

true if the specified object is equal to the current object. otherwise, false.

Examples

The following code example compares the current instance with another object.

#include <xtd/console>
 
using namespace xtd;
 
auto main() -> int {
  auto object1 = new_ptr<object>();
  auto object2 = new_ptr<object>();
  
  auto object3 = object2;
  console::write_line(object1->equals(*object3));
  console::write_line(*object1 == *object3);
  object3 = object1;
  console::write_line(object1->equals(*object3));
  console::write_line(*object1 == *object3);
}
 
// This code produces the following output :
//
// false
// false
// true
// true

Reimplemented from xtd::drawing::brush.

equals() [2/2]

template<typename object_a_t , typename object_b_t >

static bool xtd::object::equals ( const object_a_t &  object_a, const object_b_t &  object_b  )

inlinestaticnoexcept

Determines whether the specified object instances are considered equal.

Parameters

object_a	The first object to compare.
object_b	The second object to compare.

Returns

true if object_a is the same instance as object_b or if both are null references or if object_a(object_b) returns true. otherwise, false.

Examples

The following code example compares different objects.

#include <xtd/console>
 
using namespace xtd;
 
auto main() -> int {
  string s1 = "Tom";
  string s2 = "Carol";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "Tom";
  s2 = "Tom";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "";
  s2 = "Tom";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "Carol";
  s2 = "";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
  
  s1 = "";
  s2 = "";
  console::write_line("object::equals(\"{0}\", \"{1}\") => {2}", s1, s2, object::equals(s1, s2));
}
 
// This code produces the following output :
//
// object::equals("Tom", "Carol") => false
// object::equals("Tom", "Tom") => true
// object::equals("", "Tom") => false
// object::equals("Carol", "") => false
// object::equals("", "") => true

---

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

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