OEFont¶

class OEFont

The OEFont class encapsulates properties that determine the display style of texts.

Currently the OEFont class stores the following properties:

Property	Get method	Set method	Corresponding namespace/class/type
alignment	`GetAlignment`	`SetAlignment`	`OEAlignment`
color	`GetColor`	`SetColor`	OEColor
font family	`GetFamily`	`SetFamily`	`OEFontFamily`
font size	`GetSize`	`SetSize`	None
font style	`GetStyle`	`SetStyle`	`OEFontStyle`
hyperlink	`GetHyperlink` / `HasHyperlink`	`SetHyperlink`	string
rotation angle	`GetRotationAngle`	`SetRotationAngle`	floating point number in range of \([0.0^{\circ}, 360.0^{\circ}]\)

See also

OEImageBase.DrawText method

Constructors¶

OEFont()

Default constructor that initializes an OEFont object with the following properties: See example in Figure: Example of drawing text with default OEFont object.

Default parameters of OEFont¶
Property	Default value
alignment	`OEAlignment_Default`
color	`OEBlack` = OEColor(0,0,0)
font family	`OEFontFamily_Default`
font size	12
hyperlink	empty string (i.e. no hyperlink)
font style	`OEFontStyle_Default`
rotation angles	0.0 (i.e. no rotation)

Example of drawing text with default OEFont object¶

OEFont(const OESystem::OEColor &color)

Constructor that initializes an OEFont object with the default parameters and the given OEColor.

OEFont(unsigned int family, unsigned int style, unsigned int size,
       unsigned int align, const OESystem::OEColor &color,
       double rotangle = 0.0)

Constructor that initializes an OEFont object with the given parameters.

family: The family of the font. This value has to be from the OEFontFamily namespace. See also OEFont.SetFamily method.
style: The style of the font. This value has to be from the OEFontStyle namespace. See also OEFont.SetSize method.
size: The size of the font. See also OEFont.SetSize method.
align: The alignment of the text. This value has to be from the OEAlignment namespace. See also OEFont.SetAlignment method.
color: The color of the font. See also OEFont.SetColor method.
rotangle: The rotation angle of the text. The default value is 0.0 which means no rotation is applied i.e. the text using the OEFont object is rendered horizontally. See also OEFont.SetRotationAngle method.

OEFont(const OEFont &rhs)

Copy constructors.

operator=¶

OEFont &operator=(const OEFont &rhs)

Assignment operator.

operator!=¶

bool operator!=(const OEFont &rhs) const

Determines whether two OEFont objects are different. Two OEFont objects are considered different if any of their properties (such as color, size, etc.) are different.

operator==¶

bool operator==(const OEFont &rhs) const

Determines whether two OEFont objects are equal. Two OEFont objects are considered equivalent only if all of their properties (such as color, size, etc.) are identical.

GetAlignment¶

unsigned int GetAlignment() const

Returns the alignment property of the OEFont object. The returned value is taken from the OEAlignment namespace.

See also

OEFont.SetAlignment method
OEAlignment namespace

GetColor¶

const OESystem::OEColor &GetColor() const

Returns the color of the OEFont object.

See also

OEFont.SetColor method
OEColor class

GetFamily¶

unsigned int GetFamily() const

Returns the font family property of the OEFont object. The returned value is taken from the OEFontFamily namespace.

See also

OEFont.SetFamily method
OEFontFamily namespace

GetHyperlink¶

const std::string& GetHyperlink() const

Returns the URI string associated with the OEFont object.

See also

OEFont.HasHyperlink method
OEFont.SetHyperlink method

GetRotationAngle¶

double GetRotationAngle() const

Returns the angle of the rotation that is used to render a text when using the OEFont object.

See also

OEFont.SetRotationAngle method

GetSize¶

unsigned int GetSize() const

Returns the size of the OEFont object.

See also

OEFont.SetSize method

GetStyle¶

unsigned int GetStyle() const

Returns the font style property of the OEFont object. The returned value is taken from the OEFontStyle namespace.

See also

OEFont.SetStyle method
OEFontStyle namespace

HasHyperlink¶

bool HasHyperlink() const

Returns whether an URI string is associated with the OEFont object.

See also

OEFont.GetHyperlink method
OEFont.SetHyperlink method

SetAlignment¶

void SetAlignment(unsigned int align)

Sets the alignment property of the OEFont object.

align: This value has to be from the OEAlignment namespace.

Example (Figure: Example of using the SetAlignment method)

font = oedepict.OEFont()
font.SetAlignment(oedepict.OEAlignment_Right)

Example of using the SetAlignment method¶

See also

OEFont.GetAlignment method
OEAlignment namespace

SetColor¶

void SetColor(const OESystem::OEColor &color)

Sets the color of the OEFont object.

Example (Figure: Example of using the SetColor method)

font = oedepict.OEFont()
font.SetColor(oechem.OERed)

Example of using the SetColor method¶

See also

OEFont.GetColor method
OEColor class

SetFamily¶

void SetFamily(unsigned int family)

Sets the font family property of the OEFont object.

family: This value has to be from the OEFontFamily namespace.

Example (Figure: Example of using the SetFamily method)

font = oedepict.OEFont()
font.SetFamily(oedepict.OEFontFamily_Times)

Example of using the SetFamily method¶

See also

OEFont.GetFamily method
OEFontFamily namespace

SetHyperlink¶

void SetHyperlink(const string& uri)

Associates URI string with the OEFont object.

uri: After associating a valid URI with a OEFont object, texts drawn with the given font become “click-able” and by clicking on them will send you to the given address.

Example (Figure: Example of using the SetHyperlink method)

mol = oechem.OEGraphMol()
oechem.OESmilesToMol(mol, "OC(=O)c1ccccc1")
oedepict.OEPrepareDepiction(mol)

width, height = 150.0, 150.0
image = oedepict.OEImage(width, height)
opts = oedepict.OE2DMolDisplayOptions(width, height, oedepict.OEScale_AutoScale)
opts.SetTitleLocation(oedepict.OETitleLocation_Bottom)

# associate font with URI

font = oedepict.OEFont(oedepict.OEFontFamily_Default, oedepict.OEFontStyle_Default, 10,
                       oedepict.OEAlignment_Center, oechem.OEBlue)
font.SetHyperlink("http://www.eyesopen.com/oedepict-tk")

opts.SetTitleFont(font)
mol.SetTitle("Generated by OEDepict")

disp = oedepict.OE2DMolDisplay(mol, opts)
oedepict.OERenderMolecule(image, disp)

oedepict.OEWriteImage("DepictMolWithHyperlink.pdf", image)
oedepict.OEWriteImage("DepictMolWithHyperlink.svg", image)

../../_images/DepictMolWithHyperlink.svg

Example of using the SetHyperlink method¶

(Clicking on the blue text at the bottom send you to the OEDepict TK web page)

Note

Associating texts with hyperlinks is only available for .pdf and .svg image formats.

Warning

OEDepict TK does not check whether the given string is a valid URI.

It is recommended to always keep the URI scheme prefix of the URI string for the sake of compatibility. For example, some application can interpret the www.eyesopen.com string as a valid URI, others only work when using http://www.eyesopen.com.

See also

OEFont.GetHyperlink method
OEFont.GetHyperlink method

SetRotationAngle¶

void SetRotationAngle(double angle)

Sets the rotation angle of the OEFont object.

angle: The rotation angle of the text (in degrees). The value of the angle has to be in a range of \([0.0^{\circ}, 360.0^{\circ}]\).

Example (Figure: Example of using the SetRotationAngle method)

font = oedepict.OEFont()
font.SetRotationAngle(180.0)

../../_images/OEFont_SetRotationAngle.png

Example of using the SetRotationAngle method¶

Note

The angles are interpreted in an anti-clockwise direction. The \(0.0^{\circ}\) and \(360.0^{\circ}\) degrees are at the 3 o’clock position i.e. the text is rendered horizontally. While the \(180.0^{\circ}\) degrees corresponds to rendering the text upside down. See examples in Figure: Example of drawing texts with various rotation angle.

../../_images/OEImageBase-DrawText-Rotations.png

Example of drawing texts with various rotation angles¶

See also

OEFont.GetRotationAngle method

SetSize¶

void SetSize(unsigned int size)

Sets the size of the OEFont object.

Example (Figure: Example of using the SetSize method)

font = oedepict.OEFont()
font.SetSize(30)

Example of using the SetSize method¶

See also

OEFont.GetSize method

SetStyle¶

void SetStyle(unsigned int style)

Sets the font style property (such as bold, italic etc.) of the OEFont object.

style: This value has to be from the OEFontStyle namespace.

Example (Figure: Example of using the SetStyle method)

font = oedepict.OEFont()
font.SetStyle(oedepict.OEFontStyle_Bold | oedepict.OEFontStyle_Italic)

Example of using the SetStyle method¶

See also

OEFont.GetStyle method
OEFontStyle namespace