Protected	`function WantsGlobalId: Boolean; virtual;`
Protected	`class function IfcClassName: String; virtual;`
Public	`constructor Create(AOwner: TComponent); override;`
Public	`function BuildNode(const Mapping: TCastleIfcMapping; const ParentProduct: TIfcProduct; const LitAppearance, UnlitAppearance: TAppearanceNode): TAbstractChildNode; override;`
Public	`procedure SetFontSize(const Size: TIfcPositiveLengthMeasure; const FontFamily: String = 'sans-serif');`
Public	`function TryGetFontSize(out Size: Single): Boolean;`
Protected	`function GetBoxAlignment: TIfcBoxAlignment; override;`

Properties

Published	`property GlobalId: String read FGlobalId write FGlobalId;`
Published	`property LayerAssignment: TIfcPresentationLayerAssignment read FLayerAssignment write FLayerAssignment;`
Published	`property StyledByItem: TIfcStyledItem read FStyledByItem write FStyledByItem;`
Published	`property Literal: TIfcPresentableText read FLiteral write FLiteral;`
Published	`property Placement: TIfcAxis2Placement read FPlacement write FPlacement;`
Published	`property Path: TIfcTextPath read FPath write FPath default TIfcTextPath.Unknown;`
Published	`property Extent: TIfcPlanarExtent read FExtent write FExtent;`
Published	`property BoxAlignment: TIfcBoxAlignment read FBoxAlignment write FBoxAlignment;`

Description

Methods

Protected function WantsGlobalId: Boolean; virtual;

This item is declared in ancestor TIfcPersistent.

If True, instances of this class will have GlobalId auto-assigned at saving, and they will be saved as part of the "data" list in IFC JSON files.

Strictly following the spec, this should be only defined for TIfcRoot, because only IfcRoot has GlobalId. In reality, we need GlobalId at TIfcPersistent to load some files, and we sometimes need WantsGlobalId = True to save some files.

Source: scene/load/ifc/castleifc_ifc_types.inc (line 52).

Protected class function IfcClassName: String; virtual;

This item is declared in ancestor TIfcPersistent.

Name for the IFC standard, used in IFC files. By default, this is just ClassName with prefix 'T' removed.

Source: scene/load/ifc/castleifc_ifc_types.inc (line 56).

Public constructor Create(AOwner: TComponent); override;

This item is declared in ancestor TIfcTextLiteral.

This item has no description.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 2102).

Public function BuildNode(const Mapping: TCastleIfcMapping; const ParentProduct: TIfcProduct; const LitAppearance, UnlitAppearance: TAppearanceNode): TAbstractChildNode; override;

This item is declared in ancestor TIfcTextLiteral.

This item has no description. Showing description inherited from TIfcRepresentationItem.BuildNode.

Build a node to display this using Castle Game Engine. Returns Nil if not possible / not implemented.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 2103).

Public procedure SetFontSize(const Size: TIfcPositiveLengthMeasure; const FontFamily: String = 'sans-serif');

This item is declared in ancestor TIfcTextLiteral.

Set the font size (height of the font, in the model length units).

This creates the IFC structure to express it: TIfcStyledItem (assigned as our StyledByItem) with TIfcTextStyle with TIfcTextStyleFontModel. Replaces previous StyledByItem, if any.

Note: The created TIfcStyledItem.Item is left Nil, for now. The item is clear from the context (TIfcStyledItem is nested in our StyledByItem).

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 2117).

Public function TryGetFontSize(out Size: Single): Boolean;

This item is declared in ancestor TIfcTextLiteral.

Font size (height of the font, in the model length units), looking at the TIfcTextStyle in StyledByItem. Returns False if not specified (or specified in a way we don't support).

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 2123).

Protected function GetBoxAlignment: TIfcBoxAlignment; override;

This item has no description. Showing description inherited from TIfcTextLiteral.GetBoxAlignment.

Current BoxAlignment. Returns TIfcTextLiteralWithExtent.BoxAlignment or empty string, if this is not TIfcTextLiteralWithExtent.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 2153).

Properties

Published property GlobalId: String read FGlobalId write FGlobalId;

This item is declared in ancestor TIfcPersistent.

Globally unique identifier for the object instance.

Note: Not declared as TGUID, because TGUID cannot be published, but also we don't really need it: for our purposes, this identifier is just an arbitrary string.

Note: IFC 4.3 specification puts this only at IfcRoot, not at every IFC class. But testcase https://github.com/buildingsmart-community/Community-Sample-Test-Files/blob/main/IFC%204.0.2.1%20(IFC%204)/ISO%20Spec%20archive/wall-with-opening-and-window.json (from IFC 4.0) shows this can be present at any IFC class, in particular TIfcGeometricRepresentationContext.

In fact, TIfcGeometricRepresentationContext needs to have GlobalId to be successfully saved (avoid recursively trying to serialize it) in some cases. We indicate such classes with WantsGlobalId.

IFC JSON documentation says this, which seems to (unfortunately it is not unambiguous enough...) allow this at any IFC class: "Whereas the globalId attribute is only available to those elements that are descendent of the IfcRoot entity in the EXPRESS schema, we encourage a broader use of this globalId, to enable referencing between objects in a JSON file when useful.".

Source: scene/load/ifc/castleifc_ifc_types.inc (line 79).

Published property LayerAssignment: TIfcPresentationLayerAssignment read FLayerAssignment write FLayerAssignment;

This item is declared in ancestor TIfcRepresentationItem.

Assignment of the representation item to a single or multiple layer(s). Nil if none.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 393).

Published property StyledByItem: TIfcStyledItem read FStyledByItem write FStyledByItem;

This item is declared in ancestor TIfcRepresentationItem.

Reference to the IfcStyledItem that provides presentation information to the representation, e.g. a curve style, including colour and thickness to a geometric curve. Nil if none.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 399).

Published property Literal: TIfcPresentableText read FLiteral write FLiteral;

This item is declared in ancestor TIfcTextLiteral.

The text to display.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 2126).

Published property Placement: TIfcAxis2Placement read FPlacement write FPlacement;

This item is declared in ancestor TIfcTextLiteral.

Placement (position and orientation) of the text.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 2129).

Published property Path: TIfcTextPath read FPath write FPath default TIfcTextPath.Unknown;

This item is declared in ancestor TIfcTextLiteral.

Writing direction of the text. The value after creation is Right, see the constructor.

Note: The declared default below is deliberately different, Unknown, i.e. a value that never occurs in practice in IFC files and that constructor does not set. Normally the "default" should say what the constructor sets, but here we deliberately break this convention: the "default" is used by our IFC JSON writer to omit the property, and Path is a mandatory IFC attribute that we always want to write. See TIfcTextPath.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 2142).

Published property Extent: TIfcPlanarExtent read FExtent write FExtent;

Extent (size of the box) in which the text is displayed.

Note: We ignore this for now. We don't need it to honor BoxAlignment: from what I understand, both the box defined by this, and the text, place the corner at BoxAlignment.

This value would only matter to wrap or clip the text to the box, and to honor the alignment of the text within the box, given by IfcTextStyleTextModel.TextAlign . Then, the box size does shift the text, e.g. BoxAlignment = 'bottom-right' with TextAlign = 'left' means the text starts SizeInX to the left of the placement.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 2166).

Published property BoxAlignment: TIfcBoxAlignment read FBoxAlignment write FBoxAlignment;

Alignment of the text (and of the box defined by Extent). One of the 9 values allowed by TIfcBoxAlignment, like 'bottom-left'.

Source: scene/load/ifc/castleifc_ifc_standard_types.inc (line 2171).

Generated by PasDoc 1.0.4.

Castle Game Engine

API Reference

Class TIfcTextLiteralWithExtent

Unit

Declaration

Description

Hierarchy

Overview

Methods

Properties

Description

Methods

Properties