This node specifies properties used for text rendering.

The application can specify text alignment and orientation using the OIV.Inventor.Nodes.SoTextProperty.alignmentH, OIV.Inventor.Nodes.SoTextProperty.alignmentV, and OIV.Inventor.Nodes.SoTextProperty.orientation fields.

Note: Horizontal alignment can also be specified in some text nodes, for example OIV.Inventor.Nodes.SoText2 and OIV.Inventor.Nodes.SoText3, using the justification field. The value in the text node's field is used unless that field is explicitly set to INHERIT. To allow OIV.Inventor.Nodes.SoTextProperty to control horizontal justification, set the text node's justification field to INHERITED.

The application can also request use of font kerning using the OIV.Inventor.Nodes.SoTextProperty.kerning field. Kerning consists of modifying the spacing between two successive glyphs according to their outlines. For examples, a "T" and a "y" can be moved closer together as the top of the "y" fits nicely under the upper right bar of the "T". Kerning depends on the specific font being used.

Different text rendering styles such as underline, strikethrough and background rectangle can be specified using the OIV.Inventor.Nodes.SoTextProperty.style field. A color can be specified for each style using the OIV.Inventor.Nodes.SoTextProperty.styleColors field. The current material does not affect the color of a text rendering style unless the corresponding value in the OIV.Inventor.Nodes.SoTextProperty.styleColorsUseCurrentMaterial field is set to true. Text rendering styles apply to the entire string.

Text rendering effects

• Underline/overline/strike always has the same position relative to the text string, regardless of the vertical justification setting.

• The underline/overline/strike position is determined by the font and the results should be similar to what you see in other applications using the same font (e.g. MS-Word on Windows). For some fonts the underline will intersect character descenders, for example on the lower case 'g'. For some fonts the overline will intersect the top portion of some characters.

• When using BACK_FRAME and BACK_FRAME_LINE you will usually want to set the margin field to a small value, for example 0.05.

• Color can be specified separately for each style. However underline and overline are often intended to be the same color as the text. It can be convenient to set the styleColorsUseCurrentMaterial field so that the current OIV.Inventor.Nodes.SoMaterial controls both the text and the lines.

• Note that the color for each style is an RGBA value, allowing transparency to be applied. This is particularly useful for the BACK_FRAME attribute so the text background rectangle can be semi-transparent.

• As backFrameLineWidth is increased, the width of the line expands outward, away from the string (the backframe box stays the same size).

• Be sure to use the values in the StyleColor enum to set colors and inheritance flags, not the values in the Style enum. For example, use UNDERLINE_COLOR, not UNDERLINE. Open Inventor will not report an error, but the desired effect will not occur.

FILE FORMAT/DEFAULT

TextProperty {

aliasingFactor	1.0
alignmentH	LEFT
alignmentV	BASE
backFrameLineWidth	0.0
kerning	false
margin	0.0
orientation	LEFT_TO_RIGHT
textureQualityRange	150 300
style	NONE
styleColors	0.8 0.8 0.8 1
styleColorsUseCurrentMaterial	false

}

ACTION BEHAVIOR

Sets: OIV.Inventor.Elements.SoTextAlignmentHElement, OIV.Inventor.Elements.SoTextAlignmentVElement, OIV.Inventor.Elements.SoTextBackFrameLineWidthElement, OIV.Inventor.Elements.SoTextOrientationElement, OIV.Inventor.Elements.SoTextKerningElement, OIV.Inventor.Elements.SoTextMarginElement

Reference