/////////////////////////////////////////////////////////////////////////////// // 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 _IFC2X3_IFCTEXTSTYLEWITHBOXCHARACTERISTICS_AUTO_IMPL_H #define _IFC2X3_IFCTEXTSTYLEWITHBOXCHARACTERISTICS_AUTO_IMPL_H #include "Ifc2x3BaseClass.h" #include "Ifc2x3Enum.h" #include "Ifc2x3SelectTypes.h" #include "Ifc2x3CollectionTypes.h" #include "TD_PackPush.h" /** \details The namespace contains schema-dependent classes, definitions and sub routines for work with IFC2X3 express schema definitions. */ namespace OdIfc2x3 { /** \details The text style with box characteristics provides the presentation of annotated text by specifying the characteristics of the character boxes of the text and the spacing between the character boxes. - Details - The usage of IfcTextStyleWithBoxCharacteristics is restricted to monespace text fonts (having uniform character boxes) and simple vector based text fonts. For true text fonts the use of IfcTextStyleTextModel is required. Illustration of IfcTextStyleWithBoxCharacteristics attributes: */ class IFC2X3_EXPORT IfcTextStyleWithBoxCharacteristics : public OdIfc2x3Instance { //DOM-IGNORE-BEGIN OD_EXP_DECLARE_MEMBERS(OdIfc2x3::IfcTextStyleWithBoxCharacteristics); //DOM-IGNORE-END public: // // OdDAI early binding accessors // /** \details Returns the value of BoxHeight attribute. This attribute represents the height scaling factor in the definition of a character glyph. \returns Returns the value of BoxHeight attribute. */ double getBoxHeight() const; /** \details Sets the value of BoxHeight attribute. This attribute represents the height scaling factor in the definition of a character glyph. \param BoxHeight [in] BoxHeight attribute to set. */ void setBoxHeight(double BoxHeight); /** \details Returns the value of BoxWidth attribute. This attribute represents the width scaling factor in the definition of a character glyph. \returns Returns the value of BoxWidth attribute. */ double getBoxWidth() const; /** \details Sets the value of BoxWidth attribute. This attribute represents the width scaling factor in the definition of a character glyph. \param BoxWidth [in] BoxWidth attribute to set. */ void setBoxWidth(double BoxWidth); /** \details Returns the value of BoxSlantAngle attribute. This attribute indicates whether the box of a character glyph is represented as a parallelogramm, with the angle being between the character up line and an axis perpendicular to the character base line. \returns Returns the value of BoxSlantAngle attribute. */ double getBoxSlantAngle() const; /** \details Sets the value of BoxSlantAngle attribute. This attribute indicates whether the box of a character glyph is represented as a parallelogramm, with the angle being between the character up line and an axis perpendicular to the character base line. \param BoxSlantAngle [in] BoxSlantAngle attribute to set. */ void setBoxSlantAngle(double BoxSlantAngle); /** \details Returns the value of BoxRotateAngle attribute. This attribute indicates whether the box of a character glyph is presented at an angle to the base line of a text string within which the glyph occurs, the angle being that between the base line of the glyph and an axis perpendicular to the baseline of the text string. \returns Returns the value of BoxRotateAngle attribute. */ double getBoxRotateAngle() const; /** \details Sets the value of BoxRotateAngle attribute. This attribute indicates whether the box of a character glyph is presented at an angle to the base line of a text string within which the glyph occurs, the angle being that between the base line of the glyph and an axis perpendicular to the baseline of the text string. \param BoxRotateAngle [in] BoxRotateAngle attribute to set. */ void setBoxRotateAngle(double BoxRotateAngle); /** \details Returns the value of CharacterSpacing attribute. This attribute represents the distance between the character boxes of adjacent characters. \returns Returns the value of CharacterSpacing attribute. */ IfcSizeSelect characterSpacing(); public: /** \details Default constructor for the IfcTextStyleWithBoxCharacteristics class. */ IfcTextStyleWithBoxCharacteristics(); /** \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 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 Early-bound version of instances comparison. \param pOther [in] Other application instance. \param 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: Name 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.
*/ virtual bool comparedToEarlyImpl(const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) 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: IfcPositiveLengthMeasure m_BoxHeight; // IfcPositiveLengthMeasure [optional] IfcPositiveLengthMeasure m_BoxWidth; // IfcPositiveLengthMeasure [optional] double m_BoxSlantAngle; // IfcPlaneAngleMeasure [optional] double m_BoxRotateAngle; // IfcPlaneAngleMeasure [optional] OdDAI::Select m_CharacterSpacing; // IfcSizeSelect [optional] }; /** \details A data type that represents a smart pointer to a IfcTextStyleWithBoxCharacteristics object. */ typedef OdSmartPtr IfcTextStyleWithBoxCharacteristicsPtr; } // namespace #include "TD_PackPop.h" #endif // _IFC2X3_IFCTEXTSTYLEWITHBOXCHARACTERISTICS_AUTO_IMPL_H