Class TFontStyleNode

Description

Hierarchy

Fields

Methods

Properties

Unit

X3DNodes

Declaration

type TFontStyleNode = class(TAbstractFontStyleNode)

Description

Defines the size, family, style and other properties used for TTextNode.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 33).

Hierarchy

TObject
TPersistent
TX3DFileItem
TX3DNode
TAbstractNode
TAbstractFontStyleNode
TFontStyleNode

Overview

Fields

	`nested const DefaultSize = 1.0;`
	`nested const DefaultSpacing = 1.0;`
	`nested const DefaultFamily = ffSerif;`
	`nested const DefaultBold = false;`
	`nested const DefaultItalic = false;`
	`nested const DefaultJustify = fjBegin;`
	`nested const DefaultJustifyMinor = fjFirst;`
	`nested const DefaultBlending = true;`

Methods

	`constructor Create(const AX3DName: string = ''; const ABaseUrl: String = ''); override;`
	`destructor Destroy; override;`
	`class function ForVRMLVersion(const Version: TX3DVersion): boolean; override;`
	`function Font: TCastleFont;`
	`procedure CreateNode; override;`
	`class function ClassX3DType: String; override;`

Properties

	`property Family: TX3DFontFamily read GetFamily write SetFamily;`
	`property Justify: TX3DFontJustify read GetJustify write SetJustify;`
	`property JustifyMinor: TX3DFontJustify read GetJustifyMinor write SetJustifyMinor;`
	`property Bold: boolean read GetBold write SetBold;`
	`property Italic: boolean read GetItalic write SetItalic;`
	`property CustomFont: TCastleFont read FCustomFont write SetCustomFont;`
	`property FdFamily: TMFString read FFdFamily;`
	`property FdHorizontal: TSFBool read FFdHorizontal;`
	`property Horizontal: Boolean read GetHorizontal write SetHorizontal;`
	`property FdJustify: TMFString read FFdJustify;`
	`property FdLanguage: TSFString read FFdLanguage;`
	`property Language: String read GetLanguage write SetLanguage;`
	`property FdLeftToRight: TSFBool read FFdLeftToRight;`
	`property LeftToRight: Boolean read GetLeftToRight write SetLeftToRight;`
	`property FdSize: TSFFloat read FFdSize;`
	`property Size: Single read GetSize write SetSize;`
	`property FdSpacing: TSFFloat read FFdSpacing;`
	`property Spacing: Single read GetSpacing write SetSpacing;`
	`property FdStyle: TSFStringEnum read FFdStyle;`
	`property Style: TX3DFontStyle read GetStyle write SetStyle;`
	`property FdTopToBottom: TSFBool read FFdTopToBottom;`
	`property TopToBottom: Boolean read GetTopToBottom write SetTopToBottom;`
	`property FdBlending: TSFBool read FFdBlending;`
	`property Blending: Boolean read GetBlending write SetBlending;`

Description

Fields

nested const DefaultSize = 1.0;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 57).

nested const DefaultSpacing = 1.0;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 58).

nested const DefaultFamily = ffSerif;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 59).

nested const DefaultBold = false;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 60).

nested const DefaultItalic = false;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 61).

nested const DefaultJustify = fjBegin;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 62).

nested const DefaultJustifyMinor = fjFirst;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 63).

nested const DefaultBlending = true;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 64).

Methods

constructor Create(const AX3DName: string = ''; const ABaseUrl: String = ''); override;

This item has no description. Showing description inherited from TX3DNode.Create.

Constructor. Initializes various properties:

Name, BaseUrl are initialized from given parameters.
The Fields, Events lists are filled in every descendant, to have all the fields/events defined by the specification.
DefaultContainerField, and other node-specific stuff, is filled in descendants. This is actually implemented in CreateNode, that is called at the end of this constructor.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 66).

destructor Destroy; override;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 67).

class function ForVRMLVersion(const Version: TX3DVersion): boolean; override;

This item has no description. Showing description inherited from TX3DNode.ForVRMLVersion.

Some nodes are present only in specific VRML/X3D version. This functions decides it.

For example some nodes can only work in VRML < 2.0, some others only in VRML >= 2.0. There are even some pairs of nodes: for example TConeNode_1 works with VRML < 2.0, TConeNode works with VRML >= 2.0.

NodesManager will use this.

Default implementation of this function returns always True. Generally, I don't try to set this too aggresively — in other words, for all cases when it's sensible, I allow nodes to be used in every VRML/X3D version, even when official specification doesn't. This means that when reading VRML 1.0 files actually a large part of VRML 2.0 is allowed too, and also while reading VRML 2.0 many constructs from VRML 1.0 (officially no longer present in VRML 2.0) are allowed too. I'm trying to support what I call a "sum of VRML 1.0 and 2.0".

In practice I only use this function when various VRML/X3D versions specify the same node name but

With different fields.
For example Cone and Cylinder have slightly different fields, due to the fact that VRML 2.0 resigned from using TSFBitMask fields.
With different behavior.
For example definitions of Sphere for VRML 1.0 and 2.0 are practically equal. However, the behavior from where to take texture and material info is different — in VRML 1.0 we take last Texture2, Material etc. nodes, while in VRML 2.0 we look in parent Shape's "appearance" field. So once again two different Sphere classes are needed.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 75).

function Font: TCastleFont;

Font used by this node, determined by our fields (like Bold) and TFontStyleNode.CustomFont.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 80).

procedure CreateNode; override;

Create node fields and events.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 51).

class function ClassX3DType: String; override;

This item has no description. Showing description inherited from TX3DNode.ClassX3DType.

Node type name in VRML/X3D, for this class. Normal VRML/X3D node classes should override this to return something non-empty, and then X3DType automatically will return the same value.

Empty for classes that don't have a hardcoded VRML/X3D node name, like a special TX3DUnknownNode. Such special classes should override then X3DType to return actual non-empty name there.

You usually should call X3DType. The only use of this method is that it works on classes (it's "class function"), without needing at actual instance.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 52).

Properties

property Family: TX3DFontFamily read GetFamily write SetFamily;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 69).

property Justify: TX3DFontJustify read GetJustify write SetJustify;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 70).

property JustifyMinor: TX3DFontJustify read GetJustifyMinor write SetJustifyMinor;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 71).

property Bold: boolean read GetBold write SetBold;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 72).

property Italic: boolean read GetItalic write SetItalic;

This item has no description.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 73).

property CustomFont: TCastleFont read FCustomFont write SetCustomFont;

Adjust the font.

TODO: Currently this only allows TCastleFont. In the future it should allow any TCastleAbstractFont, like TCastleFontFamily (thus have different options for bold/italic variants) or TCastleBitmapFont.

Source: src/scene/x3d/x3dnodes_standard_text.inc (line 88).

property FdFamily: TMFString read FFdFamily;

Internal wrapper for property Family. This wrapper API may change, we advise to access simpler Family instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 56).

property FdHorizontal: TSFBool read FFdHorizontal;

Internal wrapper for property Horizontal. This wrapper API may change, we advise to access simpler Horizontal instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 60).

property Horizontal: Boolean read GetHorizontal write SetHorizontal;

This item has no description.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 62).

property FdJustify: TMFString read FFdJustify;

Internal wrapper for property Justify. This wrapper API may change, we advise to access simpler Justify instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 66).

property FdLanguage: TSFString read FFdLanguage;

Internal wrapper for property Language. This wrapper API may change, we advise to access simpler Language instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 71).

property Language: String read GetLanguage write SetLanguage;

This item has no description.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 75).

property FdLeftToRight: TSFBool read FFdLeftToRight;

Internal wrapper for property LeftToRight. This wrapper API may change, we advise to access simpler LeftToRight instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 81).

property LeftToRight: Boolean read GetLeftToRight write SetLeftToRight;

This item has no description.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 85).

property FdSize: TSFFloat read FFdSize;

Internal wrapper for property Size. This wrapper API may change, we advise to access simpler Size instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 90).

property Size: Single read GetSize write SetSize;

This item has no description.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 92).

property FdSpacing: TSFFloat read FFdSpacing;

Internal wrapper for property Spacing. This wrapper API may change, we advise to access simpler Spacing instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 96).

property Spacing: Single read GetSpacing write SetSpacing;

This item has no description.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 98).

property FdStyle: TSFStringEnum read FFdStyle;

Internal wrapper for property Style. This wrapper API may change, we advise to access simpler Style instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 102).

property Style: TX3DFontStyle read GetStyle write SetStyle;

This item has no description.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 104).

property FdTopToBottom: TSFBool read FFdTopToBottom;

Internal wrapper for property TopToBottom. This wrapper API may change, we advise to access simpler TopToBottom instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 109).

property TopToBottom: Boolean read GetTopToBottom write SetTopToBottom;

This item has no description.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 113).

property FdBlending: TSFBool read FFdBlending;

Internal wrapper for property Blending. This wrapper API may change, we advise to access simpler Blending instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 118).

property Blending: Boolean read GetBlending write SetBlending;

This item has no description.

Source: src/scene/x3d/auto_generated_node_helpers/x3dnodes_fontstyle.inc (line 120).

Generated by PasDoc 0.17.0.snapshot.

API Reference

Class TFontStyleNode

Unit

Declaration

Description

Hierarchy

Overview

Fields

Methods

Properties

Description

Fields

Methods

Properties