/////////////////////////////////////////////////////////////////////////////// // 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 _IFC2X_FINAL_IFCSURFACERENDERINGPROPERTIES_AUTO_IMPL_H #define _IFC2X_FINAL_IFCSURFACERENDERINGPROPERTIES_AUTO_IMPL_H #include "IfcSurfaceShadingPropertiesAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC2X_FINAL express schema definitions. */ namespace OdIfc2x_final { /** \details A container class for properties for visualization related to particular surface style. */ class IFC2X_FINAL_EXPORT IfcSurfaceRenderingProperties : public IfcSurfaceShadingProperties { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc2x_final::IfcSurfaceRenderingProperties); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of AmbientIntensity attribute. This attribute specifies how much ambient light from light sources this surface reflects. Ambient light is omnidirectional and depends only on the number of light sources, not their positions with respect to the surface. \returns Returns the value of AmbientIntensity attribute. */ double getAmbientIntensity() const; /** \details Sets the value of AmbientIntensity attribute. This attribute specifies how much ambient light from light sources this surface reflects. Ambient light is omnidirectional and depends only on the number of light sources, not their positions with respect to the surface. \param AmbientIntensity [in] AmbientIntensity attribute to set. */ void setAmbientIntensity(double AmbientIntensity); /** \details Gets the value of DiffuseColor attribute. This attribute represents the diffuse color field that 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. \param DiffuseColor [out] Receives the DiffuseColor attribute. */ void getDiffuseColor(OdArray& DiffuseColor) const; /** \details Returns the value of DiffuseColor attribute. This attribute represents the diffuse color field that 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. \returns Returns the value of DiffuseColor attribute. */ OdDAI::ListOfDouble& diffuseColor(); /** \details Returns the value of Transparency attribute. This attribute represents the transparency field specifies 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 transparency field specifies how "clear" an object is, with 1.0 being completely transparent, and 0.0 completely opaque. \param Transparency [in] Transparency attribute to set. */ void setTransparency(double Transparency); /** \details Gets the value of EmmisiveColor attribute. This attribute represents the emissive color field that models "glowing" objects. This can be useful for displaying pre-lit models (where the light energy of the room is computed explicitly), or for displaying scientific data. \param EmmisiveColor [out] Receives the EmmisiveColor attribute to set. */ void getEmmisiveColor(OdArray& EmmisiveColor) const; /** \details Returns the value of EmmisiveColor attribute. This attribute represents the emissive color field that models "glowing" objects. This can be useful for displaying pre-lit models (where the light energy of the room is computed explicitly), or for displaying scientific data. \returns Returns the value of EmmisiveColor attribute. */ OdDAI::ListOfDouble& emmisiveColor(); /** \details Returns the value of SpecularIntensity attribute. This attribute represents the specular intensity (shininess), that together with specular color determines the specular highlights (e.g., the shiny spots on an apple). Lower shininess values produce soft glows, while higher values result in sharper, smaller highlights. \returns Returns the value of SpecularIntensity attribute. */ double getSpecularIntensity() const; /** \details Sets the value of SpecularIntensity attribute. This attribute represents the specular intensity (shininess), that together with specular color determines the specular highlights (e.g., the shiny spots on an apple). Lower shininess values produce soft glows, while higher values result in sharper, smaller highlights. \param SpecularIntensity [in] SpecularIntensity attribute to set. */ void setSpecularIntensity(double SpecularIntensity); /** \details Gets the value of SpecularColor attribute. This attribute represents the specular color, that together with specular color determines the specular highlights (e.g., the shiny spots on an apple). Lower shininess values produce soft glows, while higher values result in sharper, smaller highlights. \param SpecularColor [out] Receives the SpecularColor attribute to set. */ void getSpecularColor(OdArray& SpecularColor) const; /** \details Returns the value of SpecularColor attribute. This attribute represents the specular color, that together with specular color determines the specular highlights (e.g., the shiny spots on an apple). Lower shininess values produce soft glows, while higher values result in sharper, smaller highlights. \returns Returns the value of SpecularColor attribute. */ OdDAI::ListOfDouble& specularColor(); public: /** \details Default constructor for the IfcSurfaceRenderingProperties class. */ IfcSurfaceRenderingProperties(); /** \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 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: IfcNormalisedRatioMeasure m_AmbientIntensity; // IfcNormalisedRatioMeasure OdDAI::ListOfDouble m_DiffuseColor; // IfcColorRGB IfcNormalisedRatioMeasure m_Transparency; // IfcNormalisedRatioMeasure OdDAI::ListOfDouble m_EmmisiveColor; // IfcColorRGB [optional] IfcNormalisedRatioMeasure m_SpecularIntensity; // IfcNormalisedRatioMeasure [optional] OdDAI::ListOfDouble m_SpecularColor; // IfcColorRGB [optional] }; /** \details A data type that represents a smart pointer to a IfcSurfaceRenderingProperties object. */ typedef OdSmartPtr IfcSurfaceRenderingPropertiesPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC2X_FINAL_IFCSURFACERENDERINGPROPERTIES_AUTO_IMPL_H