CustomGraphicsGroup.addText Method

Parent Object: CustomGraphicsGroup
Defined in namespace "adsk::fusion" and the header file is <Fusion/Graphics/CustomGraphicsGroup.h>

Description

Adds a new CustomGraphicsText entity to this group. This will be displayed as a single line of text. It is placed so that the upper-left corner is at the point defined and the text will be parallel to the X-Y plane of the world coordinate system and in the X direction. To change it's position relative to the input point you can change the horizontal and vertical justification on the returned CustomGrahicsText object. You can also reorient the text by changing the transform of the returned CustomGraphicsText object.

"customGraphicsGroup_var" is a variable referencing a CustomGraphicsGroup object.returnValue = customGraphicsGroup_var.addText(formattedText, font, size, transform)

"customGraphicsGroup_var" is a variable referencing a CustomGraphicsGroup object.

#include <Fusion/Graphics/CustomGraphicsGroup.h>

returnValue = customGraphicsGroup_var->addText(formattedText, font, size, transform);

Return Value

Type	Description
CustomGraphicsText	Returns the newly created CustomGraphicsText object or null in the case of failure.

Parameters

Name	Type	Description
formattedText	string	The text string to be displayed. Overall formatting can be defined using properties on the returned CustomGraphicsText object. Formatting overrides can be defined within the string using formatting codes.
font	string	The name of the font to use when displaying the text.
size	double	The size of the text in centimeters.
transform	Matrix3D	Transformation matrix that specifies the position and orientation of the text in model space. The origin of the text is the upper-left corner.

Samples

Custom Graphics Sample

A sample demonstrating how to create custom graphics entities.

To use the sample, create a new Python or C++ script and copy and paste this code, replacing the default code. You also need to unpack this zip file which contains a resource folder into the same folder where the source code file (.py or .cpp) is.

Version

Introduced in version April 2019