Tag

class Tag

Bases: Geometry

The geometry class of the tag. A tag is a text label that is always facing the camera.

Parameters:

textstr

The text of the tag.

positionUnion[compas.geometry.Point, tuple[float, float, float]]

The position of the tag.

colorcompas.colors.Color, optional

The color of the tag. Default is black.

heightfloat, optional

The height of the tag. Default is 50.

absolute_heightbool, optional

If True, the height of the tag is calculated based on the distance between the tag and the camera. Default is False.

fontos.PathLike, optional

The font of the tag. Default is FreeSans.ttf in the default config folder.

Attributes:

textstr

The text of the tag.

positioncompas.geometry.Point

The position of the tag.

colorcompas.colors.Color

The color of the tag.

heightfloat

The height of the tag.

absolute_heightbool

If True, the height of the tag is calculated based on the distance between the tag and the camera.

fontos.PathLike

The font of the tag.

Methods

transform

Transform the tag.

Inherited Methods

ToString	Converts the instance to a string.
compute_aabb	Compute the axis-aligned bounding box of the geometry.
compute_obb	Compute the oriented bounding box of the geometry.
copy	Make an independent copy of the data object.
from_json	Construct an object of this type from a JSON file.
from_jsonstring	Construct an object of this type from a JSON string.
rotate	Rotate the geometry.
rotated	Returns a rotated copy of this geometry.
scale	Scale the geometry.
scaled	Returns a scaled copy of this geometry.
sha256	Compute a hash of the data for comparison during version control using the sha256 algorithm.
to_json	Convert an object to its native data representation and save it to a JSON file.
to_jsonstring	Convert an object to its native data representation and save it to a JSON string.
transformed	Returns a transformed copy of this geometry.
translate	Translate the geometry.
translated	Returns a translated copy of this geometry.
validate_data	Validate the data against the object's data schema.