#include <IfcIndexedColourMapAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcIndexedColourMap:

Public Member Functions
const OdDAIObjectId &	getMappedTo () const

void	setMappedTo (const OdDAIObjectId &MappedTo)

double	getOpacity () const

void	setOpacity (double Opacity)

const OdDAIObjectId &	getColours () const

void	setColours (const OdDAIObjectId &Colours)

void	getColourIndex (OdArray< int > &ColourIndex) const

OdDAI::ListOfInt &	colourIndex ()

	IfcIndexedColourMap ()

virtual OdResult	inFields (OdDAI::OdSpfFilerBase *rdFiler) override

virtual OdResult	outFields (OdDAI::OdSpfFilerBase *wrFiler) override

virtual void	setInverseCounterParts () 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::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_MappedTo

IfcNormalisedRatioMeasure	m_Opacity

OdDAIObjectId	m_Colours

OdDAI::ListOfInt	m_ColourIndex

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 IfcIndexedColourMap provides the assignment of colour information to individual faces.

Details - It is used for colouring faces of tessellated face sets. The IfcIndexedColourMap defines an index into an indexed list of colour information. The Colours are a two-dimensional list of colours provided by three RGB values. The ColourIndex attribute corresponds to the CoordIndex of the IfcTessellatedFaceSet defining the corresponding index list of faces. The Opacity attribute provides the alpha channel for all faces of the tessellated face set. The next image shows an indexed colour map.

Indexed colour map geometry:

On this image IfcTriangulatedFaceSet is represented by: IfcTriangulatedFaceSet.CoordIndex: ((1,6,5),(1,2,6), (6,2,7), (7,2,3), (7,8,6), (6,8,5), (5,8,1), (1,8,4), (4,2,1), (2,4,3), (4,8,7), (7,3,4)) IfcCartesianPointList.CoordList: ((0.,0.,0.), (1.,0.,0.), (1.,1.,0.), (0.,1.,0.), (0.,0.,2.), (1.,0.,2.), (1.,1.,2.), (0.,1.,2.)) IfcIndexedColourMap.ColourIndex: (1, 1, 2, 2, 3, 3, 1, 1, 1, 1, 1, 1, ) IfcColourRgbList.ColourList: ((1.,0.,0.), (0.,1.,0.), (1.,1.,0.))

\changes

IFC4X3_RC1 changes: Type of the ColourIndex attribute changed from INTEGER to IfcPositiveInteger.

Definition at line 66 of file IFC4X4/IfcIndexedColourMapAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcIndexedColourMap()

OdIfc4x4::IfcIndexedColourMap::IfcIndexedColourMap ( )

Default constructor for the IfcIndexedColourMap class.

Member Function Documentation

◆ colourIndex()

OdDAI::ListOfInt & OdIfc4x4::IfcIndexedColourMap::colourIndex ( )

Returns the value of ColourIndex attribute. This attribute is an index into the IfcColourRgbList for each face of the IfcTriangulatedFaceSet. The colour is applied uniformly to the indexed face.

Returns: Returns the value of ColourIndex attribute.

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcIndexedColourMap::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::IfcPresentationItem.

◆ getAttr() [1/2]

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

◆ getColourIndex()

void OdIfc4x4::IfcIndexedColourMap::getColourIndex ( OdArray< int > & ColourIndex ) const

Returns the value of ColourIndex attribute. This attribute is an index into the IfcColourRgbList for each face of the IfcTriangulatedFaceSet. The colour is applied uniformly to the indexed face.

Parameters

ColourIndex [out] Receives an array of colour indexes.

◆ getColours()

const OdDAIObjectId & OdIfc4x4::IfcIndexedColourMap::getColours ( ) const

Returns the value of Colours attribute. Colours is indexable list of lists of quadruples, representing RGB colours.

Returns: Returns the value of Colours attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcIndexedColourMap::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::IfcPresentationItem.

◆ getMappedTo()

const OdDAIObjectId & OdIfc4x4::IfcIndexedColourMap::getMappedTo ( ) const

Returns the value of MappedTo attribute. This attribute is reference to the IfcTessellatedFaceSet to which it applies the colours and alpha channel.

Returns: Returns the value of MappedTo attribute.

◆ getOpacity()

double OdIfc4x4::IfcIndexedColourMap::getOpacity ( ) const

Returns the value of Opacity attribute. Opacity is the the opacity value, that applies equally to all faces of the tessellated face set. 1.0 means opaque, and 0.0 completely transparent. If not provided, 1.0 is assumed (all colours are opaque).

Returns: Returns the value of Opacity attribute.

Remarks: The definition of the alpha channel component for opacity follows the new definitions in image processing, where 0.0 means full transparency and 1.0 (or 2bit depths -1) means fully opaque. This is contrary to the definition of transparency in IfcSurfaceStyleShading.

◆ inFields()

virtual OdResult OdIfc4x4::IfcIndexedColourMap::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 OdIfc4x4::IfcIndexedColourMap::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::IfcPresentationItem.

◆ outFields()

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

◆ setColours()

void OdIfc4x4::IfcIndexedColourMap::setColours ( const OdDAIObjectId & Colours )

Sets the value of Colours attribute. Colours is indexable list of lists of quadruples, representing RGB colours.

Parameters

Colours [in] Colours to set.

◆ setInverseCounterParts()

virtual void OdIfc4x4::IfcIndexedColourMap::setInverseCounterParts ( )

overridevirtual

Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.

◆ setMappedTo()

void OdIfc4x4::IfcIndexedColourMap::setMappedTo ( const OdDAIObjectId & MappedTo )

Sets the value of MappedTo attribute. This attribute is reference to the IfcTessellatedFaceSet to which it applies the colours and alpha channel.

Parameters

MappedTo [in] The MappedTo attribute to set.

◆ setOpacity()

void OdIfc4x4::IfcIndexedColourMap::setOpacity ( double Opacity )

Sets the value of Opacity attribute. Opacity is the the opacity value, that applies equaly to all faces of the tessellated face set. 1.0 means opaque, and 0.0 completely transparent. If not provided, 1.0 is assumed (all colours are opaque).

Parameters

Opacity [in] Opacity to set.

Remarks: The definition of the alpha channel component for opacity follows the new definitions in image processing, where 0.0 means full transparency and 1.0 (or 2bit depths -1) means fully opaque. This is contrary to the definition of transparency in IfcSurfaceStyleShading.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcIndexedColourMap::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 OdIfc4x4::IfcIndexedColourMap::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 OdIfc4x4::IfcIndexedColourMap::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::IfcPresentationItem.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcIndexedColourMap::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 OdIfc4x4::IfcIndexedColourMap::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_ColourIndex

OdDAI::ListOfInt OdIfc4x4::IfcIndexedColourMap::m_ColourIndex

protected

Definition at line 289 of file IFC4X4/IfcIndexedColourMapAutoImpl.h.

◆ m_Colours

OdDAIObjectId OdIfc4x4::IfcIndexedColourMap::m_Colours

protected

Definition at line 288 of file IFC4X4/IfcIndexedColourMapAutoImpl.h.

◆ m_MappedTo

OdDAIObjectId OdIfc4x4::IfcIndexedColourMap::m_MappedTo

protected

Definition at line 286 of file IFC4X4/IfcIndexedColourMapAutoImpl.h.

◆ m_Opacity

IfcNormalisedRatioMeasure OdIfc4x4::IfcIndexedColourMap::m_Opacity

protected

Definition at line 287 of file IFC4X4/IfcIndexedColourMapAutoImpl.h.

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

IFC4X4/IfcIndexedColourMapAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcIndexedColourMap()

Member Function Documentation

◆ colourIndex()

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getColourIndex()

◆ getColours()

◆ getInstanceType()

◆ getMappedTo()

◆ getOpacity()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setColours()

◆ setInverseCounterParts()

◆ setMappedTo()

◆ setOpacity()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_ColourIndex

◆ m_Colours

◆ m_MappedTo

◆ m_Opacity