Source code for honeybee_radiance.modifier.pattern.brighttext

"""Radiance Brighttext Pattern.
from .patternbase import Pattern

# TODO: Implement the class. It's currently only a generic Radiance Primitive
[docs]class Brighttext(Pattern): """Radiance Brighttext Pattern. Brighttext is like colortext, but the writing is monochromatic. .. code-block:: shell mod brighttext id 2 fontfile textfile 0 11+ Ox Oy Oz Rx Ry Rz Dx Dy Dz foreground background [spacing] or: .. code-block:: shell mod brighttext id 2+N fontfile . This is a line with N words ... 0 11+ Ox Oy Oz Rx Ry Rz Dx Dy Dz foreground background [spacing] By default, a uniform spacing algorithm is used that guarantees every character will appear in a precisely determined position. Unfortunately, such a scheme results in rather unattractive and difficult to read text with most fonts. The optional spacing value defines the distance between characters for proportional spacing. A positive value selects a spacing algorithm that preserves right margins and indentation, but does not provide the ultimate in proportionally spaced text. A negative value insures that characters are properly spaced, but the placement of words then varies unpredictably. The choice depends on the relative importance of spacing versus formatting. When presenting a section of formatted text, a positive spacing value is usually preferred. A single line of text will often be accompanied by a negative spacing value. A section of text meant to depict a picture, perhaps using a special purpose font such as hexbit4x1.fnt, calls for uniform spacing. Reasonable magnitudes for proportional spacing are between 0.1 (for tightly spaced characters) and 0.3 (for wide spacing). Args: identifier: Text string for a unique Material ID. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files. modifier: Modifier. It can be primitive, mixture, texture or pattern. (Default: None). values: An array 3 arrays for primitive data. Each of the 3 sub-arrays refer to a line number in the radiance primitive definitions and the values in each array correspond to values occurring within each line. is_opaque: A boolean to indicate whether this primitive is opaque. dependencies: A list of primitives that this primitive depends on. This argument is only useful for defining advanced primitives that are defined based on other primitives. (Default: []). Properties: * identifier * display_name * values * modifier * dependencies * is_modifier * is_material * is_opaque """ __slots__ = () pass