/////////////////////////////////////////////////////////////////////////////// 
// 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 _IFC2X2_FINAL_IFCSURFACESTYLERENDERING_AUTO_IMPL_H
#define _IFC2X2_FINAL_IFCSURFACESTYLERENDERING_AUTO_IMPL_H

#include "IfcSurfaceStyleShadingAutoImpl.h"

#include "TD_PackPush.h"

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

/** \details
  IfcSurfaceStyleRendering holds the properties for visualization related to a particular surface side style. 
  Three lighting models are supported:
  * Phong lighting model
  * Physically-based lighting model
  * Flat lighting model that ignores light sources
  
  The material parameters are specified as scalars or RGB colors. Every material parameter can be adjusted using a texture. 
  This allows to vary this parameter across the surface.
*/
class IFC2X2_FINAL_EXPORT IfcSurfaceStyleRendering : public IfcSurfaceStyleShading
{
  //DOM-IGNORE-BEGIN
  OD_EXP_DECLARE_MEMBERS(OdIfc2x2_final::IfcSurfaceStyleRendering);
  //DOM-IGNORE-END

public:


  //
  // OdDAI early binding accessors
  //


  /** \details
  Returns the value of Transparency attribute. 
  This attribute represents the degree of transparency that is indicated by the percentage of light traversing the surface.
  Transparency indicates how "clear" an object is, with 1.0 being completely transparent, and 0.0 completely opaque.
  \returns
  Returns the value of Transparency attribute.
  */
  double getTransparency() const;

  /** \details
  Sets the value of Transparency attribute. 
  This attribute represents the degree of transparency that is indicated by the percentage of light traversing the surface.
  Transparency indicates how "clear" an object is, with 1.0 being completely transparent, and 0.0 completely opaque.
  \param Transparency [in] Transparency to set.
  */
  void setTransparency(double Transparency);

  /** \details
  Returns the value of DiffuseColour attribute. 
  This attribute represents the diffuse color part of the reflectance.
  The diffuse colour field reflects all light sources depending on the angle of the surface with respect to the light source. 
  The more directly the surface faces the light, the more diffuse light reflects.
  The diffuse colour is then defined by surface colour * diffuse factor.
  \returns
  Returns the value of DiffuseColour attribute.
  */
  IfcColourOrFactor diffuseColour();

  /** \details
  Returns the value of TransmissionColour attribute. 
  This attribute represents the transmissive color part of the reflectance.
  It only applies to materials where Transparency field is greater than zero.
  The transmissive colour field specifies the colour that passes through a transparant material (like the colour that shines through a glass).
  The transmissive factor defines the transmissive part, the transmissive colour is then defined by surface colour * transmissive factor.
  \returns
  Returns the value of TransmissionColour attribute.
  */
  IfcColourOrFactor transmissionColour();

  /** \details
  Returns the value of DiffuseTransmissionColour attribute. 
  This attribute represents the diffuse transmission color part of the reflectance.
  It only applies to materials where Transparency field is greater than zero.
  The diffuse transmission colour specifies how much diffuse light is reflected at the opposite side of the material surface.
  The diffuse transmission factor field specifies how much diffuse light from light sources this surface reflects on the opposite side of the material surface. 
  The diffuse transmissive colour is then defined by surface colour * diffuse transmissive factor.
  \returns
  Returns the value of DiffuseTransmissionColour attribute.
  */
  IfcColourOrFactor diffuseTransmissionColour();

  /** \details
  Returns the value of ReflectionColour attribute. 
  This attribute represents the reflection (or mirror) color part of the reflectance.
  Applies to "glass" and "mirror" reflection models.
  The reflection colour specifies the contribution made by light from the mirror direction, i.e. light being reflected from the surface.
  The reflection factor specifies the amount of contribution made by light from the mirror direction. 
  The reflection colour is then defined by surface colour * reflection factor.
  \returns
  Returns the value of ReflectionColour attribute.
  */
  IfcColourOrFactor reflectionColour();

  /** \details
  Returns the value of SpecularColour attribute. 
  This attribute represents the specular color part of the reflectance.
  The specular colour determines the specular highlights (e.g., the shiny spots on an apple). 
  When the angle from the light to the surface is close to the angle from the surface to the viewer, 
  the specular colour is added to the diffuse and ambient colour calculations.
  The specular factor defines the specular part, the specular colour is then defined by surface colour * specular factor.
  \returns
  Returns the value of SpecularColour attribute.
  */
  IfcColourOrFactor specularColour();

  /** \details
  Returns the value of SpecularHighlight attribute. 
  This attribute represents the exponent or roughness part of the specular reflectance.
  \returns
  Returns the value of SpecularHighlight attribute.
  */
  IfcSpecularHighlightSelect specularHighlight();

  /** \details
  Returns the value of ReflectanceMethod attribute. 
  This attribute represents the predefined types of reflectance method from which the required method can be set.
  \returns
  Returns the value of ReflectanceMethod attribute.
  */
  IfcReflectanceMethodEnum getReflectanceMethod() const;

  /** \details
  Sets the value of ReflectanceMethod attribute. 
  This attribute represents the predefined types of reflectance method from which the required method can be set.
  \param ReflectanceMethod [in] Reflectance method to set.
  */
  void setReflectanceMethod(IfcReflectanceMethodEnum ReflectanceMethod);


public:

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

  /** \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: 
  IfcNormalisedRatioMeasure m_Transparency;   // IfcNormalisedRatioMeasure  [optional]
  OdDAI::Select m_DiffuseColour;   // IfcColourOrFactor  [optional]
  OdDAI::Select m_TransmissionColour;   // IfcColourOrFactor  [optional]
  OdDAI::Select m_DiffuseTransmissionColour;   // IfcColourOrFactor  [optional]
  OdDAI::Select m_ReflectionColour;   // IfcColourOrFactor  [optional]
  OdDAI::Select m_SpecularColour;   // IfcColourOrFactor  [optional]
  OdDAI::Select m_SpecularHighlight;   // IfcSpecularHighlightSelect  [optional]
  OdDAI::Enum m_ReflectanceMethod;   // IfcReflectanceMethodEnum
};

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

} // namespace

#include "TD_PackPop.h"

#endif // _IFC2X2_FINAL_IFCSURFACESTYLERENDERING_AUTO_IMPL_H