#include <IfcLightSourceAutoImpl.h>

Inheritance diagram for OdIfc4x1::IfcLightSource:

Public Member Functions
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 ()

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 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 OdIfc4x1::IfcRepresentationItem
void	getInvLayerAssignment (OdDAIObjectIds &LayerAssignment) const

void	getInvStyledByItem (OdDAIObjectIds &StyledByItem) const

Public Member Functions inherited from OdIfc4x1::OdIfc4x1Instance
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
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 entity is determined by the reflectance specified in the surface style rendering. Lighting is applied on a surface by surface basis: no interactions between surfaces such as shadows or reflections are defined.

Remarks: This definition may not be instantiated.

Definition at line 45 of file Ifc4x1/IfcLightSourceAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcLightSource()

OdIfc4x1::IfcLightSource::IfcLightSource ( )

Default constructor for the IfcLightSource class.

Member Function Documentation

◆ getAmbientIntensity()

double OdIfc4x1::IfcLightSource::getAmbientIntensity ( ) const

Returns the value of AmbientIntensity attribute. This attribute represents the intensity of the ambient emission from the light. Light intensity can range from 0.0 (no light emission) to 1.0 (full intensity).

Returns: Returns the value of AmbientIntensity attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x1::IfcLightSource::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 in OdIfc4x1::IfcLightSourceDirectional, OdIfc4x1::IfcLightSourceGoniometric, OdIfc4x1::IfcLightSourcePositional, and OdIfc4x1::IfcLightSourceSpot.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x1::IfcLightSource::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 OdIfc4x1::IfcRepresentationItem.

Reimplemented in OdIfc4x1::IfcLightSourceDirectional, OdIfc4x1::IfcLightSourceGoniometric, OdIfc4x1::IfcLightSourcePositional, and OdIfc4x1::IfcLightSourceSpot.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x1::IfcLightSource::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 OdIfc4x1::IfcGeometricRepresentationItem.

Reimplemented in OdIfc4x1::IfcLightSourceAmbient, OdIfc4x1::IfcLightSourceDirectional, OdIfc4x1::IfcLightSourceGoniometric, OdIfc4x1::IfcLightSourcePositional, and OdIfc4x1::IfcLightSourceSpot.

◆ getIntensity()

double OdIfc4x1::IfcLightSource::getIntensity ( ) const

Returns the value of Intensity attribute. This attribute represents the brightness of the direct emission from the ligth. Light intensity can range from 0.0 (no light emission) to 1.0 (full intensity).

Returns: Returns the value of Intensity attribute.

◆ getLightColour()

const OdDAIObjectId & OdIfc4x1::IfcLightSource::getLightColour ( ) const

Returns the value of LightColour attribute. This attribute represents the colour of the light to be used for shading.

Returns: Returns the value of LightColour attribute.

◆ getName()

const OdAnsiString & OdIfc4x1::IfcLightSource::getName ( ) const

Returns the value of Name attribute. This attribute represents the name specified to the light source in presentation.

Returns: Returns the value of Name attribute.

◆ inFields()

virtual OdResult OdIfc4x1::IfcLightSource::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 OdIfc4x1::IfcRepresentationItem.

Reimplemented in OdIfc4x1::IfcLightSourceDirectional, OdIfc4x1::IfcLightSourceGoniometric, OdIfc4x1::IfcLightSourcePositional, and OdIfc4x1::IfcLightSourceSpot.

◆ isKindOf()

virtual bool OdIfc4x1::IfcLightSource::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 OdIfc4x1::IfcGeometricRepresentationItem.

Reimplemented in OdIfc4x1::IfcLightSourceAmbient, OdIfc4x1::IfcLightSourceDirectional, OdIfc4x1::IfcLightSourceGoniometric, OdIfc4x1::IfcLightSourcePositional, and OdIfc4x1::IfcLightSourceSpot.

◆ outFields()

virtual OdResult OdIfc4x1::IfcLightSource::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 OdIfc4x1::IfcRepresentationItem.

Reimplemented in OdIfc4x1::IfcLightSourceDirectional, OdIfc4x1::IfcLightSourceGoniometric, OdIfc4x1::IfcLightSourcePositional, and OdIfc4x1::IfcLightSourceSpot.

◆ putAttr() [1/2]

virtual bool OdIfc4x1::IfcLightSource::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc4x1::IfcLightSourceDirectional, OdIfc4x1::IfcLightSourceGoniometric, OdIfc4x1::IfcLightSourcePositional, and OdIfc4x1::IfcLightSourceSpot.

◆ putAttr() [2/2]

virtual bool OdIfc4x1::IfcLightSource::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 OdIfc4x1::IfcRepresentationItem.

Reimplemented in OdIfc4x1::IfcLightSourceDirectional, OdIfc4x1::IfcLightSourceGoniometric, OdIfc4x1::IfcLightSourcePositional, and OdIfc4x1::IfcLightSourceSpot.

◆ setAmbientIntensity()

void OdIfc4x1::IfcLightSource::setAmbientIntensity ( double AmbientIntensity )

Returns the value of AmbientIntensity attribute. This attribute represents the intensity of the ambient emission from the light. Light intensity can range from 0.0 (no light emission) to 1.0 (full intensity).

Parameters

AmbientIntensity [in] Ambient intensity to set.

◆ setIntensity()

void OdIfc4x1::IfcLightSource::setIntensity ( double Intensity )

Returns the value of Intensity attribute. This attribute represents the brightness of the direct emission from the ligth. Light intensity can range from 0.0 (no light emission) to 1.0 (full intensity).

Parameters

Intensity [in] Intensity to set.

◆ setLightColour()

void OdIfc4x1::IfcLightSource::setLightColour ( const OdDAIObjectId & LightColour )

Sets the value of LightColour attribute. This attribute represents the colour of the light to be used for shading.

Parameters

LightColour [in] Light colour to set.

◆ setName()

void OdIfc4x1::IfcLightSource::setName ( const OdAnsiString & Name )

Sets the value of Name attribute. This attribute represents the name specified to the light source in presentation.

Parameters

Name	[in] Name to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x1::IfcLightSource::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 OdIfc4x1::IfcRepresentationItem.

Reimplemented in OdIfc4x1::IfcLightSourceDirectional, OdIfc4x1::IfcLightSourceGoniometric, OdIfc4x1::IfcLightSourcePositional, and OdIfc4x1::IfcLightSourceSpot.

◆ testAttr() [2/2]

virtual bool OdIfc4x1::IfcLightSource::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 OdIfc4x1::IfcRepresentationItem.

Reimplemented in OdIfc4x1::IfcLightSourceDirectional, OdIfc4x1::IfcLightSourceGoniometric, OdIfc4x1::IfcLightSourcePositional, and OdIfc4x1::IfcLightSourceSpot.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x1::IfcLightSource::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 OdIfc4x1::IfcGeometricRepresentationItem.

Reimplemented in OdIfc4x1::IfcLightSourceAmbient, OdIfc4x1::IfcLightSourceDirectional, OdIfc4x1::IfcLightSourceGoniometric, OdIfc4x1::IfcLightSourcePositional, and OdIfc4x1::IfcLightSourceSpot.