#include <IfcLightSourceSpotAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcLightSourceSpot:

Public Member Functions
const OdDAIObjectId &	getOrientation () const

void	setOrientation (const OdDAIObjectId &Orientation)

double	getConcentrationExponent () const

void	setConcentrationExponent (double ConcentrationExponent)

double	getSpreadAngle () const

void	setSpreadAngle (double SpreadAngle)

double	getBeamWidthAngle () const

void	setBeamWidthAngle (double BeamWidthAngle)

	IfcLightSourceSpot ()

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 OdIfc4x4::IfcLightSourcePositional
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 ()

Public Member Functions inherited from OdIfc4x4::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 OdIfc4x4::IfcRepresentationItem
void	getInvLayerAssignment (OdDAIObjectIds &LayerAssignment) const

void	getInvStyledByItem (OdDAIObjectIds &StyledByItem) const

Public Member Functions inherited from OdIfc4x4::OdIFC4X4Instance
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_Orientation

double	m_ConcentrationExponent

IfcPositivePlaneAngleMeasure	m_SpreadAngle

IfcPositivePlaneAngleMeasure	m_BeamWidthAngle

Protected Attributes inherited from OdIfc4x4::IfcLightSourcePositional
OdDAIObjectId	m_Position

IfcPositiveLengthMeasure	m_Radius

double	m_ConstantAttenuation

double	m_DistanceAttenuation

double	m_QuadricAttenuation

Protected Attributes inherited from OdIfc4x4::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 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:

Definition at line 49 of file IFC4X4/IfcLightSourceSpotAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcLightSourceSpot()

OdIfc4x4::IfcLightSourceSpot::IfcLightSourceSpot ( )

Default constructor for the IfcLightSourceSpot class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcLightSourceSpot::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 OdIfc4x4::IfcLightSourcePositional.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcLightSourceSpot::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 OdIfc4x4::IfcLightSourcePositional.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcLightSourceSpot::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 OdIfc4x4::IfcLightSourcePositional.

◆ getBeamWidthAngle()

double OdIfc4x4::IfcLightSourceSpot::getBeamWidthAngle ( ) const

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.

◆ getConcentrationExponent()

double OdIfc4x4::IfcLightSourceSpot::getConcentrationExponent ( ) const

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.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcLightSourceSpot::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 OdIfc4x4::IfcLightSourcePositional.

◆ getOrientation()

const OdDAIObjectId & OdIfc4x4::IfcLightSourceSpot::getOrientation ( ) const

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.

◆ getSpreadAngle()

double OdIfc4x4::IfcLightSourceSpot::getSpreadAngle ( ) const

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.

◆ inFields()

virtual OdResult OdIfc4x4::IfcLightSourceSpot::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 OdIfc4x4::IfcLightSourcePositional.

◆ isKindOf()

virtual bool OdIfc4x4::IfcLightSourceSpot::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 OdIfc4x4::IfcLightSourcePositional.

◆ outFields()

virtual OdResult OdIfc4x4::IfcLightSourceSpot::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 OdIfc4x4::IfcLightSourcePositional.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcLightSourceSpot::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 OdIfc4x4::IfcLightSourcePositional.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcLightSourceSpot::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 OdIfc4x4::IfcLightSourcePositional.

◆ setBeamWidthAngle()

void OdIfc4x4::IfcLightSourceSpot::setBeamWidthAngle ( double BeamWidthAngle )

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).

Parameters

BeamWidthAngle [in] Beam width angle to set.

◆ setConcentrationExponent()

void OdIfc4x4::IfcLightSourceSpot::setConcentrationExponent ( double ConcentrationExponent )

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.

Parameters

ConcentrationExponent [in] Concentration exponent to set.

◆ setOrientation()

void OdIfc4x4::IfcLightSourceSpot::setOrientation ( const OdDAIObjectId & Orientation )

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.

Parameters

Orientation [in] Orientation to set.

◆ setSpreadAngle()

void OdIfc4x4::IfcLightSourceSpot::setSpreadAngle ( double SpreadAngle )

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).

Parameters

SpreadAngle [in] Spread angle to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcLightSourceSpot::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 OdIfc4x4::IfcLightSourcePositional.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcLightSourceSpot::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 OdIfc4x4::IfcLightSourcePositional.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcLightSourceSpot::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 OdIfc4x4::IfcLightSourcePositional.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcLightSourceSpot::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc4x4::IfcLightSourcePositional.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcLightSourceSpot::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef )

overridevirtual

Resets a value for the specified attribute.

Parameters

explicitAttrDef [in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc4x4::IfcLightSourcePositional.

Member Data Documentation

◆ m_BeamWidthAngle

IfcPositivePlaneAngleMeasure OdIfc4x4::IfcLightSourceSpot::m_BeamWidthAngle

protected

Definition at line 267 of file IFC4X4/IfcLightSourceSpotAutoImpl.h.

◆ m_ConcentrationExponent

double OdIfc4x4::IfcLightSourceSpot::m_ConcentrationExponent

protected

Definition at line 265 of file IFC4X4/IfcLightSourceSpotAutoImpl.h.

◆ m_Orientation

OdDAIObjectId OdIfc4x4::IfcLightSourceSpot::m_Orientation

protected

Definition at line 264 of file IFC4X4/IfcLightSourceSpotAutoImpl.h.

◆ m_SpreadAngle

IfcPositivePlaneAngleMeasure OdIfc4x4::IfcLightSourceSpot::m_SpreadAngle

protected

Definition at line 266 of file IFC4X4/IfcLightSourceSpotAutoImpl.h.

The documentation for this class was generated from the following file:

IFC4X4/IfcLightSourceSpotAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcLightSourceSpot()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getBeamWidthAngle()

◆ getConcentrationExponent()

◆ getInstanceType()

◆ getOrientation()

◆ getSpreadAngle()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setBeamWidthAngle()

◆ setConcentrationExponent()

◆ setOrientation()

◆ setSpreadAngle()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_BeamWidthAngle

◆ m_ConcentrationExponent

◆ m_Orientation

◆ m_SpreadAngle