#include <IfcTextStyleAutoImpl.h>

Inheritance diagram for OdIfc4::IfcTextStyle:

Public Member Functions
const OdDAIObjectId &	getTextCharacterAppearance () const

void	setTextCharacterAppearance (const OdDAIObjectId &TextCharacterAppearance)

const OdDAIObjectId &	getTextStyle () const

void	setTextStyle (const OdDAIObjectId &TextStyle)

IfcTextFontSelect	textFontStyle ()

OdDAI::Boolean	getModelOrDraughting () const

void	setModelOrDraughting (OdDAI::Boolean ModelOrDraughting)

	IfcTextStyle ()

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

virtual OdResult	outFields (OdDAI::OdSpfFilerBase *wrFiler) 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 OdIfc4::IfcPresentationStyle
const OdAnsiString &	getName () const

void	setName (const OdAnsiString &Name)

	IfcPresentationStyle ()

Public Member Functions inherited from OdIfc4::OdIfc4Instance
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_TextCharacterAppearance

OdDAIObjectId	m_TextStyle

OdDAI::Select	m_TextFontStyle

OdDAI::Boolean	m_ModelOrDraughting

Protected Attributes inherited from OdIfc4::IfcPresentationStyle
OdAnsiString	m_Name

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 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.

Definition at line 58 of file Ifc4/IfcTextStyleAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcTextStyle()

OdIfc4::IfcTextStyle::IfcTextStyle ( )

Default constructor for the IfcTextStyle class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcTextStyle::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 OdIfc4::IfcPresentationStyle.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcTextStyle::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.

Reimplemented from OdIfc4::IfcPresentationStyle.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcTextStyle::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 OdIfc4::IfcPresentationStyle.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcTextStyle::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 OdIfc4::IfcPresentationStyle.

◆ getModelOrDraughting()

OdDAI::Boolean OdIfc4::IfcTextStyle::getModelOrDraughting ( ) const

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.

◆ getTextCharacterAppearance()

const OdDAIObjectId & OdIfc4::IfcTextStyle::getTextCharacterAppearance ( ) const

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.

◆ getTextStyle()

const OdDAIObjectId & OdIfc4::IfcTextStyle::getTextStyle ( ) const

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.

◆ inFields()

virtual OdResult OdIfc4::IfcTextStyle::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.

Reimplemented from OdIfc4::IfcPresentationStyle.

◆ isKindOf()

virtual bool OdIfc4::IfcTextStyle::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 OdIfc4::IfcPresentationStyle.

◆ outFields()

virtual OdResult OdIfc4::IfcTextStyle::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.

Reimplemented from OdIfc4::IfcPresentationStyle.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcTextStyle::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 OdIfc4::IfcPresentationStyle.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcTextStyle::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 OdIfc4::IfcPresentationStyle.

◆ setModelOrDraughting()

void OdIfc4::IfcTextStyle::setModelOrDraughting ( OdDAI::Boolean ModelOrDraughting )

Sets the value of ModelOrDraughting attribute. ModelOrDraughting is indication whether the length measures provided for the presentation style are model based, or draughting based.

Parameters

ModelOrDraughting [in] ModelOrDraughting attribute to set.

Remarks: IFC4 CHANGE: New attribute.

◆ setTextCharacterAppearance()

void OdIfc4::IfcTextStyle::setTextCharacterAppearance ( const OdDAIObjectId & TextCharacterAppearance )

Sets the value of TextCharacterAppearance attribute. TextCharacterAppearance is a character style to be used for presented text.

Parameters

TextCharacterAppearance [in] TextCharacterAppearance to set.

Remarks: IFC4 CHANGE: Superfluous select type IfcCharacterStyleSelect has been removed.

◆ setTextStyle()

void OdIfc4::IfcTextStyle::setTextStyle ( const OdDAIObjectId & TextStyle )

Sets the value of TextStyle attribute. TextStyle is the style applied to the text block for its visual appearance.

Parameters

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.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcTextStyle::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 OdIfc4::IfcPresentationStyle.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcTextStyle::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 OdIfc4::IfcPresentationStyle.

◆ textFontStyle()

IfcTextFontSelect OdIfc4::IfcTextStyle::textFontStyle ( )

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.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcTextStyle::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 OdIfc4::IfcPresentationStyle.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcTextStyle::unsetAttr ( const char * explicitAttrName )

overridevirtual

Resets a value for the specified attribute.

Parameters

explicitAttrName [in] Explicit name of the attribute to reset.

Reimplemented from OdIfc4::IfcPresentationStyle.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcTextStyle::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 OdIfc4::IfcPresentationStyle.

Member Data Documentation

◆ m_ModelOrDraughting

OdDAI::Boolean OdIfc4::IfcTextStyle::m_ModelOrDraughting

protected

Definition at line 269 of file Ifc4/IfcTextStyleAutoImpl.h.

◆ m_TextCharacterAppearance

OdDAIObjectId OdIfc4::IfcTextStyle::m_TextCharacterAppearance

protected

Definition at line 266 of file Ifc4/IfcTextStyleAutoImpl.h.

◆ m_TextFontStyle

OdDAI::Select OdIfc4::IfcTextStyle::m_TextFontStyle

protected

Definition at line 268 of file Ifc4/IfcTextStyleAutoImpl.h.

◆ m_TextStyle

OdDAIObjectId OdIfc4::IfcTextStyle::m_TextStyle

protected

Definition at line 267 of file Ifc4/IfcTextStyleAutoImpl.h.

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

Ifc4/IfcTextStyleAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcTextStyle()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getInstanceType()

◆ getModelOrDraughting()

◆ getTextCharacterAppearance()

◆ getTextStyle()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setModelOrDraughting()

◆ setTextCharacterAppearance()

◆ setTextStyle()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ textFontStyle()

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_ModelOrDraughting

◆ m_TextCharacterAppearance

◆ m_TextFontStyle

◆ m_TextStyle