/////////////////////////////////////////////////////////////////////////////// // 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 _IFC4_IFCLIGHTSOURCESPOT_AUTO_IMPL_H #define _IFC4_IFCLIGHTSOURCESPOT_AUTO_IMPL_H #include "IfcLightSourcePositionalAutoImpl.h" #include "IfcDirectionAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC4 express schema definitions. */ namespace OdIfc4 { /** \details The spot light source is one of light source subtypes. Spot light source entities have a light source color, position, direction, attenuation coefficients, concentration exponent, and spread angle. - Details - If a point lies outside the cone of influence of a light source of this type as determined by the light source position, direction and spread angle its color is not affected by that light source. Spot light source: */ class IFC4_EXPORT IfcLightSourceSpot : public IfcLightSourcePositional { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4::IfcLightSourceSpot); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of Orientation attribute. This attribute represents the direction of the axis of the cone of the light source specified in the coordinate space of the representation being projected. \returns Returns the value of Orientation attribute. */ const OdDAIObjectId& getOrientation() const; /** \details Sets the value of Orientation attribute. This attribute represents the direction of the axis of the cone of the light source specified in the coordinate space of the representation being projected. \param Orientation [in] Orientation to set. */ void setOrientation(const OdDAIObjectId& Orientation); /** \details Returns the value of ConcentrationExponent attribute. This attribute represents the exponent on the cosine of the angle between the line that starts at the position of the spot light source and is in the direction of the orientation of the spot light source and a line that starts at the position of the spot light source and goes through a point on the surface being shaded. \returns Returns the value of ConcentrationExponent attribute. */ double getConcentrationExponent() const; /** \details Sets the value of ConcentrationExponent attribute. This attribute represents the exponent on the cosine of the angle between the line that starts at the position of the spot light source and is in the direction of the orientation of the spot light source and a line that starts at the position of the spot light source and goes through a point on the surface being shaded. \param ConcentrationExponent [in] Concentration exponent to set. */ void setConcentrationExponent(double ConcentrationExponent); /** \details Returns the value of SpreadAngle attribute. This attribute represents an angle between the line that starts at the position of the spot light source and is in the direction of the spot light source and any line on the boundary of the cone of influence. The light source's emission intensity drops off from the inner solid angle (BeamWidthAngle attribute) to the outer solid angle (this attribute). \returns Returns the value of SpreadAngle attribute. */ double getSpreadAngle() const; /** \details Sets the value of SpreadAngle attribute. This attribute represents an angle between the line that starts at the position of the spot light source and is in the direction of the spot light source and any line on the boundary of the cone of influence. The light source's emission intensity drops off from the inner solid angle (BeamWidthAngle attribute) to the outer solid angle (this attribute). \param SpreadAngle [in] Spread angle to set. */ void setSpreadAngle(double SpreadAngle); /** \details Returns the value of BeamWidthAngle attribute. This attribute represents an inner solid angle in which the light source emits light at uniform full intensity. The light source's emission intensity drops off from the inner solid angle (this attribute) to the outer solid angle (spreadAngle attribute). \returns Returns the value of BeamWidthAngle attribute. */ double getBeamWidthAngle() const; /** \details Sets the value of BeamWidthAngle attribute. This attribute represents an inner solid angle in which the light source emits light at uniform full intensity. The light source's emission intensity drops off from the inner solid angle (this attribute) to the outer solid angle (spreadAngle attribute). \param BeamWidthAngle [in] Beam width angle to set. */ void setBeamWidthAngle(double BeamWidthAngle); public: /** \details Default constructor for the IfcLightSourceSpot class. */ IfcLightSourceSpot(); /** \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_Orientation; // IfcDirection double m_ConcentrationExponent; // IfcReal [optional] IfcPositivePlaneAngleMeasure m_SpreadAngle; // IfcPositivePlaneAngleMeasure IfcPositivePlaneAngleMeasure m_BeamWidthAngle; // IfcPositivePlaneAngleMeasure }; /** \details A data type that represents a smart pointer to a IfcLightSourceSpot object. */ typedef OdSmartPtr IfcLightSourceSpotPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4_IFCLIGHTSOURCESPOT_AUTO_IMPL_H