#include <IfcSurfaceStyleRenderingAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcSurfaceStyleRendering:

Public Member Functions
IfcColourOrFactor	diffuseColour ()

IfcColourOrFactor	transmissionColour ()

IfcColourOrFactor	diffuseTransmissionColour ()

IfcColourOrFactor	reflectionColour ()

IfcColourOrFactor	specularColour ()

IfcSpecularHighlightSelect	specularHighlight ()

IfcReflectanceMethodEnum	getReflectanceMethod () const

void	setReflectanceMethod (IfcReflectanceMethodEnum ReflectanceMethod)

	IfcSurfaceStyleRendering ()

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::IfcSurfaceStyleShading
const OdDAIObjectId &	getSurfaceColour () const

void	setSurfaceColour (const OdDAIObjectId &SurfaceColour)

double	getTransparency () const

void	setTransparency (double Transparency)

	IfcSurfaceStyleShading ()

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
OdDAI::Select	m_DiffuseColour

OdDAI::Select	m_TransmissionColour

OdDAI::Select	m_DiffuseTransmissionColour

OdDAI::Select	m_ReflectionColour

OdDAI::Select	m_SpecularColour

OdDAI::Select	m_SpecularHighlight

OdDAI::Enum	m_ReflectanceMethod

Protected Attributes inherited from OdIfc4x4::IfcSurfaceStyleShading
OdDAIObjectId	m_SurfaceColour

IfcNormalisedRatioMeasure	m_Transparency

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

IfcSurfaceStyleRendering holds the properties for visualization related to a particular surface side style. Three lighting models are supported: Phong lighting model Physically-based lighting model Flat lighting model that ignores light sources

The material parameters are specified as scalars or RGB colors. Every material parameter can be adjusted using a texture. This allows to vary this parameter across the surface.

\changes

IFC4X3_RC1 changes: Attribute DiffuseTransmissionColour is now deprecated Attribute ReflectionColour is now deprecated Attribute TransmissionColour is now deprecated

Definition at line 54 of file IFC4X4/IfcSurfaceStyleRenderingAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcSurfaceStyleRendering()

OdIfc4x4::IfcSurfaceStyleRendering::IfcSurfaceStyleRendering ( )

Default constructor for the IfcSurfaceStyleRendering class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcSurfaceStyleRendering::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::IfcSurfaceStyleShading.

◆ diffuseColour()

IfcColourOrFactor OdIfc4x4::IfcSurfaceStyleRendering::diffuseColour ( )

Returns the value of DiffuseColour attribute. This attribute represents the diffuse color part of the reflectance. The diffuse colour field reflects all light sources depending on the angle of the surface with respect to the light source. The more directly the surface faces the light, the more diffuse light reflects. The diffuse colour is then defined by surface colour * diffuse factor.

Returns: Returns the value of DiffuseColour attribute.

◆ diffuseTransmissionColour()

IfcColourOrFactor OdIfc4x4::IfcSurfaceStyleRendering::diffuseTransmissionColour ( )

Returns the value of DiffuseTransmissionColour attribute. This attribute represents the diffuse transmission color part of the reflectance. It only applies to materials where Transparency field is greater than zero. The diffuse transmission colour specifies how much diffuse light is reflected at the opposite side of the material surface. The diffuse transmission factor field specifies how much diffuse light from light sources this surface reflects on the opposite side of the material surface. The diffuse transmissive colour is then defined by surface colour * diffuse transmissive factor.

Returns: Returns the value of DiffuseTransmissionColour attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcSurfaceStyleRendering::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::IfcSurfaceStyleShading.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcSurfaceStyleRendering::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::IfcSurfaceStyleShading.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcSurfaceStyleRendering::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::IfcSurfaceStyleShading.

◆ getReflectanceMethod()

IfcReflectanceMethodEnum OdIfc4x4::IfcSurfaceStyleRendering::getReflectanceMethod ( ) const

Returns the value of ReflectanceMethod attribute. This attribute represents the predefined types of reflectance method from which the required method can be set.

Returns: Returns the value of ReflectanceMethod attribute.

◆ inFields()

virtual OdResult OdIfc4x4::IfcSurfaceStyleRendering::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::IfcSurfaceStyleShading.

◆ isKindOf()

virtual bool OdIfc4x4::IfcSurfaceStyleRendering::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::IfcSurfaceStyleShading.

◆ outFields()

virtual OdResult OdIfc4x4::IfcSurfaceStyleRendering::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::IfcSurfaceStyleShading.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcSurfaceStyleRendering::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::IfcSurfaceStyleShading.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcSurfaceStyleRendering::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::IfcSurfaceStyleShading.

◆ reflectionColour()

IfcColourOrFactor OdIfc4x4::IfcSurfaceStyleRendering::reflectionColour ( )

Returns the value of ReflectionColour attribute. This attribute represents the reflection (or mirror) color part of the reflectance. Applies to "glass" and "mirror" reflection models. The reflection colour specifies the contribution made by light from the mirror direction, i.e. light being reflected from the surface. The reflection factor specifies the amount of contribution made by light from the mirror direction. The reflection colour is then defined by surface colour * reflection factor.

Returns: Returns the value of ReflectionColour attribute.

◆ setReflectanceMethod()

void OdIfc4x4::IfcSurfaceStyleRendering::setReflectanceMethod ( IfcReflectanceMethodEnum ReflectanceMethod )

Sets the value of ReflectanceMethod attribute. This attribute represents the predefined types of reflectance method from which the required method can be set.

Parameters

ReflectanceMethod [in] Reflectance method to set.

◆ specularColour()

IfcColourOrFactor OdIfc4x4::IfcSurfaceStyleRendering::specularColour ( )

Returns the value of SpecularColour attribute. This attribute represents the specular color part of the reflectance. The specular colour determines the specular highlights (e.g., the shiny spots on an apple). When the angle from the light to the surface is close to the angle from the surface to the viewer, the specular colour is added to the diffuse and ambient colour calculations. The specular factor defines the specular part, the specular colour is then defined by surface colour * specular factor.

Returns: Returns the value of SpecularColour attribute.

◆ specularHighlight()

IfcSpecularHighlightSelect OdIfc4x4::IfcSurfaceStyleRendering::specularHighlight ( )

Returns the value of SpecularHighlight attribute. This attribute represents the exponent or roughness part of the specular reflectance.

Returns: Returns the value of SpecularHighlight attribute.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcSurfaceStyleRendering::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::IfcSurfaceStyleShading.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcSurfaceStyleRendering::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::IfcSurfaceStyleShading.

◆ transmissionColour()

IfcColourOrFactor OdIfc4x4::IfcSurfaceStyleRendering::transmissionColour ( )

Returns the value of TransmissionColour attribute. This attribute represents the transmissive color part of the reflectance. It only applies to materials where Transparency field is greater than zero. The transmissive colour field specifies the colour that passes through a transparant material (like the colour that shines through a glass). The transmissive factor defines the transmissive part, the transmissive colour is then defined by surface colour * transmissive factor.

Returns: Returns the value of TransmissionColour attribute.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcSurfaceStyleRendering::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::IfcSurfaceStyleShading.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcSurfaceStyleRendering::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::IfcSurfaceStyleShading.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcSurfaceStyleRendering::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::IfcSurfaceStyleShading.

Member Data Documentation

◆ m_DiffuseColour

OdDAI::Select OdIfc4x4::IfcSurfaceStyleRendering::m_DiffuseColour

protected

Definition at line 278 of file IFC4X4/IfcSurfaceStyleRenderingAutoImpl.h.

◆ m_DiffuseTransmissionColour

OdDAI::Select OdIfc4x4::IfcSurfaceStyleRendering::m_DiffuseTransmissionColour

protected

Definition at line 280 of file IFC4X4/IfcSurfaceStyleRenderingAutoImpl.h.

◆ m_ReflectanceMethod

OdDAI::Enum OdIfc4x4::IfcSurfaceStyleRendering::m_ReflectanceMethod

protected

Definition at line 284 of file IFC4X4/IfcSurfaceStyleRenderingAutoImpl.h.

◆ m_ReflectionColour

OdDAI::Select OdIfc4x4::IfcSurfaceStyleRendering::m_ReflectionColour

protected

Definition at line 281 of file IFC4X4/IfcSurfaceStyleRenderingAutoImpl.h.

◆ m_SpecularColour

OdDAI::Select OdIfc4x4::IfcSurfaceStyleRendering::m_SpecularColour

protected

Definition at line 282 of file IFC4X4/IfcSurfaceStyleRenderingAutoImpl.h.

◆ m_SpecularHighlight

OdDAI::Select OdIfc4x4::IfcSurfaceStyleRendering::m_SpecularHighlight

protected

Definition at line 283 of file IFC4X4/IfcSurfaceStyleRenderingAutoImpl.h.

◆ m_TransmissionColour

OdDAI::Select OdIfc4x4::IfcSurfaceStyleRendering::m_TransmissionColour

protected

Definition at line 279 of file IFC4X4/IfcSurfaceStyleRenderingAutoImpl.h.

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

IFC4X4/IfcSurfaceStyleRenderingAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcSurfaceStyleRendering()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ diffuseColour()

◆ diffuseTransmissionColour()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getReflectanceMethod()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ reflectionColour()

◆ setReflectanceMethod()

◆ specularColour()

◆ specularHighlight()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ transmissionColour()

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_DiffuseColour

◆ m_DiffuseTransmissionColour

◆ m_ReflectanceMethod

◆ m_ReflectionColour

◆ m_SpecularColour

◆ m_SpecularHighlight

◆ m_TransmissionColour