#include <IfcLightSourcePositionalAutoImpl.h>

Inheritance diagram for OdIfc4::IfcLightSourcePositional:

Public Member Functions
const OdDAIObjectId &	getPosition () const

void	setPosition (const OdDAIObjectId &Position)

double	getRadius () const

void	setRadius (double Radius)

double	getConstantAttenuation () const

void	setConstantAttenuation (double ConstantAttenuation)

double	getDistanceAttenuation () const

void	setDistanceAttenuation (double DistanceAttenuation)

double	getQuadricAttenuation () const

void	setQuadricAttenuation (double QuadricAttenuation)

	IfcLightSourcePositional ()

virtual OdResult	inFields (OdDAI::OdSpfFilerBase *rdFiler) override

virtual OdResult	outFields (OdDAI::OdSpfFilerBase *wrFiler) override

virtual OdDAI::Entity *	getInstanceType () const override

virtual OdRxValue	getAttr (const char *attrName) const override

virtual bool	comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override

virtual void	unsetAttr (const char *explicitAttrName) override

virtual bool	testAttr (const char *explicitAttrName) const override

virtual bool	putAttr (const char *explicitAttrName, const OdRxValue &val) override

virtual bool	isKindOf (OdIfc::OdIfcEntityType entityType) const override

virtual OdIfc::OdIfcEntityType	type () const override

virtual OdRxValue	getAttr (const OdIfc::OdIfcAttribute attrDef) const override

virtual void	unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef) override

virtual bool	testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const override

virtual bool	putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override

Public Member Functions inherited from OdIfc4::IfcLightSource
const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

const OdDAIObjectId &	getLightColour () const

void	setLightColour (const OdDAIObjectId &LightColour)

double	getAmbientIntensity () const

void	setAmbientIntensity (double AmbientIntensity)

double	getIntensity () const

void	setIntensity (double Intensity)

	IfcLightSource ()

Public Member Functions inherited from OdIfc4::IfcRepresentationItem
void	getInvLayerAssignment (OdDAIObjectIds &LayerAssignment) const

void	getInvStyledByItem (OdDAIObjectIds &StyledByItem) const

Public Member Functions inherited from OdIfc4::OdIfc4Instance
void	setInverseCounterParts () override

Public Member Functions inherited from OdIfc::OdIfcInstance
	ODRX_DECLARE_MEMBERS (OdIfcInstance)

	OdIfcInstance ()

	~OdIfcInstance ()

bool	isInstanceOf (OdIfcEntityType entityType) const

IfcOpResult	resolved ()

void	resolve (IfcOpResult resolved, void *resPtr)

void	unresolve ()

virtual void	setGsNode (OdGsCache *pGsNode)

virtual OdGsCache *	gsNode () const

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const

virtual bool	subWorldDraw (OdGiWorldDraw *wd) const

virtual OdDbStub *	ownerId () const

Protected Attributes
OdDAIObjectId	m_Position

IfcPositiveLengthMeasure	m_Radius

double	m_ConstantAttenuation

double	m_DistanceAttenuation

double	m_QuadricAttenuation

Protected Attributes inherited from OdIfc4::IfcLightSource
OdAnsiString	m_Name

OdDAIObjectId	m_LightColour

IfcNormalisedRatioMeasure	m_AmbientIntensity

IfcNormalisedRatioMeasure	m_Intensity

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Additional Inherited Members
Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3d *	asPoint3d (const OdIfcInstance *inst)

static const OdGePoint2d *	asPoint2d (const OdIfcInstance *inst)

static const OdGeVector3d *	asVector3d (const OdIfcInstance *inst)

static const OdGeVector2d *	asVector2d (const OdIfcInstance *inst)

static const OdGeMatrix2d *	asMatrix2d (const OdIfcInstance *inst)

static const OdGeMatrix3d *	asMatrix3d (const OdIfcInstance *inst)

static OdIfcCompoundPtr	asCompound (OdSmartPtr< OdIfcInstance > inst)

static const OdCmEntityColor *	asRgbColor (const OdIfcInstance *inst)

Detailed Description

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 &pre; 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.

Definition at line 50 of file Ifc4/IfcLightSourcePositionalAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcLightSourcePositional()

OdIfc4::IfcLightSourcePositional::IfcLightSourcePositional ( )

Default constructor for the IfcLightSourcePositional class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcLightSourcePositional::comparedToEarlyImpl	(	const OdDAI::ApplicationInstance *	pOther,
		OdRx::Ordering &	ordering ) const

overridevirtual

Early-bound version of instances comparison.

Parameters

pOther	[in] Other application instance.
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:

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.

Reimplemented from OdIfc4::IfcLightSource.

Reimplemented in OdIfc4::IfcLightSourceSpot.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcLightSourcePositional::getAttr ( const char * attrName ) const

overridevirtual

Returns an attribute value for the specified attribute name.

Parameters

attrName [in] Name of an attribute to query.

Returns: OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc4::IfcLightSource.

Reimplemented in OdIfc4::IfcLightSourceSpot.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcLightSourcePositional::getAttr ( const OdIfc::OdIfcAttribute attrDef ) const

overridevirtual

Returns an attribute value for the specified attribute definition.

Parameters

attrDef [in] Attribute definition to query.

Returns: OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc4::IfcLightSource.

Reimplemented in OdIfc4::IfcLightSourceSpot.

◆ getConstantAttenuation()

double OdIfc4::IfcLightSourcePositional::getConstantAttenuation ( ) const

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.

◆ getDistanceAttenuation()

double OdIfc4::IfcLightSourcePositional::getDistanceAttenuation ( ) const

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.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcLightSourcePositional::getInstanceType ( ) const

overridevirtual

Returns a type of a class instance.

Returns: Pointer to the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdDAI__Entity.html>>OdDAI::Entity</exref> type that determines an entity definition within a schema.

Reimplemented from OdIfc4::IfcLightSource.

Reimplemented in OdIfc4::IfcLightSourceSpot.

◆ getPosition()

const OdDAIObjectId & OdIfc4::IfcLightSourcePositional::getPosition ( ) const

Returns the value of Position attribute. The Cartesian point represents the position of the light source.

Returns: Returns the value of Position attribute.

◆ getQuadricAttenuation()

double OdIfc4::IfcLightSourcePositional::getQuadricAttenuation ( ) const

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.

◆ getRadius()

double OdIfc4::IfcLightSourcePositional::getRadius ( ) const

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.

◆ inFields()

virtual OdResult OdIfc4::IfcLightSourcePositional::inFields ( OdDAI::OdSpfFilerBase * rdFiler )

overridevirtual

Reads object's data from the specified filer.

Parameters

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.

Reimplemented from OdIfc4::IfcLightSource.

Reimplemented in OdIfc4::IfcLightSourceSpot.

◆ isKindOf()

virtual bool OdIfc4::IfcLightSourcePositional::isKindOf ( OdIfc::OdIfcEntityType entityType ) const

overridevirtual

Checks whether the specified instance is the object derived from or belongs to this class.

Parameters

entityType [in] Entity to check.

Returns: true if the specified instance is the object derived from or belongs to this class, false otherwise.

Reimplemented from OdIfc4::IfcLightSource.

Reimplemented in OdIfc4::IfcLightSourceSpot.

◆ outFields()

virtual OdResult OdIfc4::IfcLightSourcePositional::outFields ( OdDAI::OdSpfFilerBase * wrFiler )

overridevirtual

Writes object's data the the specified filer.

Parameters

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.

Reimplemented from OdIfc4::IfcLightSource.

Reimplemented in OdIfc4::IfcLightSourceSpot.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcLightSourcePositional::putAttr	(	const char *	explicitAttrName,
		const OdRxValue &	val )

overridevirtual

Sets the specified attribute with a given value.

Parameters

explicitAttrName	[in] Explicit name of the attribute to set.
val	[in] Value to set.

Returns: true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc4::IfcLightSource.

Reimplemented in OdIfc4::IfcLightSourceSpot.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcLightSourcePositional::putAttr	(	const OdIfc::OdIfcAttribute	explicitAttrDef,
		const OdRxValue &	val )

overridevirtual

Sets the specified attribute with a given value.

Parameters

explicitAttrDef	[in] Explicit attribute definition to set.
val	[in] Value to set.

Returns: true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc4::IfcLightSource.

Reimplemented in OdIfc4::IfcLightSourceSpot.

◆ setConstantAttenuation()

void OdIfc4::IfcLightSourcePositional::setConstantAttenuation ( double ConstantAttenuation )

Sets the value of ConstantAttenuation attribute. This attribute represents a value of the attenuation in the lighting equation that is constant.

Parameters

ConstantAttenuation [in] ConstantAttenuation attribute to set.

◆ setDistanceAttenuation()

void OdIfc4::IfcLightSourcePositional::setDistanceAttenuation ( double DistanceAttenuation )

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.

Parameters

DistanceAttenuation [in] Distance attenuation to set.

◆ setPosition()

void OdIfc4::IfcLightSourcePositional::setPosition ( const OdDAIObjectId & Position )

Sets the value of Position attribute. The Cartesian point represents the position of the light source.

Parameters

Position [in] Position to set.

◆ setQuadricAttenuation()

void OdIfc4::IfcLightSourcePositional::setQuadricAttenuation ( double QuadricAttenuation )

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.

Parameters

QuadricAttenuation [in] Quadric attenuation to set.

◆ setRadius()

void OdIfc4::IfcLightSourcePositional::setRadius ( double Radius )

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.

Parameters

Radius [in] Radius to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcLightSourcePositional::testAttr ( const char * explicitAttrName ) const

overridevirtual

Checks whether the specified attribute is set.

Parameters

explicitAttrName [in] Explicit name of the attribute to test.

Returns: true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc4::IfcLightSource.

Reimplemented in OdIfc4::IfcLightSourceSpot.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcLightSourcePositional::testAttr ( const OdIfc::OdIfcAttribute explicitAttrDef ) const

overridevirtual

Checks whether the specified attribute is set.

Parameters

explicitAttrDef [in] Attribute definition to test.

Returns: true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc4::IfcLightSource.

Reimplemented in OdIfc4::IfcLightSourceSpot.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcLightSourcePositional::type ( ) const

overridevirtual

Returns the type of this entity.

Returns: A value of the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdIfc__OdIfcEntityType.html>>OdIfc::OdIfcEntityType</exref> type that represents type of this entity.

Reimplemented from OdIfc4::IfcLightSource.

Reimplemented in OdIfc4::IfcLightSourceSpot.