#include <IfcTextLiteralAutoImpl.h>

Inheritance diagram for OdIfc2x2_final::IfcTextLiteral:

Public Member Functions
const OdAnsiString &	getLiteral () const

void	setLiteral (const OdAnsiString &Literal)

IfcAxis2Placement	placement ()

const OdAnsiString &	getAlignment () const

void	setAlignment (const OdAnsiString &Alignment)

IfcTextPath	getPath () const

void	setPath (IfcTextPath Path)

IfcFontSelect	font ()

	IfcTextLiteral ()

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 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 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
OdAnsiString	m_Literal

OdDAI::Select	m_Placement

IfcTextAlignment	m_Alignment

OdDAI::Enum	m_Path

OdDAI::Select	m_Font

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 text literal is a geometric representation item which describes a text string using a string literal and additional position and path information. The text size and appearance is determined by the IfcTextStyle that is associated to the IfcTextLiteral through an IfcStyledItem. The text string is placed within the planar extent (the box) defined within the subtype IfcTextLiteralWithExtent.

Definition at line 42 of file Ifc2x2_Final/IfcTextLiteralAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcTextLiteral()

OdIfc2x2_final::IfcTextLiteral::IfcTextLiteral ( )

Default constructor for the IfcTextLiteral class.

Member Function Documentation

◆ font()

IfcFontSelect OdIfc2x2_final::IfcTextLiteral::font ( )

Returns the value of Font attribute. This attribute represents the predefined or externally defined font which is used for presenting the text literal.

Returns: Returns the value of Font attribute.

◆ getAlignment()

const OdAnsiString & OdIfc2x2_final::IfcTextLiteral::getAlignment ( ) const

Returns the value of Alignment attribute. This attribute represents the alignment of the text literal relative to its position.

Returns: Returns the value of Alignment attribute.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x2_final::IfcTextLiteral::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 in OdIfc2x2_final::IfcTextLiteralWithExtent.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x2_final::IfcTextLiteral::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x2_final::IfcTextLiteralWithExtent.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x2_final::IfcTextLiteral::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 OdIfc2x2_final::IfcGeometricRepresentationItem.

Reimplemented in OdIfc2x2_final::IfcTextLiteralWithExtent.

◆ getLiteral()

const OdAnsiString & OdIfc2x2_final::IfcTextLiteral::getLiteral ( ) const

Returns the value of Literal attribute. This attribute represents the text literal to be presented.

Returns: Returns the value of Literal attribute.

◆ getPath()

IfcTextPath OdIfc2x2_final::IfcTextLiteral::getPath ( ) const

Returns the value of Path attribute. This attribute represents the writing direction of the text literal.

Returns: Returns the value of Path attribute.

◆ inFields()

virtual OdResult OdIfc2x2_final::IfcTextLiteral::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 in OdIfc2x2_final::IfcTextLiteralWithExtent.

◆ isKindOf()

virtual bool OdIfc2x2_final::IfcTextLiteral::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 OdIfc2x2_final::IfcGeometricRepresentationItem.

Reimplemented in OdIfc2x2_final::IfcTextLiteralWithExtent.

◆ outFields()

virtual OdResult OdIfc2x2_final::IfcTextLiteral::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 in OdIfc2x2_final::IfcTextLiteralWithExtent.

◆ placement()

IfcAxis2Placement OdIfc2x2_final::IfcTextLiteral::placement ( )

Returns the value of Placement attribute. This attribute represents an IfcAxis2Placement that determines the placement and orientation of the presented string.

Returns: Returns the value of Placement attribute.

◆ putAttr() [1/2]

virtual bool OdIfc2x2_final::IfcTextLiteral::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x2_final::IfcTextLiteralWithExtent.

◆ putAttr() [2/2]

virtual bool OdIfc2x2_final::IfcTextLiteral::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x2_final::IfcTextLiteralWithExtent.

◆ setAlignment()

void OdIfc2x2_final::IfcTextLiteral::setAlignment ( const OdAnsiString & Alignment )

Sets the value of Alignment attribute. This attribute represents the alignment of the text literal relative to its position.

Parameters

Alignment [in] Alignment to set.

◆ setLiteral()

void OdIfc2x2_final::IfcTextLiteral::setLiteral ( const OdAnsiString & Literal )

Sets the value of Literal attribute. This attribute represents the text literal to be presented.

Parameters

Literal [in] Literal to set.

◆ setPath()

void OdIfc2x2_final::IfcTextLiteral::setPath ( IfcTextPath Path )

Sets the value of Path attribute. This attribute represents the writing direction of the text literal.

Parameters

Path	[in] Path to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x2_final::IfcTextLiteral::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x2_final::IfcTextLiteralWithExtent.

◆ testAttr() [2/2]

virtual bool OdIfc2x2_final::IfcTextLiteral::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 OdIfc::OdIfcInstance.

Reimplemented in OdIfc2x2_final::IfcTextLiteralWithExtent.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x2_final::IfcTextLiteral::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 OdIfc2x2_final::IfcGeometricRepresentationItem.

Reimplemented in OdIfc2x2_final::IfcTextLiteralWithExtent.