.. highlightlang:: us

.. index:: HatchCreate

.. _hatchcreate:

HatchCreate
===========

.. us.tag  HatchCreate NOTREADYENGLISH HATCH_Create Changed427

:ref:`HatchCreate` creates a hatch object. A hatch object is used for x/y datasets.

.. function::  hHatch = HatchCreate()
    hHatch = HatchCreate(hHatchOther)
    hHatch = HatchCreate(nStyle, rsDistance, rsOffset, nWidth, rvColorRGB)

.. us.return

**Return Value**

*hHatch* is the handle that can be used to access a hatch object. If the object
cannot be created, *hHatch* is 0.

.. us.params

**Parameters**

.. uparam:: nStyle

   *nStyle* is an OR combination of the following values:

   .. list-table::
      :header-rows: 1

      * - Value
        - Meaning
      * - HATCH_0
        - Hatch 0 degrees
      * - HATCH_45
        - Hatch 45 degrees
      * - HATCH_90
        - Hatch 90 degrees
      * - HATCH_135
        - Hatch 135 degrees

.. uparam:: rsDistance

   *rsDistance* is the distance between the hatch lines in centimeters.

.. uparam:: rsOffset

   *rsOffset* is the offset of the hatch origin in centimeters.

.. uparam:: nWidth

   *nWidth* specifies the line width of the hatch lines in 0.1 mm.

.. uparam:: rvColorRGB

   *rvColorRGB* is a vector with 3 elements that sets the hatch line color.

   .. list-table::
      :header-rows: 1

      * - Value
        - Meaning
      * - rvColorRGB[1]
        - Red (0 to 255)
      * - rvColorRGB[2]
        - Green (0 to 255)
      * - rvColorRGB[3]
        - Blue (0 to 255)

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Description
   * - 4.2.7
     - Function can be invoked with one parameter (copy constructor).

.. seealso::
   :ref:`overview-hatch`,
   :ref:`HatchDestroy`,
   :ref:`XYGetHatch`,
   :ref:`XYSetHatch`,
   :ref:`ObjCopy`

:sub:`id-245745`