#include <IfcSurfaceTextureAutoImpl.h>

Inheritance diagram for OdIfc4::IfcSurfaceTexture:

Public Member Functions
OdDAI::Boolean	getRepeatS () const

void	setRepeatS (OdDAI::Boolean RepeatS)

OdDAI::Boolean	getRepeatT () const

void	setRepeatT (OdDAI::Boolean RepeatT)

const OdAnsiString &	getMode () const

void	setMode (const OdAnsiString &Mode)

const OdDAIObjectId &	getTextureTransform () const

void	setTextureTransform (const OdDAIObjectId &TextureTransform)

void	getParameter (OdArray< OdAnsiString > &Parameter) const

OdDAI::ListOfOdAnsiString &	parameter ()

void	getInvIsMappedBy (OdDAIObjectIds &IsMappedBy) const

void	getInvUsedInStyles (OdDAIObjectIds &UsedInStyles) const

	IfcSurfaceTexture ()

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::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
OdDAI::Boolean	m_RepeatS

OdDAI::Boolean	m_RepeatT

OdAnsiString	m_Mode

OdDAIObjectId	m_TextureTransform

OdDAI::ListOfOdAnsiString	m_Parameter

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Friends
class	IfcTextureCoordinate

class	IfcSurfaceStyleWithTextures

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

An IfcSurfaceTexture provides a 2-dimensional image-based texture map. It can either be given by referencing an external image file through an URL reference (IfcImageTexture), including the image file as a blob (long binary) into the data set (IfcBlobTexture), or by explicitly including an array of pixels (IfcPixelTexture).

Details - Texture are defined by 2D images that contain an array of colour values describing the texture. The texture values are interpreted differently depending on the number of components in the texture and the specifics of the image format. In general, texture can be described using one of the following forms: Intensity textures (one-component) Intensity plus alpha opacity textures (two-component) Full RGB textures (three-component) Full RGB plus alpha opacity textures (four-component)

Texture maps are defined in a 2D coordinate system (s, t) that ranges from [0.0, 1.0] in both directions. The bottom edge of the image corresponds to the S-axis of the texture map, and left edge of the image corresponds to the T-axis of the texture map. The lower-left pixel of the image corresponds to s=0, t=0, and the top-right pixel of the image corresponds to s=1, t=1. Texture maps can be viewed as two dimensional colour functions that, given an (s, t) coordinate, return a colour value colour(s, t).

Remarks: Image formats specify an alpha opacity, not transparency (where alpha = 1 - transparency). This definition may not be instantiated.

\changes

IFC4 changes: Type of the RepeatS attribute changed from boolean to IfcBoolean. Type of the RepeatT attribute changed from boolean to IfcBoolean. Name of the TextureType attribute changed to Mode. Attribute TextureType is optional. Type of the TextureType attribute changed from IfcSurfaceTextureEnum to IfcIdentifier.

Definition at line 73 of file Ifc4/IfcSurfaceTextureAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcSurfaceTexture()

OdIfc4::IfcSurfaceTexture::IfcSurfaceTexture ( )

Default constructor for the IfcSurfaceTexture class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcSurfaceTexture::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::IfcPresentationItem.

Reimplemented in OdIfc4::IfcBlobTexture, OdIfc4::IfcImageTexture, and OdIfc4::IfcPixelTexture.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcSurfaceTexture::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 OdIfc4::IfcBlobTexture, OdIfc4::IfcImageTexture, and OdIfc4::IfcPixelTexture.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcSurfaceTexture::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.

Reimplemented in OdIfc4::IfcBlobTexture, OdIfc4::IfcImageTexture, and OdIfc4::IfcPixelTexture.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcSurfaceTexture::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::IfcPresentationItem.

Reimplemented in OdIfc4::IfcBlobTexture, OdIfc4::IfcImageTexture, and OdIfc4::IfcPixelTexture.

◆ getInvIsMappedBy()

void OdIfc4::IfcSurfaceTexture::getInvIsMappedBy ( OdDAIObjectIds & IsMappedBy ) const

Returns the value of IsMappedBy attribute. IsMappedBy is texture coordinates, either provided by a corresponding list of texture vertices to vertex-based geometric items or by a texture coordinate generator, that applies the surface texture to the surfaces of the geometric items.

Parameters

IsMappedBy [out] Receives the value of IsMappedBy attribute.

Remarks: IFC4 CHANGE: New attribute added at the end of the attribute list.

◆ getInvUsedInStyles()

void OdIfc4::IfcSurfaceTexture::getInvUsedInStyles ( OdDAIObjectIds & UsedInStyles ) const

Returns the value of UsedInStyles attribute. This attribute represents an entity that allows to include image textures in surface styles.

Parameters

UsedInStyles [out] Receives the value of UsedInStyles attribute.

◆ getMode()

const OdAnsiString & OdIfc4::IfcSurfaceTexture::getMode ( ) const

Returns the value of Mode attribute. This attribute is provided to control the appearance of a multi-textures. The mode then controls the type of blending operation. The mode includes a MODULATE for a lit appearance, a REPLACE for an unlit appearance, and variations of both.

Returns: Returns the value of Mode attribute.

Remarks: The applicable values for the Mode attribute are determined by view definitions or implementer agreements. IFC4 CHANGE: New attribute replacing previous TextureType.

◆ getParameter()

void OdIfc4::IfcSurfaceTexture::getParameter ( OdArray< OdAnsiString > & Parameter ) const

Returns the value of Parameter attribute. This attribute is provided to control the appearance of a multi textures. The applicable parameters depend on the value of the Mode attribute.

Parameters

Parameter [out] Parameter to set.

Remarks: The applicable values for the list of Parameter attributes are determined by view definitions or implementer agreements. IFC4 CHANGE: New attribute added at the end of the attribute list.

◆ getRepeatS()

OdDAI::Boolean OdIfc4::IfcSurfaceTexture::getRepeatS ( ) const

Returns the value of RepeatS attribute. RepeatS is the field that specifies how the texture wraps in the S direction. If RepeatS is TRUE (the default case), the texture map is repeated outside the [0.0, 1.0] texture coordinate range in the S direction so that it fills the shape. If RepeatS is FALSE, the texture coordinates are clamped in the S direction to lie within the [0.0, 1.0] range.

Returns: Returns the value of RepeatS attribute.

◆ getRepeatT()

OdDAI::Boolean OdIfc4::IfcSurfaceTexture::getRepeatT ( ) const

Returns the value of RepeatT attribute. RepeatT is the field that specifies how the texture wraps in the T direction. If RepeatT is TRUE (the default), the texture map is repeated outside the [0.0, 1.0] texture coordinate range in the T direction so that it fills the shape. If RepeatT is FALSE, the texture coordinates are clamped in the T direction to lie within the [0.0, 1.0] range.

Returns: Returns the value of RepeatT attribute.

◆ getTextureTransform()

const OdDAIObjectId & OdIfc4::IfcSurfaceTexture::getTextureTransform ( ) const

Returns the value of TextureTransform attribute. TextureTransform attribute defines a 2D transformation that is applied to the texture coordinates. It affects the way texture coordinates are applied to the surfaces of geometric representation items. The 2D transformation supports changes to the size, orientation, and position of textures on shapes. Mirroring is not allowed to be used in the IfcCartesianTransformationOperator.

Returns: Returns the value of TextureTransform attribute.

◆ inFields()

virtual OdResult OdIfc4::IfcSurfaceTexture::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 in OdIfc4::IfcBlobTexture, OdIfc4::IfcImageTexture, and OdIfc4::IfcPixelTexture.

◆ isKindOf()

virtual bool OdIfc4::IfcSurfaceTexture::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::IfcPresentationItem.

Reimplemented in OdIfc4::IfcBlobTexture, OdIfc4::IfcImageTexture, and OdIfc4::IfcPixelTexture.

◆ outFields()

virtual OdResult OdIfc4::IfcSurfaceTexture::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 in OdIfc4::IfcBlobTexture, OdIfc4::IfcImageTexture, and OdIfc4::IfcPixelTexture.

◆ parameter()

OdDAI::ListOfOdAnsiString & OdIfc4::IfcSurfaceTexture::parameter ( )

Returns the value of Parameter attribute. This attribute is provided to control the appearance of a multi textures. The applicable parameters depend on the value of the Mode attribute.

Returns: Returns the value of Parameter attribute.

Remarks: The applicable values for the list of Parameter attributes are determined by view definitions or implementer agreements. IFC4 CHANGE: New attribute added at the end of the attribute list.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcSurfaceTexture::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 OdIfc4::IfcBlobTexture, OdIfc4::IfcImageTexture, and OdIfc4::IfcPixelTexture.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcSurfaceTexture::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.

Reimplemented in OdIfc4::IfcBlobTexture, OdIfc4::IfcImageTexture, and OdIfc4::IfcPixelTexture.

◆ setMode()

void OdIfc4::IfcSurfaceTexture::setMode ( const OdAnsiString & Mode )

Sets the value of Mode attribute. This attribute is provided to control the appearance of a multi-textures. The mode then controls the type of blending operation. The mode includes a MODULATE for a lit appearance, a REPLACE for an unlit appearance, and variations of both.

Parameters

Mode	[in] Mode to set.

Remarks: The applicable values for the Mode attribute are determined by view definitions or implementer agreements. IFC4 CHANGE: New attribute replacing previous TextureType.

◆ setRepeatS()

void OdIfc4::IfcSurfaceTexture::setRepeatS ( OdDAI::Boolean RepeatS )

Sets the value of RepeatS attribute. RepeatS is the field that specifies how the texture wraps in the S direction. If RepeatS is TRUE (the default), the texture map is repeated outside the [0.0, 1.0] texture coordinate range in the S direction so that it fills the shape. If RepeatS is FALSE, the texture coordinates are clamped in the S direction to lie within the [0.0, 1.0] range.

Parameters

RepeatS [in] RepeatS attribute to set.

◆ setRepeatT()

void OdIfc4::IfcSurfaceTexture::setRepeatT ( OdDAI::Boolean RepeatT )

Sets the value of RepeatT attribute. RepeatT is the field that specifies how the texture wraps in the T direction. If RepeatT is TRUE (the default), the texture map is repeated outside the [0.0, 1.0] texture coordinate range in the T direction so that it fills the shape. If RepeatT is FALSE, the texture coordinates are clamped in the T direction to lie within the [0.0, 1.0] range.

Parameters

RepeatT [in] RepeatT to set.

◆ setTextureTransform()

void OdIfc4::IfcSurfaceTexture::setTextureTransform ( const OdDAIObjectId & TextureTransform )

Sets the value of TextureTransform attribute. TextureTransform attribute defines a 2D transformation that is applied to the texture coordinates. It affects the way texture coordinates are applied to the surfaces of geometric representation items. The 2D transformation supports changes to the size, orientation, and position of textures on shapes. Mirroring is not allowed to be used in the IfcCartesianTransformationOperator.

Parameters

TextureTransform [in] TextureTransform to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcSurfaceTexture::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.

Reimplemented in OdIfc4::IfcBlobTexture, OdIfc4::IfcImageTexture, and OdIfc4::IfcPixelTexture.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcSurfaceTexture::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.

Reimplemented in OdIfc4::IfcBlobTexture, OdIfc4::IfcImageTexture, and OdIfc4::IfcPixelTexture.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcSurfaceTexture::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::IfcPresentationItem.

Reimplemented in OdIfc4::IfcBlobTexture, OdIfc4::IfcImageTexture, and OdIfc4::IfcPixelTexture.