///////////////////////////////////////////////////////////////////////////////
// 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 _IFC4X2_IFCTEXTSTYLE_AUTO_IMPL_H
#define _IFC4X2_IFCTEXTSTYLE_AUTO_IMPL_H
#include "IfcPresentationStyleAutoImpl.h"
#include "IfcTextStyleForDefinedFontAutoImpl.h"
#include "IfcTextStyleTextModelAutoImpl.h"
#include "TD_PackPush.h"
/** \details
The namespace contains schema-dependent classes, definitions and sub routines
for work with IFC4X2 express schema definitions.
*/
namespace OdIfc4x2 {
/** \details
The IfcTextStyle is a presentation style for annotations that place a text in model space.
The IfcTextStyle provides the text style for presentation information assigned to IfcTextLiteral's.
The style is defined by color, text font characteristics, and text box characteristics.
An IfcTextStyle is instantiated with:
* TextCharacterAppearance: IfcTextStyleForDefinedFont
* TextStyle: IfcTextStyleTextModel
* TextFontStyle: IfcTextStyleFontModel
An IfcTextStyle is assigned to IfcTextLiteral through the IfcStyledItem entity.
\changes
* IFC2X3 changes:
The IfcTextStyle has been changed by adding TextFontStyle and different data types for TextStyle and IfcTextCharacterAppearance.
* IFC4 changes:
The IfcTextStyle has been simplified by removing old vector based text style definitions.
*/
class IFC4X2_EXPORT IfcTextStyle : public IfcPresentationStyle
{
//DOM-IGNORE-BEGIN
OD_EXP_DECLARE_MEMBERS(OdIfc4x2::IfcTextStyle);
//DOM-IGNORE-END
public:
//
// OdDAI early binding accessors
//
/** \details
Returns the value of TextCharacterAppearance attribute. TextCharacterAppearance is a character style to be used for presented text.
\returns
Returns the value of TextCharacterAppearance attribute.
\remarks
* IFC4 CHANGE: Superfluous select type IfcCharacterStyleSelect has been removed.
*/
const OdDAIObjectId& getTextCharacterAppearance() const;
/** \details
Sets the value of TextCharacterAppearance attribute. TextCharacterAppearance is a character style to be used for presented text.
\param TextCharacterAppearance [in] TextCharacterAppearance to set.
\remarks
* IFC4 CHANGE: Superfluous select type IfcCharacterStyleSelect has been removed.
*/
void setTextCharacterAppearance(const OdDAIObjectId& TextCharacterAppearance);
/** \details
Returns the value of TextStyle attribute. TextStyle is the style applied to the text block for its visual appearance.
\returns
Returns the value of TextStyle attribute.
\remarks
* IFC2x3 CHANGE: The attribute TextBlockStyle has been changed from SET[1:?] to a non-aggregated optional and renamed into TextStyles.
* IFC4 CHANGE: The IfcTextStyleWithBoxCharacteristics and the now superfluous select type IfcTextStyleSelect have been removed.
*/
const OdDAIObjectId& getTextStyle() const;
/** \details
Sets the value of TextStyle attribute. TextStyle is the style applied to the text block for its visual appearance.
\param TextStyle [in] TextStyle to set.
\remarks
* IFC2x3 CHANGE: The attribute TextBlockStyle has been changed from SET[1:?] to a non-aggregated optional and renamed into TextStyles.
* IFC4 CHANGE: The IfcTextStyleWithBoxCharacteristics and the now superfluous select type IfcTextStyleSelect have been removed.
*/
void setTextStyle(const OdDAIObjectId& TextStyle);
/** \details
Returns the value of TextFontStyle attribute. TextFontStyle is the style applied to the text font for its visual appearance.
It defines the font family, font style, weight and size.
\returns
Returns the value of TextFontStyle attribute.
\remarks
* IFC2x2 Add2 CHANGE: The attribute TextFontStyle is a new attribute attached to IfcTextStyle.
*/
IfcTextFontSelect textFontStyle();
/** \details
Returns the value of ModelOrDraughting attribute. ModelOrDraughting is indication whether the length measures provided for
the presentation style are model based, or draughting based.
\returns
Returns the value of ModelOrDraughting attribute.
\remarks
* IFC4 CHANGE: New attribute.
*/
OdDAI::Boolean getModelOrDraughting() const;
/** \details
Sets the value of ModelOrDraughting attribute. ModelOrDraughting is indication whether the length measures provided for
the presentation style are model based, or draughting based.
\param ModelOrDraughting [in] ModelOrDraughting attribute to set.
\remarks
* IFC4 CHANGE: New attribute.
*/
void setModelOrDraughting(OdDAI::Boolean ModelOrDraughting);
public:
/** \details
Default constructor for the IfcTextStyle class.
*/
IfcTextStyle();
/** \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
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_TextCharacterAppearance; // IfcTextStyleForDefinedFont [optional]
OdDAIObjectId m_TextStyle; // IfcTextStyleTextModel [optional]
OdDAI::Select m_TextFontStyle; // IfcTextFontSelect
OdDAI::Boolean m_ModelOrDraughting; // IfcBoolean [optional]
};
/** \details
A data type that represents a smart pointer to a IfcTextStyle object.
*/
typedef OdSmartPtr IfcTextStylePtr;
} // namespace
#include "TD_PackPop.h"
#endif // _IFC4X2_IFCTEXTSTYLE_AUTO_IMPL_H