BH.oM.Graphics.RenderText¶

Render text at a location and orientation in space with specified height, font and colour.

Class structure¶

Implemented interfaces and base types¶

The RenderText is inheriting from the following base type(s) and implements the following interfaces:

BH.oM.Graphics.IRender
BH.oM.Base.IObject

Properties¶

Defining properties¶

The following properties are defined on the class

Name	Type	Description	Quantity
Text	string	The text to render.	-
Cartesian	Cartesian	Cartesian to locate and orientate the text.	-
Height	double	Height of the text. Default is 1. Units will be determined by the setting of the user interface that renders the text.	-
FontName	string	Font used to render the text. Default is Arial.	-
Colour	Color	Colour used to render the text. Default is BHoM Coral with a subtle transparency (Color.FromArgb(80, 255, 41, 105)).	-

Derived properties¶

The following properties are defined as extension methods in one of the BHoM_Engines

Name	Type	Description	Quantity	Engine
IBounds	BoundingBox	Computes and returns the BoundingBox of the IRender.	-	Graphics_Engine

Code and Schema¶

C# implementation¶

C#

public class RenderText : BH.oM.Graphics.IRender, BH.oM.Base.IObject

Assembly: Graphics_oM.dll

The C# class definition is available on github:

RenderText.cs

All history and changes of the class can be found by inspection the history.

JSON Schema implementation¶

The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.

JSON Schema

{
 "$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Graphics_oM/RenderText.json"
}

The JSON Schema is available on github here:

RenderText.json