/////////////////////////////////////////////////////////////////////////////// // 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 _IFC4X4_IFCSURFACESTYLELIGHTING_AUTO_IMPL_H #define _IFC4X4_IFCSURFACESTYLELIGHTING_AUTO_IMPL_H #include "IfcPresentationItemAutoImpl.h" #include "IfcColourRgbAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC4X4 express schema definitions. */ namespace OdIfc4x4 { /** \details IfcSurfaceStyleLighting is a container class for properties for calculation of physically exact illuminance related to a particular surface style. The next image shows the reflection and transmission components from an incident ray. - Details - The sum of the components for reflection and transmission is a value of 1.0 denoting that the incident ray is completely decomposed into reflection and transmission components. Each value of reflection and transmission is therefore within the range 0.0 to 1.0. All these factors can be measured physically and are ratios for the red, green and blue part of the light. These properties are defined in the model as Type IfcColorRGB with a factor for each colour. * EXAMPLE: A green glass transmits only green light, so its transmission factor is 0.0 for red, between 0.0 and 1.0 for green and 0.0 for blue. A green surface reflects only green light, so the reflectance factor is 0.0 for red, between 0.0 and 1.0 for green and 0.0 for blue. */ class IFC4X4_EXPORT IfcSurfaceStyleLighting : public IfcPresentationItem { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x4::IfcSurfaceStyleLighting); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of DiffuseTransmissionColour attribute. DiffuseTransmissionColour is the degree of diffusion of the transmitted light. In the case of completely transparent materials there is no diffusion. The greater the diffusing power, the smaller the direct component of the transmitted light, up to the point where only diffuse light is produced. A value of 1 means totally diffuse for that colour part of the light. \returns Returns the value of DiffuseTransmissionColour attribute. \remarks The factor can be measured physically and has three ratios for the red, green and blue part of the light. */ const OdDAIObjectId& getDiffuseTransmissionColour() const; /** \details Sets the value of DiffuseTransmissionColour attribute. DiffuseTransmissionColour is the degree of diffusion of the transmitted light. In the case of completely transparent materials there is no diffusion. The greater the diffusing power, the smaller the direct component of the transmitted light, up to the point where only diffuse light is produced. A value of 1 means totally diffuse for that colour part of the light. \param DiffuseTransmissionColour [in] Diffuse transmission colour to set. \remarks The factor can be measured physically and has three ratios for the red, green and blue part of the light. */ void setDiffuseTransmissionColour(const OdDAIObjectId& DiffuseTransmissionColour); /** \details Returns the value of DiffuseReflectionColour attribute. DiffuseReflectionColour is the degree of diffusion of the reflected light. In the case of specular surfaces there is no diffusion. The greater the diffusing power of the reflecting surface, the smaller the specular component of the reflected light, up to the point where only diffuse light is produced. A value of 1 means totally diffuse for that colour part of the light. \returns Returns the value of DiffuseReflectionColour attribute. \remarks The factor can be measured physically and has three ratios for the red, green and blue part of the light. */ const OdDAIObjectId& getDiffuseReflectionColour() const; /** \details Sets the value of DiffuseReflectionColour attribute. DiffuseReflectionColour is the degree of diffusion of the reflected light. In the case of specular surfaces there is no diffusion. The greater the diffusing power of the reflecting surface, the smaller the specular component of the reflected light, up to the point where only diffuse light is produced. A value of 1 means totally diffuse for that colour part of the light. \param DiffuseReflectionColour [in] Diffuse reflection colour to set. \remarks The factor can be measured physically and has three ratios for the red, green and blue part of the light. */ void setDiffuseReflectionColour(const OdDAIObjectId& DiffuseReflectionColour); /** \details Returns the value of TransmissionColour attribute. This attribute describes how the light falling on a body is totally or partially transmitted. \returns Returns the value of TransmissionColour attribute. \remarks The factor can be measured physically and has three ratios for the red, green and blue part of the light. */ const OdDAIObjectId& getTransmissionColour() const; /** \details Returns the value of TransmissionColour attribute. This attribute describes how the light falling on a body is totally or partially transmitted. \param TransmissionColour [in] Transmission colour to set. \remarks The factor can be measured physically and has three ratios for the red, green and blue part of the light. */ void setTransmissionColour(const OdDAIObjectId& TransmissionColour); /** \details Returns the value of ReflectanceColour attribute. This attribute is a coefficient that determines the extent that the light falling onto a surface is fully or partially reflected. \returns Returns the value of ReflectanceColour attribute. \remarks The factor can be measured physically and has three ratios for the red, green and blue part of the light. */ const OdDAIObjectId& getReflectanceColour() const; /** \details Sets the value of ReflectanceColour attribute. This attribute is a coefficient that determines the extent that the light falling onto a surface is fully or partially reflected. \param ReflectanceColour [in] Reflectance colour to set. \remarks The factor can be measured physically and has three ratios for the red, green and blue part of the light. */ void setReflectanceColour(const OdDAIObjectId& ReflectanceColour); public: /** \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 OdDAI::Entity 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 Early-bound version of instances comparison. \param pOther [in] Other application instance. \param ordering [out] Receives the ordering (comparison) status. \returns true if comparison was performed, false if method has no implementation, so late-bound version could be applied. \remarks If the method returns true, the ordering parameter can receive one of the following statuses: Name Value Description _kLessThan_ -1 This object < Other Object. _kEqual_ 0 This object = Other Object. _kGreaterThan_ 1 This object > Other Object. _kNotOrderable_ 2 This class is not orderable.
*/ virtual bool comparedToEarlyImpl(const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) 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 OdIfc::OdIfcEntityType 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_DiffuseTransmissionColour; // IfcColourRgb OdDAIObjectId m_DiffuseReflectionColour; // IfcColourRgb OdDAIObjectId m_TransmissionColour; // IfcColourRgb OdDAIObjectId m_ReflectanceColour; // IfcColourRgb }; /** \details A data type that represents a smart pointer to a IfcSurfaceStyleLighting object. */ typedef OdSmartPtr IfcSurfaceStyleLightingPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X4_IFCSURFACESTYLELIGHTING_AUTO_IMPL_H