Class Ifc2x3::IfcTextStyleWithBoxCharacteristics

Nested Relationships

This class is a nested type of Struct Ifc2x3.

Inheritance Relationships

Base Type

Class Documentation

class Ifc2x3::IfcTextStyleWithBoxCharacteristics : public IfcUtil::IfcBaseEntity

The text style with box characteristics allows the presentation of annotated text by specifying the characteristics of the character boxes of the text and the spacing between the character boxes.

NOTE The IfcTextStyleWithBoxCharacteristics is an entity that had been adopted from ISO 10303, Industrial automation systems and integration—Product data representation and exchange, Part 46: Integrated generic resources: Visual presentation.

The IfcTextStyleWithBoxCharacteristics is mainly used to provide some compatibility with ISO10303. Its usage is restricted to monospace text fonts (having uniform character boxes) and simple vector based text fonts. For true text fonts however the use of IfcTextStyleTextModel is required.

Figure 296 (from ISO 10303-46, page 91) illustrates angles. Figure 297 illustrates attribute use.

Figure 296 — Text style box angles Figure 297 — Text style box attributes

NOTE Corresponding ISO 10303 name: text_style_with_box_characteristics. Please refer to ISO/IS 10303-46:1994, p. 123 for the final definition of the formal standard. The four optional attributes BoxHeight, BoxWidth, BoxSlantAngle, BoxRotateAngle are included directly at the entity, and are not handled through the box_characteristic_select selecting box_height, box_width, box_slant_angle, box_rotate_angle, each being defined types. The CharacterSpacing attribute has been added from ISO/IS 10303-46:1994 entity text_style_with_spacing.

HISTORY New entity in IFC2x2.

IFC2x3 CHANGE The attribute item CharacterSpacing has been added.

Public Types

typedef IfcTemplatedEntityList<IfcTextStyleWithBoxCharacteristics> list

Public Functions

bool hasBoxHeight() const

Whether the optional attribute BoxHeight is defined for this IfcTextStyleWithBoxCharacteristics.

double BoxHeight() const

It is the height scaling factor in the definition of a character glyph.

void setBoxHeight(double v)
bool hasBoxWidth() const

Whether the optional attribute BoxWidth is defined for this IfcTextStyleWithBoxCharacteristics.

double BoxWidth() const

It is the width scaling factor in the definition of a character glyph.

void setBoxWidth(double v)
bool hasBoxSlantAngle() const

Whether the optional attribute BoxSlantAngle is defined for this IfcTextStyleWithBoxCharacteristics.

double BoxSlantAngle() const

It indicated that the box of a character glyph shall be represented as a parallelogram, with the angle being between the character up line and an axis perpendicular to the character base line.

void setBoxSlantAngle(double v)
bool hasBoxRotateAngle() const

Whether the optional attribute BoxRotateAngle is defined for this IfcTextStyleWithBoxCharacteristics.

double BoxRotateAngle() const

It indicated that the box of a character glyph shall be 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.

void setBoxRotateAngle(double v)
bool hasCharacterSpacing() const

Whether the optional attribute CharacterSpacing is defined for this IfcTextStyleWithBoxCharacteristics.

::Ifc2x3::IfcSizeSelect *CharacterSpacing() const

The distance between the character boxes of adjacent characters.

void setCharacterSpacing(::Ifc2x3::IfcSizeSelect *v)
const IfcParse::entity &declaration() const
IfcTextStyleWithBoxCharacteristics(IfcEntityInstanceData *e)
IfcTextStyleWithBoxCharacteristics(boost::optional<double> v1_BoxHeight, boost::optional<double> v2_BoxWidth, boost::optional<double> v3_BoxSlantAngle, boost::optional<double> v4_BoxRotateAngle, ::Ifc2x3::IfcSizeSelect *v5_CharacterSpacing)

Public Static Functions

const IfcParse::entity &Class()