Represents properties such as color, width etc. of the lines and curves being drawn. 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 <pen.h>

Inherits System::Object.

Public Member Functions
	Pen (const Color &color)
	Constructs a new Pen object representing the specified color. More...

	Pen (const Color &color, float width)
	Constructs a new Pen object representing the specified color and width. More...

	Pen (const SharedPtr< Brush > &brush)
	Constructs a new Pen object and initializes it with the specified Brush object. More...

	Pen (const SharedPtr< Brush > &brush, float width)
	Constructs a new Pen object and initializes it with the specified Brush object. More...

Drawing2D::PenAlignment	get_Alignment () const
	Returns a value that indicates the alignment of the current Pen object. More...

void	set_Alignment (Drawing2D::PenAlignment value)
	Sets the alignment of the current Pen object. More...

float	get_Width () const
	Returns the width of the current Pen object. More...

void	set_Width (float value)
	Sets the width of the current Pen object. More...

Drawing2D::LineCap	get_StartCap () const
	Returns a value that indicates the starting line cap of the current Pen object. More...

void	set_StartCap (Drawing2D::LineCap value)
	Sets the starting line cap of the current Pen object. More...

Drawing2D::LineCap	get_EndCap () const
	Returns a value that indicates the ending line cap of the current Pen object. More...

void	set_EndCap (Drawing2D::LineCap value)
	Sets the ending line cap of the current Pen object. More...

Drawing2D::LineJoin	get_LineJoin () const
	Returns a value that indicates how the lines drawn by this Pen object are joined. More...

void	set_LineJoin (Drawing2D::LineJoin value)
	Sets a value that specifies how the lines drawn by this Pen object are joined. More...

float	get_MiterLimit () const
	Returns the limit of the thickness of the join on a mitered corner. More...

void	set_MiterLimit (float value)
	Sets the limit of the thickness of the join on a mitered corner. More...

float	get_DashOffset () const
	Returns the distance from the start of a line to the beginning of a dash pattern. More...

void	set_DashOffset (float value)
	Sets the distance from the start of a line to the beginning of a dash pattern. More...

Drawing2D::DashCap	get_DashCap () const
	Returns a value that indicates the cap used at the both ends of a dashed line. More...

void	set_DashCap (Drawing2D::DashCap value)
	Sets a value that specifies the cap used at the both ends of a dashed line. More...

Drawing2D::DashStyle	get_DashStyle () const
	Returns a value that indicates the dash style of the current Pen object. More...

void	set_DashStyle (Drawing2D::DashStyle value)
	Sets a value that specifies the dash style of the current Pen object. More...

System::ArrayPtr< float >	get_DashPattern () const
	Returns an array indicating custom dash pattern in a dashed line. More...

void	set_DashPattern (const System::ArrayPtr< float > &value)
	Sets an array specifying custom dash pattern in a dashed line. The array consists of numbers that specify the lengths of alternating dashes and spaces. More...

System::ArrayPtr< float >	get_CompoundArray () const
	Returns an array of values that specifies a compound pen. More...

void	set_CompoundArray (const System::ArrayPtr< float > &value)
	Sets an array of values that specifies a compound pen. More...

SharedPtr< Drawing2D::Matrix >	get_Transform ()
	Returns a copy of a Matrix object that specifies the geometrical transformations for the pen represneted by the current object. More...

void	set_Transform (const SharedPtr< Drawing2D::Matrix > &value)
	Sets a Matrix object that specifies the geometrical transformations for the pen represneted by the current object. More...

void	set_CustomStartCap (const SharedPtr< Drawing2D::CustomLineCap > &value)
	Sets the custom start line cap. More...

void	set_CustomEndCap (const SharedPtr< Drawing2D::CustomLineCap > &value)
	Sets the custom end line cap. More...

void	set_Brush (const SharedPtr< Brush > &brush)
	Sets this pen's Brush object. More...

SharedPtr< Brush >	get_Brush ()
	Returns this pen's Brush object. More...

void	set_Color (const Color &color)
	Sets this pen's color. More...

Color	get_Color () const
	Returns this pen's color. More...

SharedPtr< Pen >	Clone ()
	Returns a copy of the current object. More...

void	ResetTransform ()
	Resets the current object's transform matrix so that it becomes an identity matrix. More...

void	MultiplyTransform (const SharedPtr< Drawing2D::Matrix > &matrix, Drawing2D::MatrixOrder order=Drawing2D::MatrixOrder::Prepend)
	Multiplies current object's transform matrix by the specified matrix. More...

void	RotateTransform (float angle, Drawing2D::MatrixOrder order=Drawing2D::MatrixOrder::Prepend)
	Rotates the local geometric transformation by the specified angle in the specified order. More...

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...

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...

void	SetLineCap (Drawing2D::LineCap startCap, Drawing2D::LineCap endCap, Drawing2D::DashCap dashCap)
	NOT IMPLEMENTED. More...

Drawing2D::PenType	get_PenType () const
	NOT IMPLEMENTED. More...

void	Dispose ()
	Releases all operating 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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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
virtual void	Apply (SkPaint &paint, const SharedPtr< Drawing2D::Matrix > &matrix, bool antialiased=false, bool is_closed_path=false)
	Sets the properties of the current pen on the specified SkPaint object. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	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 TypeInfo &	Type ()
	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 properties such as color, width etc. of the lines and curves being drawn. 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

◆ Pen() [1/4]

System::Drawing::Pen::Pen ( const Color & color )

Constructs a new Pen object representing the specified color.

Parameters

color The color of the pen represented by the object being constructed

◆ Pen() [2/4]

System::Drawing::Pen::Pen	(	const Color &	color,
		float	width
	)

Constructs a new Pen object representing the specified color and width.

Parameters

color	The color of the pen represented by the object being constructed
width	The width of the pen represented by the object being constructed

◆ Pen() [3/4]

System::Drawing::Pen::Pen ( const SharedPtr< Brush > & brush )

Constructs a new Pen object and initializes it with the specified Brush object.

Parameters

brush The Brush object that specifies the fill properties of the pen represented by the object being constructed

◆ Pen() [4/4]

System::Drawing::Pen::Pen	(	const SharedPtr< Brush > &	brush,
		float	width
	)

Constructs a new Pen object and initializes it with the specified Brush object.

Parameters

brush	The Brush object that specifies the fill properties of the pen represented by the object being constructed
width	The width of the pen represented by the object being constructed

Member Function Documentation

◆ Apply()

virtual void System::Drawing::Pen::Apply	(	SkPaint &	paint,
		const SharedPtr< Drawing2D::Matrix > &	matrix,
		bool	antialiased = `false`,
		bool	is_closed_path = `false`
	)

protectedvirtual

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

Parameters

paint	An object set the properties on
matrix	Graphics world transformation matrix
antialiased	Specifies if 'antialiased' property should be set on the specified SkPaint object.
is_closed_path	The flag specifies that the path is closed.

◆ Clone()

SharedPtr< Pen > System::Drawing::Pen::Clone ( )

Returns a copy of the current object.

◆ Dispose()

void System::Drawing::Pen::Dispose ( )

inline

Releases all operating resources acquired by the current object.

◆ get_Alignment()

Drawing2D::PenAlignment System::Drawing::Pen::get_Alignment ( ) const

Returns a value that indicates the alignment of the current Pen object.

◆ get_Brush()

SharedPtr< Brush > System::Drawing::Pen::get_Brush ( )

Returns this pen's Brush object.

◆ get_Color()

Color System::Drawing::Pen::get_Color ( ) const

Returns this pen's color.

◆ get_CompoundArray()

System::ArrayPtr< float > System::Drawing::Pen::get_CompoundArray ( ) const

Returns an array of values that specifies a compound pen.

◆ get_DashCap()

Drawing2D::DashCap System::Drawing::Pen::get_DashCap ( ) const

Returns a value that indicates the cap used at the both ends of a dashed line.

◆ get_DashOffset()

float System::Drawing::Pen::get_DashOffset ( ) const

Returns the distance from the start of a line to the beginning of a dash pattern.

◆ get_DashPattern()

System::ArrayPtr< float > System::Drawing::Pen::get_DashPattern ( ) const

Returns an array indicating custom dash pattern in a dashed line.

◆ get_DashStyle()

Drawing2D::DashStyle System::Drawing::Pen::get_DashStyle ( ) const

Returns a value that indicates the dash style of the current Pen object.

◆ get_EndCap()

Drawing2D::LineCap System::Drawing::Pen::get_EndCap ( ) const

Returns a value that indicates the ending line cap of the current Pen object.

◆ get_LineJoin()

Drawing2D::LineJoin System::Drawing::Pen::get_LineJoin ( ) const

Returns a value that indicates how the lines drawn by this Pen object are joined.

◆ get_MiterLimit()

float System::Drawing::Pen::get_MiterLimit ( ) const

Returns the limit of the thickness of the join on a mitered corner.

◆ get_PenType()

Drawing2D::PenType System::Drawing::Pen::get_PenType ( ) const

NOT IMPLEMENTED.

Exceptions

NotImplementedException Always

◆ get_StartCap()

Drawing2D::LineCap System::Drawing::Pen::get_StartCap ( ) const

Returns a value that indicates the starting line cap of the current Pen object.

◆ get_Transform()

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

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

◆ get_Width()

float System::Drawing::Pen::get_Width ( ) const

Returns the width of the current Pen object.

◆ MultiplyTransform()

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

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

Parameters

matrix	The matrix by which the current object's transform matrix is multiplied
order	Specifies the order of the operation

◆ ResetTransform()

void System::Drawing::Pen::ResetTransform ( )

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

◆ RotateTransform()

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

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

Parameters

angle	The rotation angle
order	Specifies the order of the operation

◆ ScaleTransform()

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

sx	Scale factor by which to perform scaling in in X-axis direction
sy	Scale factor by which to perform scaling in in Y-axis direction
order	Specifies the order of the operation

void System::Drawing::Pen::SetLineCap	(	Drawing2D::LineCap	startCap,
		Drawing2D::LineCap	endCap,
		Drawing2D::DashCap	dashCap
	)

NOT IMPLEMENTED.

Exceptions

NotImplementedException Always

◆ TranslateTransform()

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

dx	The value of translation in x
dy	The value of translation in y
order	Specifies the order of the operation

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Pen() [1/4]

◆ Pen() [2/4]

◆ Pen() [3/4]

◆ Pen() [4/4]

Member Function Documentation

◆ Apply()

◆ Clone()

◆ Dispose()

◆ get_Alignment()

◆ get_Brush()

◆ get_Color()

◆ get_CompoundArray()

◆ get_DashCap()

◆ get_DashOffset()

◆ get_DashPattern()

◆ get_DashStyle()

◆ get_EndCap()

◆ get_LineJoin()

◆ get_MiterLimit()

◆ get_PenType()

◆ get_StartCap()

◆ get_Transform()

◆ get_Width()

◆ MultiplyTransform()

◆ ResetTransform()

◆ RotateTransform()

◆ ScaleTransform()

◆ set_Alignment()

◆ set_Brush()

◆ set_Color()

◆ set_CompoundArray()

◆ set_CustomEndCap()

◆ set_CustomStartCap()

◆ set_DashCap()

◆ set_DashOffset()

◆ set_DashPattern()

◆ set_DashStyle()

◆ set_EndCap()

◆ set_LineJoin()

◆ set_MiterLimit()

◆ set_StartCap()

◆ set_Transform()

◆ set_Width()

◆ SetLineCap()

◆ TranslateTransform()