Type Method

textWithString:extrusionDepth:

Creates a text geometry from a specified string, extruded with a specified depth.

Declaration

+ (instancetype)textWithString:(id)string extrusionDepth:(CGFloat)extrusionDepth;

Parameters

string

An NSString or NSAttributedString object containing text from which to create the geometry.

extrusionDepth

The extent of the text geometry in the Z dimension of its local coordinate space. Specify a depth of 0.0 to create 2D text confined to a plane.

Return Value

A new text geometry.

Discussion

In the local coordinate system of the text geometry, the origin corresponds to the lower left corner of the text’s layout rectangle, with the text extending in the x- and y-axis dimensions. (SceneKit computes a layout rectangle automatically, or you can specify one using the containerFrame property.) The geometry is centered along its z-axis. For example, if its extrusionDepth property is 1.0, the geometry extends from -0.5 to 0.5 along the z-axis. An extrusion depth of zero creates a flat, one-sided shape—the geometry is confined to the plane whose z-coordinate is 0.0, and viewable only from its front unless its material’s doubleSided property is YES.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software