///////////////////////////////////////////////////////////////////////////////
// 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 _IFC4X3_ADD2_IFCTEXTSTYLETEXTMODEL_AUTO_IMPL_H
#define _IFC4X3_ADD2_IFCTEXTSTYLETEXTMODEL_AUTO_IMPL_H
#include "IfcPresentationItemAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC4X3_ADD2 express schema definitions.
*/
namespace OdIfc4x3_add2 {
/** \details
The IfcTextStyleTextModel combines all text style properties, that affect the presentation of a text literal within a given extent.
It includes the spacing between characters and words, the horizontal and vertical alignment of the text within the planar box of the extent,
decorations (like underline), transformations of the literal (like uppercase), and the height of each text line within a multi-line text block.
*/
class IFC4X3_EXPORT IfcTextStyleTextModel : public IfcPresentationItem
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc4x3_add2::IfcTextStyleTextModel);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of TextIndent attribute.
TextIndent is the property that specifies the indentation that appears before the first formatted line.
\returns
Returns the value of TextIndent attribute.
\remarks
This attribute has been introduced for later compliance to full CSS support.
*/
IfcSizeSelect textIndent();
/** \details
Returns the value of TextAlign attribute.
TextAlign is the property that describes how text is aligned horizontally within the element.
The actual justification algorithm used is dependent on the rendering algorithm.
\returns
Returns the value of TextAlign attribute.
*/
const OdAnsiString& getTextAlign() const;
/** \details
Sets the value of TextAlign attribute.
TextAlign is the property describes how text is aligned horizontally within the element.
The actual justification algorithm used is dependent on the rendering algorithm.
\param TextAlign [in] Text alignment to set.
*/
void setTextAlign(const OdAnsiString& TextAlign);
/** \details
Returns the value of TextDecoration attribute.
This property represents decorations that are added to the text of an element.
\returns
Returns the value of TextDecoration attribute.
*/
const OdAnsiString& getTextDecoration() const;
/** \details
Sets the value of TextDecoration attribute.
This property represents decorations that are added to the text of an element.
\param TextDecoration [in] Text decoration to set.
*/
void setTextDecoration(const OdAnsiString& TextDecoration);
/** \details
Returns the value of LetterSpacing attribute.
This attribute represents the length unit that indicates an addition to the default space between characters.
Values can be negative, but there can be implementation-specific limits.
The importing application is free to select the exact spacing algorithm.
The letter spacing can also be influenced by justification (which is a value of the TextAlign attribute).
\returns
Returns the value of LetterSpacing attribute.
\remarks
The following values are allowed: IfcDescriptiveMeasure with value='normal', IfcRatioMeasure, or IfcLengthMeasure, where the length unit is globally defined at IfcUnitAssignment.
*/
IfcSizeSelect letterSpacing();
/** \details
Returns the value of WordSpacing attribute. This attribute is the length unit that indicates an addition to the default space between words.
Values can be negative, but there can be implementation-specific limits.
The importing application is free to select the exact spacing algorithm.
The word spacing can also be influenced by justification (which is a value of the 'text-align' property).
\returns
Returns the value of WordSpacing attribute.
\remarks
This attribute has been introduced for later compliance to full CSS support.
*/
IfcSizeSelect wordSpacing();
/** \details
Returns the value of TextTransform attribute.
This attribute describes how text characters can transform to upper case, lower case,
or capitalized case, independent of the character case used in the text literal.
\returns
Returns the value of TextTransform attribute.
\remarks
This attribute has been introduced for later compliance to full CSS support.
*/
const OdAnsiString& getTextTransform() const;
/** \details
Sets the value of TextTransform attribute.
This attribute describes how text characters can transform to upper case, lower case,
or capitalized case, independent of the character case used in the text literal.
\param TextTransform [in] TextTransform to set.
\remarks
This attribute has been introduced for later compliance to full CSS support.
*/
void setTextTransform(const OdAnsiString& TextTransform);
/** \details
Returns the value of LineHeight attribute. This attribute represents the distance between two adjacent lines' baselines.
When a ratio value is specified, the line height is given by the font size of the current element multiplied with the numerical value.
A value of 'normal' sets the line height to a reasonable value for the element's font.
It is suggested that importing applications set the 'normal' value to be a ratio number in the range from 1.0 to 1.2.
\returns
Returns the value of LineHeight attribute.
\remarks
The following values are allowed: IfcDescriptiveMeasure with value='normal', or IfcLengthMeasure, with non-negative values,
the length unit is globally defined at IfcUnitAssignment, or IfcRatioMeasure.
*/
IfcSizeSelect lineHeight();
public:
/** \details
Default constructor for the IfcTextStyleTextModel class.
*/
IfcTextStyleTextModel();
/** \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:
OdDAI::Select m_TextIndent; // IfcSizeSelect [optional]
OdAnsiString m_TextAlign; // IfcTextAlignment [optional]
OdAnsiString m_TextDecoration; // IfcTextDecoration [optional]
OdDAI::Select m_LetterSpacing; // IfcSizeSelect [optional]
OdDAI::Select m_WordSpacing; // IfcSizeSelect [optional]
OdAnsiString m_TextTransform; // IfcTextTransformation [optional]
OdDAI::Select m_LineHeight; // IfcSizeSelect [optional]
};
/** \details
A data type that represents a smart pointer to a IfcTextStyleTextModel object.
*/
typedef OdSmartPtr IfcTextStyleTextModelPtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4X3_ADD2_IFCTEXTSTYLETEXTMODEL_AUTO_IMPL_H