/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

// This file is generated automatically.

#ifndef _IFC4X1_IFCFILLAREASTYLEHATCHING_AUTO_IMPL_H
#define _IFC4X1_IFCFILLAREASTYLEHATCHING_AUTO_IMPL_H

#include "IfcGeometricRepresentationItemAutoImpl.h"
#include "IfcCurveStyleAutoImpl.h"
#include "IfcCartesianPointAutoImpl.h"

#include "TD_PackPush.h"

/** \details
  The namespace contains schema-dependent classes, definitions and sub routines
  for work with IFC4X1 express schema definitions.
*/
namespace OdIfc4x1 {

/** \details
  The IfcFillAreaStyleHatching defines simple vector-based hatching patterns, based on styled straight lines. 
  The curve font, color and thickness is specified by the HatchLineAppearance, 
  the angle by the HatchLineAngle and the distance to the next hatch line by StartOfNextHatchLine, being either an offset distance or a vector.
  
  - Details -
  For better control of the hatching appearance, when using hatch lines with other fonts then continuous, 
  the PatternStart allows to offset the start of the curve font pattern along the reference hatch line 
  (if not specified, the PatternStart is at zero distance from the virtual point of origin). 
  If the reference hatch line does not go through the origin (of the virtual hatching coordinate system), it can be offset by using the PatternStart.
  
  <IMAGE ifcfillareastylehatching_fig1>
  
  The image above shows simple hatching specified by using a curve font "continuous" at HatchLineAppearance.
  The distance of hatch lines is specified by a positive length measure. The angle (here 45' if measures in degree) is provided by HatchLineAngle.
  The PatternStart is set to NIL ($) in this example.
  
  <IMAGE ifcfillareastylehatching_fig2>
  
  The image above shows hatching from example 1 with using a different curve font at HatchLineAppearance.
  The distance of hatch lines is specified by a positive length measure, therefore the font pattern start 
  is at a point at the next hatch line specified by a vector being perpendicular to the point of origin at the reference hatch line.
  The PatternStart is set to NIL ($) in this example.
  
  <IMAGE ifcfillareastylehatching_fig3>
  
  The image above uses hatching from example 2 with a vector to determine the pattern start of the next hatch lines.
  The pattern start is the beginning of the first visual curve font pattern segment at IfcCurveFont.CurveFont.
  The PatternStart is set to NIL ($) in this example.
  
  <IMAGE ifcfillareastylehatching_fig4>
  
  The image above uses hatching from example 3 where the pattern start is offset from the point of origin at the reference hatch line. 
  That is, the first visible curve font pattern segment now does not start at the point of origin at the reference hatch line.
  
  <IMAGE ifcfillareastylehatching_fig5>
  
  This example uses hatching from example 4 where the hatch pattern is shifted against the underlying coordinate system.
  The point that is mapped to the insertion point of the IfcAnnotationFillAreaOccurrence now has an X and Y offset from the start of the reference hatch line. 
  That is, the reference hatch line now does not go through the insertion point of the hatching.
  
  <IMAGE ifcfillareastylehatching_fig6>
  
  This example shows use of IfcFillAreaStyleHatching attributes for two IfcFillAreaStyleHatching's within one IfcFillAreaStyle.
*/
class IFC4X1_EXPORT IfcFillAreaStyleHatching : public IfcGeometricRepresentationItem
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc4x1::IfcFillAreaStyleHatching);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of HatchLineAppearance attribute. 
  This attribute represents the curve style of the hatching lines. 
  Any curve style pattern starts at the origin of each hatch line.
  \returns
  Returns the value of HatchLineAppearance attribute.
  */
  const OdDAIObjectId& getHatchLineAppearance() const;

  /** \details
  Sets the value of HatchLineAppearance attribute. 
  This attribute represents the curve style of the hatching lines. 
  Any curve style pattern starts at the origin of each hatch line.
  \param HatchLineAppearance [in] HatchLineAppearance attribute to set.
  */
  void setHatchLineAppearance(const OdDAIObjectId& HatchLineAppearance);

  /** \details
  Returns the value of StartOfNextHatchLine attribute. 
  This attribute represents a repetition factor that determines the distance between adjacent hatch lines. 
  The factor can either be defined by a parallel offset, or by a repeat factor provided by IfcVector.
  \returns
  Returns the value of StartOfNextHatchLine attribute.
  */
  IfcHatchLineDistanceSelect startOfNextHatchLine();

  /** \details
  Returns the value of PointOfReferenceHatchLine attribute. 
  This attribute represents a Cartesian point which defines the offset of the reference hatch line from the origin of the (virtual) hatching coordinate system. 
  The origin is used for mapping the fill area style hatching onto an annotation fill area or surface. 
  The reference hatch line would then appear with this offset from the fill style target point.
  If not specified, the reference hatch lines goes through the origin of the (virtual) hatching coordinate system.
  \returns
  Returns the value of PointOfReferenceHatchLine attribute.
  */
  const OdDAIObjectId& getPointOfReferenceHatchLine() const;

  /** \details
  Sets the value of PointOfReferenceHatchLine attribute. 
  This attribute represents a Cartesian point which defines the offset of the reference hatch line from the origin of the (virtual) hatching coordinate system. 
  The origin is used for mapping the fill area style hatching onto an annotation fill area or surface. 
  The reference hatch line would then appear with this offset from the fill style target point.
  If not specified, the reference hatch lines goes through the origin of the (virtual) hatching coordinate system.
  \param PointOfReferenceHatchLine [in] PointOfReferenceHatchLine attribute to set.
  */
  void setPointOfReferenceHatchLine(const OdDAIObjectId& PointOfReferenceHatchLine);

  /** \details
  Returns the value of PatternStart attribute. 
  This attribute represents a distance along the reference hatch line which is the start point for the curve style font pattern of the reference hatch line.
  If not specified, the start point of the curve style font pattern is at the (virtual) hatching coordinate system.
  \returns
  Returns the value of PatternStart attribute.
  */
  const OdDAIObjectId& getPatternStart() const;

  /** \details
  Sets the value of PatternStart attribute. 
  This attribute represents a distance along the reference hatch line which is the start point for the curve style font pattern of the reference hatch line.
  If not specified, the start point of the curve style font pattern is at the (virtual) hatching coordinate system.
  \param PatternStart [in] Pattern start to set.
  */
  void setPatternStart(const OdDAIObjectId& PatternStart);

  /** \details
  Returns the value of HatchLineAngle attribute. 
  This attribute represents a plane angle measure determining the direction of the parallel hatching lines.
  \returns
  Returns the value of HatchLineAngle attribute.
  */
  double getHatchLineAngle() const;

  /** \details
  Sets the value of HatchLineAngle attribute. 
  This attribute represents a plane angle measure determining the direction of the parallel hatching lines.
  \param HatchLineAngle [in] HatchLineAngle to set.
  */
  void setHatchLineAngle(double HatchLineAngle);


public:

  /** \details
  Default constructor for the IfcFillAreaStyleHatching class.
  */
  IfcFillAreaStyleHatching();

  /** \details
  Reads object's data from the specified filer.
  \param rdFiler [in] Pointer to a filer from which to read the data.
  \returns
  A value of OdResult type that contains the result of the method execution.
  */
  virtual OdResult inFields(OdDAI::OdSpfFilerBase* rdFiler) override;

  /** \details
  Writes object's data the the specified filer.
  \param wrFiler [in] Pointer to a filer to which to write the data.
  \returns
  A value of OdResult type that contains the result of the method execution.
  */
  virtual OdResult outFields(OdDAI::OdSpfFilerBase* wrFiler) override;

  /** \details
  Returns a type of a class instance.
  \returns
  Pointer to the <exref target="OdDAI__Entity.html">OdDAI::Entity</exref> type that determines an entity definition within a schema.
  */
  virtual OdDAI::Entity* getInstanceType() const override;

  /** \details
  Returns an attribute value for the specified attribute name.
  \param attrName [in] Name of an attribute to query.
  \returns
  OdRxValue object that represents a generic variant type value.
  */
  virtual OdRxValue getAttr(const char * attrName) const override;

  /** \details
  Resets a value for the specified attribute.
  \param explicitAttrName [in] Explicit name of the attribute to reset.
  */
  virtual void unsetAttr(const char * explicitAttrName) override;

  /** \details
  Checks whether the specified attribute is set.
  \param explicitAttrName [in] Explicit name of the attribute to test.
  \returns
  true if the specified attribute is set, false otherwise.
  */
  virtual bool testAttr(const char * explicitAttrName) const override;

  /** \details
  Sets the specified attribute with a given value.
  \param explicitAttrName [in] Explicit name of the attribute to set.
  \param val [in] Value to set.
  \returns
  true if the value is successfully set for the specified attribute, false otherwise.
  */
  virtual bool putAttr(const char * explicitAttrName, const OdRxValue &val) override;

  /** \details
  Checks whether the specified instance is the object derived from or belongs to this class.
  \param entityType [in] Entity to check.
  \returns
  true if the specified instance is the object derived from or belongs to this class, false otherwise.
  */
  virtual bool isKindOf(OdIfc::OdIfcEntityType entityType) const override;

  /** \details
  Returns the type of this entity.
  \returns
  A value of the <exref target="OdIfc__OdIfcEntityType.html">OdIfc::OdIfcEntityType</exref> type that represents type of this entity.
  */
  virtual OdIfc::OdIfcEntityType type() const override;

  /** \details
  Returns an attribute value for the specified attribute definition.
  \param attrDef [in] Attribute definition to query.
  \returns
  OdRxValue object that represents a generic variant type value.
  */
  virtual OdRxValue getAttr(const OdIfc::OdIfcAttribute attrDef) const override;

  /** \details
  Resets a value for the specified attribute.
  \param explicitAttrDef [in] Explicit definition that represents an attribute to reset.
  */
  virtual void unsetAttr(const OdIfc::OdIfcAttribute explicitAttrDef) override;

  /** \details
  Checks whether the specified attribute is set.
  \param explicitAttrDef [in] Attribute definition to test.
  \returns
  true if the specified attribute is set, false otherwise.
  */
  virtual bool testAttr(const OdIfc::OdIfcAttribute explicitAttrDef) const override;

  /** \details
  Sets the specified attribute with a given value.
  \param explicitAttrDef [in] Explicit attribute definition to set.
  \param val [in] Value to set.
  \returns
  true if the value is successfully set for the specified attribute, false otherwise.
  */
  virtual bool putAttr(const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override;

protected:
  // Fields declaration: 
  OdDAIObjectId m_HatchLineAppearance;   // IfcCurveStyle
  OdDAI::Select m_StartOfNextHatchLine;   // IfcHatchLineDistanceSelect
  OdDAIObjectId m_PointOfReferenceHatchLine;   // IfcCartesianPoint  [optional]
  OdDAIObjectId m_PatternStart;   // IfcCartesianPoint  [optional]
  double m_HatchLineAngle;   // IfcPlaneAngleMeasure
};

/** \details
  A data type that represents a smart pointer to a <exref target="OdIfc4x1__IfcFillAreaStyleHatching.html">IfcFillAreaStyleHatching</exref> object.
*/
typedef OdSmartPtr<IfcFillAreaStyleHatching> IfcFillAreaStyleHatchingPtr;

} // namespace

#include "TD_PackPop.h"

#endif // _IFC4X1_IFCFILLAREASTYLEHATCHING_AUTO_IMPL_H