///////////////////////////////////////////////////////////////////////////////
// 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_IFCLIGHTSOURCEPOSITIONAL_AUTO_IMPL_H
#define _IFC4_IFCLIGHTSOURCEPOSITIONAL_AUTO_IMPL_H
#include "IfcLightSourceAutoImpl.h"
#include "IfcCartesianPointAutoImpl.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 light source positional entity is a subtype of light source.
This entity has a light source position and attenuation coefficients.
A positional light source affects a surface based on the surface's orientation and position.
Illumination of a point light falls off with distance as specified by three attenuation coefficients.
The attenuation factor is
⪯
1/max(attenuation[0] + attenuation[1] × r + attenuation[2] × r 2 , 1),
&/pre;
where r is the distance from the light to the surface being illuminated. The default is no attenuation.
An attenuation value of (0, 0, 0) is identical to (1, 0, 0). Attenuation values is greater than or equal to zero.
*/
class IFC4_EXPORT IfcLightSourcePositional : public IfcLightSource
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc4::IfcLightSourcePositional);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of Position attribute.
The Cartesian point represents the position of the light source.
\returns
Returns the value of Position attribute.
*/
const OdDAIObjectId& getPosition() const;
/** \details
Sets the value of Position attribute.
The Cartesian point represents the position of the light source.
\param Position [in] Position to set.
*/
void setPosition(const OdDAIObjectId& Position);
/** \details
Returns the value of Radius attribute.
This attribute represents the maximum distance from the light source for a surface still to be illuminated.
A point light illuminates geometry within radius of its location.
\returns
Returns the value of Radius attribute.
*/
double getRadius() const;
/** \details
Sets the value of Radius attribute.
This attribute represents the maximum distance from the light source for a surface still to be illuminated.
A point light illuminates geometry within radius of its location.
\param Radius [in] Radius to set.
*/
void setRadius(double Radius);
/** \details
Returns the value of ConstantAttenuation attribute.
This attribute represents a value of the attenuation in the lighting equation that is constant.
\returns
Returns the value of ConstantAttenuation attribute.
*/
double getConstantAttenuation() const;
/** \details
Sets the value of ConstantAttenuation attribute.
This attribute represents a value of the attenuation in the lighting equation that is constant.
\param ConstantAttenuation [in] ConstantAttenuation attribute to set.
*/
void setConstantAttenuation(double ConstantAttenuation);
/** \details
Returns the value of DistanceAttenuation attribute.
This attribute represents a value of the attenuation in the lighting equation
that is proportional to the distance from the light source.
\returns
Returns the value of DistanceAttenuation attribute.
*/
double getDistanceAttenuation() const;
/** \details
Sets the value of DistanceAttenuation attribute.
This attribute represents a value of the attenuation in the lighting equation
that is proportional to the distance from the light source.
\param DistanceAttenuation [in] Distance attenuation to set.
*/
void setDistanceAttenuation(double DistanceAttenuation);
/** \details
Returns the value of QuadricAttenuation attribute.
This attribute represents a value of the attenuation in the lighting equation
that is proportional to the square value of the distance from the light source.
\returns
Returns the value of QuadricAttenuation attribute.
*/
double getQuadricAttenuation() const;
/** \details
Sets the value of QuadricAttenuation attribute.
This attribute represents the value of the attenuation in the lighting equation
that is proportional to the square value of the distance from the light source.
\param QuadricAttenuation [in] Quadric attenuation to set.
*/
void setQuadricAttenuation(double QuadricAttenuation);
public:
/** \details
Default constructor for the IfcLightSourcePositional class.
*/
IfcLightSourcePositional();
/** \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_Position; // IfcCartesianPoint
IfcPositiveLengthMeasure m_Radius; // IfcPositiveLengthMeasure
double m_ConstantAttenuation; // IfcReal
double m_DistanceAttenuation; // IfcReal
double m_QuadricAttenuation; // IfcReal
};
/** \details
A data type that represents a smart pointer to a IfcLightSourcePositional object.
*/
typedef OdSmartPtr IfcLightSourcePositionalPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4_IFCLIGHTSOURCEPOSITIONAL_AUTO_IMPL_H