#include <IfcSurfaceStyleLightingAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcSurfaceStyleLighting:

Public Member Functions
const OdDAIObjectId &	getDiffuseTransmissionColour () const

void	setDiffuseTransmissionColour (const OdDAIObjectId &DiffuseTransmissionColour)

const OdDAIObjectId &	getDiffuseReflectionColour () const

void	setDiffuseReflectionColour (const OdDAIObjectId &DiffuseReflectionColour)

const OdDAIObjectId &	getTransmissionColour () const

void	setTransmissionColour (const OdDAIObjectId &TransmissionColour)

const OdDAIObjectId &	getReflectanceColour () const

void	setReflectanceColour (const OdDAIObjectId &ReflectanceColour)

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 OdIfc2x3::OdIfc2x3Instance
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_DiffuseTransmissionColour

OdDAIObjectId	m_DiffuseReflectionColour

OdDAIObjectId	m_TransmissionColour

OdDAIObjectId	m_ReflectanceColour

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

IfcSurfaceStyleLighting is a container class for properties for calculation of physically exact illuminance related to a particular surface style. The next image shows the reflection and transmission components from an incident ray.

Details -

The sum of the components for reflection and transmission is a value of 1.0 denoting that the incident ray is completely decomposed into reflection and transmission components. Each value of reflection and transmission is therefore within the range 0.0 to 1.0.

All these factors can be measured physically and are ratios for the red, green and blue part of the light. These properties are defined in the model as Type IfcColorRGB with a factor for each colour. EXAMPLE: A green glass transmits only green light, so its transmission factor is 0.0 for red, between 0.0 and 1.0 for green and 0.0 for blue. A green surface reflects only green light, so the reflectance factor is 0.0 for red, between 0.0 and 1.0 for green and 0.0 for blue.

Definition at line 58 of file Ifc2x3/IfcSurfaceStyleLightingAutoImpl.h.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcSurfaceStyleLighting::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.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcSurfaceStyleLighting::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.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcSurfaceStyleLighting::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 OdIfc::OdIfcInstance.

◆ getDiffuseReflectionColour()

const OdDAIObjectId & OdIfc2x3::IfcSurfaceStyleLighting::getDiffuseReflectionColour ( ) const

Returns the value of DiffuseReflectionColour attribute. DiffuseReflectionColour is the degree of diffusion of the reflected light. In the case of specular surfaces there is no diffusion. The greater the diffusing power of the reflecting surface, the smaller the specular component of the reflected light, up to the point where only diffuse light is produced. A value of 1 means totally diffuse for that colour part of the light.

Returns: Returns the value of DiffuseReflectionColour attribute.

Remarks: The factor can be measured physically and has three ratios for the red, green and blue part of the light.

◆ getDiffuseTransmissionColour()

const OdDAIObjectId & OdIfc2x3::IfcSurfaceStyleLighting::getDiffuseTransmissionColour ( ) const

Returns the value of DiffuseTransmissionColour attribute. DiffuseTransmissionColour is the degree of diffusion of the transmitted light. In the case of completely transparent materials there is no diffusion. The greater the diffusing power, the smaller the direct component of the transmitted light, up to the point where only diffuse light is produced. A value of 1 means totally diffuse for that colour part of the light.

Returns: Returns the value of DiffuseTransmissionColour attribute.

Remarks: The factor can be measured physically and has three ratios for the red, green and blue part of the light.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcSurfaceStyleLighting::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.

◆ getReflectanceColour()

const OdDAIObjectId & OdIfc2x3::IfcSurfaceStyleLighting::getReflectanceColour ( ) const

Returns the value of ReflectanceColour attribute. This attribute is a coefficient that determines the extent that the light falling onto a surface is fully or partially reflected.

Returns: Returns the value of ReflectanceColour attribute.

Remarks: The factor can be measured physically and has three ratios for the red, green and blue part of the light.

◆ getTransmissionColour()

const OdDAIObjectId & OdIfc2x3::IfcSurfaceStyleLighting::getTransmissionColour ( ) const

Returns the value of TransmissionColour attribute. This attribute describes how the light falling on a body is totally or partially transmitted.

Returns: Returns the value of TransmissionColour attribute.

Remarks: The factor can be measured physically and has three ratios for the red, green and blue part of the light.

◆ inFields()

virtual OdResult OdIfc2x3::IfcSurfaceStyleLighting::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.

◆ isKindOf()

virtual bool OdIfc2x3::IfcSurfaceStyleLighting::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 OdIfc::OdIfcInstance.

◆ outFields()

virtual OdResult OdIfc2x3::IfcSurfaceStyleLighting::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.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcSurfaceStyleLighting::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.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcSurfaceStyleLighting::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 OdIfc::OdIfcInstance.

◆ setDiffuseReflectionColour()

void OdIfc2x3::IfcSurfaceStyleLighting::setDiffuseReflectionColour ( const OdDAIObjectId & DiffuseReflectionColour )

Sets the value of DiffuseReflectionColour attribute. DiffuseReflectionColour is the degree of diffusion of the reflected light. In the case of specular surfaces there is no diffusion. The greater the diffusing power of the reflecting surface, the smaller the specular component of the reflected light, up to the point where only diffuse light is produced. A value of 1 means totally diffuse for that colour part of the light.

Parameters

DiffuseReflectionColour [in] Diffuse reflection colour to set.

Remarks: The factor can be measured physically and has three ratios for the red, green and blue part of the light.

◆ setDiffuseTransmissionColour()

void OdIfc2x3::IfcSurfaceStyleLighting::setDiffuseTransmissionColour ( const OdDAIObjectId & DiffuseTransmissionColour )

Sets the value of DiffuseTransmissionColour attribute. DiffuseTransmissionColour is the degree of diffusion of the transmitted light. In the case of completely transparent materials there is no diffusion. The greater the diffusing power, the smaller the direct component of the transmitted light, up to the point where only diffuse light is produced. A value of 1 means totally diffuse for that colour part of the light.

Parameters

DiffuseTransmissionColour [in] Diffuse transmission colour to set.

Remarks: The factor can be measured physically and has three ratios for the red, green and blue part of the light.

◆ setReflectanceColour()

void OdIfc2x3::IfcSurfaceStyleLighting::setReflectanceColour ( const OdDAIObjectId & ReflectanceColour )

Sets the value of ReflectanceColour attribute. This attribute is a coefficient that determines the extent that the light falling onto a surface is fully or partially reflected.

Parameters

ReflectanceColour [in] Reflectance colour to set.

Remarks: The factor can be measured physically and has three ratios for the red, green and blue part of the light.

◆ setTransmissionColour()

void OdIfc2x3::IfcSurfaceStyleLighting::setTransmissionColour ( const OdDAIObjectId & TransmissionColour )

Returns the value of TransmissionColour attribute. This attribute describes how the light falling on a body is totally or partially transmitted.

Parameters

TransmissionColour [in] Transmission colour to set.

Remarks: The factor can be measured physically and has three ratios for the red, green and blue part of the light.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcSurfaceStyleLighting::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 OdIfc::OdIfcInstance.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcSurfaceStyleLighting::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 OdIfc::OdIfcInstance.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcSurfaceStyleLighting::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 OdIfc::OdIfcInstance.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcSurfaceStyleLighting::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

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

Reimplemented from OdIfc::OdIfcInstance.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcSurfaceStyleLighting::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 OdIfc::OdIfcInstance.

Member Data Documentation

◆ m_DiffuseReflectionColour

OdDAIObjectId OdIfc2x3::IfcSurfaceStyleLighting::m_DiffuseReflectionColour

protected

Definition at line 289 of file Ifc2x3/IfcSurfaceStyleLightingAutoImpl.h.

◆ m_DiffuseTransmissionColour

OdDAIObjectId OdIfc2x3::IfcSurfaceStyleLighting::m_DiffuseTransmissionColour

protected

Definition at line 288 of file Ifc2x3/IfcSurfaceStyleLightingAutoImpl.h.

◆ m_ReflectanceColour

OdDAIObjectId OdIfc2x3::IfcSurfaceStyleLighting::m_ReflectanceColour

protected

Definition at line 291 of file Ifc2x3/IfcSurfaceStyleLightingAutoImpl.h.

◆ m_TransmissionColour

OdDAIObjectId OdIfc2x3::IfcSurfaceStyleLighting::m_TransmissionColour

protected

Definition at line 290 of file Ifc2x3/IfcSurfaceStyleLightingAutoImpl.h.

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

Ifc2x3/IfcSurfaceStyleLightingAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getDiffuseReflectionColour()

◆ getDiffuseTransmissionColour()

◆ getInstanceType()

◆ getReflectanceColour()

◆ getTransmissionColour()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setDiffuseReflectionColour()

◆ setDiffuseTransmissionColour()

◆ setReflectanceColour()

◆ setTransmissionColour()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_DiffuseReflectionColour

◆ m_DiffuseTransmissionColour

◆ m_ReflectanceColour

◆ m_TransmissionColour