/////////////////////////////////////////////////////////////////////////////// // Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). // All rights reserved. // // This software and its documentation and related materials are owned by // the Alliance. The software may only be incorporated into application // programs owned by members of the Alliance, subject to a signed // Membership Agreement and Supplemental Software License Agreement with the // Alliance. The structure and organization of this software are the valuable // trade secrets of the Alliance and its suppliers. The software is also // protected by copyright law and international treaty provisions. Application // programs incorporating this software must include the following statement // with their copyright notices: // // This application incorporates Open Design Alliance software pursuant to a license // agreement with Open Design Alliance. // Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. // All rights reserved. // // By use of this software, its documentation or related materials, you // acknowledge and accept the above terms. /////////////////////////////////////////////////////////////////////////////// // This file is generated automatically. #ifndef _IFC4X1_IFCINDEXEDCOLOURMAP_AUTO_IMPL_H #define _IFC4X1_IFCINDEXEDCOLOURMAP_AUTO_IMPL_H #include "IfcPresentationItemAutoImpl.h" #include "IfcTessellatedFaceSetAutoImpl.h" #include "IfcColourRgbListAutoImpl.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC4X1 express schema definitions. */ namespace OdIfc4x1 { /** \details 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.)) */ class IFC4X1_EXPORT IfcIndexedColourMap : public IfcPresentationItem { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc4x1::IfcIndexedColourMap); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details 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. */ const OdDAIObjectId& getMappedTo() const; /** \details Sets the value of MappedTo attribute. This attribute is reference to the IfcTessellatedFaceSet to which it applies the colours and alpha channel. \param MappedTo [in] The MappedTo attribute to set. */ void setMappedTo(const OdDAIObjectId& MappedTo); /** \details 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. */ double getOpacity() const; /** \details 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). \param 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. */ void setOpacity(double Opacity); /** \details Returns the value of Colours attribute. Colours is indexable list of lists of quadruples, representing RGB colours. \returns Returns the value of Colours attribute. */ const OdDAIObjectId& getColours() const; /** \details Sets the value of Colours attribute. Colours is indexable list of lists of quadruples, representing RGB colours. \param Colours [in] Colours to set. */ void setColours(const OdDAIObjectId& Colours); /** \details 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. \param ColourIndex [out] Receives an array of colour indexes. */ void getColourIndex(OdArray& ColourIndex) const; /** \details 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. */ OdDAI::ListOfInt& colourIndex(); public: /** \details Default constructor for the IfcIndexedColourMap class. */ IfcIndexedColourMap(); /** \details Reads object's data from the specified filer. \param 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. */ virtual OdResult inFields(OdDAI::OdSpfFilerBase* rdFiler) override; /** \details Writes object's data the the specified filer. \param 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. */ virtual OdResult outFields(OdDAI::OdSpfFilerBase* wrFiler) override; /** \details Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes. */ virtual void setInverseCounterParts() override; /** \details Returns a type of a class instance. \returns Pointer to the OdDAI::Entity type that determines an entity definition within a schema. */ virtual OdDAI::Entity* getInstanceType() const override; /** \details Returns an attribute value for the specified attribute name. \param attrName [in] Name of an attribute to query. \returns OdRxValue object that represents a generic variant type value. */ virtual OdRxValue getAttr(const char * attrName) const override; /** \details Resets a value for the specified attribute. \param explicitAttrName [in] Explicit name of the attribute to reset. */ virtual void unsetAttr(const char * explicitAttrName) override; /** \details Checks whether the specified attribute is set. \param explicitAttrName [in] Explicit name of the attribute to test. \returns true if the specified attribute is set, false otherwise. */ virtual bool testAttr(const char * explicitAttrName) const override; /** \details Sets the specified attribute with a given value. \param explicitAttrName [in] Explicit name of the attribute to set. \param val [in] Value to set. \returns true if the value is successfully set for the specified attribute, false otherwise. */ virtual bool putAttr(const char * explicitAttrName, const OdRxValue &val) override; /** \details Checks whether the specified instance is the object derived from or belongs to this class. \param entityType [in] Entity to check. \returns true if the specified instance is the object derived from or belongs to this class, false otherwise. */ virtual bool isKindOf(OdIfc::OdIfcEntityType entityType) const override; /** \details Returns the type of this entity. \returns A value of the OdIfc::OdIfcEntityType type that represents type of this entity. */ virtual OdIfc::OdIfcEntityType type() const override; /** \details Returns an attribute value for the specified attribute definition. \param attrDef [in] Attribute definition to query. \returns OdRxValue object that represents a generic variant type value. */ virtual OdRxValue getAttr(const OdIfc::OdIfcAttribute attrDef) const override; /** \details Resets a value for the specified attribute. \param explicitAttrDef [in] Explicit definition that represents an attribute to reset. */ virtual void unsetAttr(const OdIfc::OdIfcAttribute explicitAttrDef) override; /** \details Checks whether the specified attribute is set. \param explicitAttrDef [in] Attribute definition to test. \returns true if the specified attribute is set, false otherwise. */ virtual bool testAttr(const OdIfc::OdIfcAttribute explicitAttrDef) const override; /** \details Sets the specified attribute with a given value. \param explicitAttrDef [in] Explicit attribute definition to set. \param val [in] Value to set. \returns true if the value is successfully set for the specified attribute, false otherwise. */ virtual bool putAttr(const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override; protected: // Fields declaration: OdDAIObjectId m_MappedTo; // IfcTessellatedFaceSet IfcNormalisedRatioMeasure m_Opacity; // IfcNormalisedRatioMeasure [optional] OdDAIObjectId m_Colours; // IfcColourRgbList OdDAI::ListOfInt m_ColourIndex; // LIST [1:?] of IfcPositiveInteger }; /** \details A data type that represents a smart pointer to a IfcIndexedColourMap object. */ typedef OdSmartPtr IfcIndexedColourMapPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC4X1_IFCINDEXEDCOLOURMAP_AUTO_IMPL_H