Dtk_HatchingPattern Class Reference

This is the Hatching Pattern class. This describes a repetition of lines/dots or coloring. It includes line style and colors as well. More...

Public Member Functions
Dtk_Double64 &	Angle ()
const Dtk_Double64 &	Angle () const
	Retrieves the angle between horizontal line and hatch line (or dot). Applies for hatching and dotting. More...
Dtk_RGB &	Color ()
const Dtk_RGB &	Color () const
	Retrieves the color of the pattern element. More...
	Dtk_HatchingPattern ()
	Default constructor. More...
	Dtk_HatchingPattern (const Dtk_HatchingPattern &in)
	Copy constructor. More...
Dtk_HatchingStyle &	HatchingStyle ()
const Dtk_HatchingStyle &	HatchingStyle () const
	Retrieves the hatching style, one of the following : hatching, coloring or dotting. More...
Dtk_Int32 &	LineType ()
const Dtk_Int32 &	LineType () const
	Retrieves the hatch line type. Applies for hatching. The value can be casted to enum Dtk_FontLineType Returns one of the following values : More...
Dtk_Double64 &	LineWidth ()
const Dtk_Double64 &	LineWidth () const
	Retrieves the hatch line width. Applies for hatching. More...
Dtk_Double64 &	Offset ()
const Dtk_Double64 &	Offset () const
	Retrieves the position start offset along the hatch line. Applies for hatching and dotting. More...
Dtk_HatchingPattern &	operator= (const Dtk_HatchingPattern &in)
	Copy assignment operator. More...
Dtk_Double64 &	Pitch ()
const Dtk_Double64 &	Pitch () const
	Retrieves the position offset perpendicular to the hatch line (or dot). Applies for hatching and dotting. More...

Data Fields
Dtk_Double64	_angle
Dtk_RGB	_color
Dtk_Int32	_line_style
Dtk_Double64	_line_width
Dtk_Double64	_offset
Dtk_Double64	_pitch
Dtk_HatchingStyle	_style

Detailed Description

This is the Hatching Pattern class. This describes a repetition of lines/dots or coloring. It includes line style and colors as well.

Constructor & Destructor Documentation

Dtk_HatchingPattern() [1/2]

Dtk_HatchingPattern::Dtk_HatchingPattern

(

)

Default constructor.

     {
          this->_angle = 0.0;
          this->_line_style = 0;
          this->_line_width = 0.0;
          this->_offset = 0.0;
          this->_style = (Dtk_HatchingStyle) 0;
          this->_pitch = 0.0;
 
     }

Dtk_HatchingPattern() [2/2]

Dtk_HatchingPattern::Dtk_HatchingPattern

(

const Dtk_HatchingPattern &

in

)

Copy constructor.

Parameters

in	Object to copy from.

     {
          this->_angle = in._angle;
          this->_color = in._color;
          this->_line_style = in._line_style;
          this->_line_width = in._line_width;
          this->_offset = in._offset;
          this->_style = in._style;
          this->_pitch = in._pitch;
     }

Member Function Documentation

Angle() [1/2]

Dtk_Double64& Dtk_HatchingPattern::Angle

(

)

Angle() [2/2]

const Dtk_Double64& Dtk_HatchingPattern::Angle

(

)

const

Retrieves the angle between horizontal line and hatch line (or dot). Applies for hatching and dotting.

Returns

The angle between horizontal line and hatch line

Color() [1/2]

Dtk_RGB& Dtk_HatchingPattern::Color

(

)

Color() [2/2]

const Dtk_RGB& Dtk_HatchingPattern::Color

(

)

const

Retrieves the color of the pattern element.

Returns

The color of the pattern element.

HatchingStyle() [1/2]

Dtk_HatchingStyle& Dtk_HatchingPattern::HatchingStyle

(

)

HatchingStyle() [2/2]

const Dtk_HatchingStyle& Dtk_HatchingPattern::HatchingStyle

(

)

const

Retrieves the hatching style, one of the following : hatching, coloring or dotting.

Returns

The hatching style : Dtk_HatchingStyle_Hatching, Dtk_HatchingStyle_Coloring or Dtk_HatchingStyle_Dotting

LineType() [1/2]

Dtk_Int32& Dtk_HatchingPattern::LineType

(

)

LineType() [2/2]

const Dtk_Int32& Dtk_HatchingPattern::LineType

(

)

const

Retrieves the hatch line type. Applies for hatching. The value can be casted to enum Dtk_FontLineType Returns one of the following values :

See also

0 : No Pattern

1 : ________________________________ Solid

2 : _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ Dash

3 : ________ _ _ _________ _ _ _____ Phantom

4 : ________ _ _________ _ _________ Center Line

5 : ................................ Dotted

6 : ___ ___ ___ ___ ___ ___ ___ ___ Long Dashed

7 : ___ . ___ . ___ . ___ . ___ . __ Dotted Dashed

8 : –'\,--—'\,--—'\,--—'\,— Breakline

LineWidth() [1/2]

Dtk_Double64& Dtk_HatchingPattern::LineWidth

(

)

LineWidth() [2/2]

const Dtk_Double64& Dtk_HatchingPattern::LineWidth

(

)

const

Retrieves the hatch line width. Applies for hatching.

Returns

The hatch line width

Offset() [1/2]

Dtk_Double64& Dtk_HatchingPattern::Offset

(

)

Offset() [2/2]

const Dtk_Double64& Dtk_HatchingPattern::Offset

(

)

const

Retrieves the position start offset along the hatch line. Applies for hatching and dotting.

Returns

The first position offset along the hatch line

operator=()

Dtk_HatchingPattern& Dtk_HatchingPattern::operator=

(

const Dtk_HatchingPattern &

in

)

Copy assignment operator.

Parameters

in	Object to copy from.

     {
          if (&in!=this)
          {
               this->_angle = in._angle;
               this->_color = in._color;
               this->_line_style = in._line_style;
               this->_line_width = in._line_width;
               this->_offset = in._offset;
               this->_pitch = in._pitch;
               this->_style = in._style;
          }
          return *this;
     }

Pitch() [1/2]

Dtk_Double64& Dtk_HatchingPattern::Pitch

(

)

Pitch() [2/2]

const Dtk_Double64& Dtk_HatchingPattern::Pitch

(

)

const

Retrieves the position offset perpendicular to the hatch line (or dot). Applies for hatching and dotting.

Returns

The position offset perpendicular to the hatch line

Field Documentation

_angle

Dtk_Double64 Dtk_HatchingPattern::_angle

_color

Dtk_RGB Dtk_HatchingPattern::_color

_line_style

Dtk_Int32 Dtk_HatchingPattern::_line_style

_line_width

Dtk_Double64 Dtk_HatchingPattern::_line_width

_offset

Dtk_Double64 Dtk_HatchingPattern::_offset

_pitch

Dtk_Double64 Dtk_HatchingPattern::_pitch

_style

Dtk_HatchingStyle Dtk_HatchingPattern::_style