TextBatchPrimitiveFactory

class ansys.stk.core.graphics.TextBatchPrimitiveFactory

Render one or more strings in the 3D scene. For best performance, avoid creating lots of batches with only a few strings each. See the Batching Performance Overview.

Overview

Methods

initialize_with_graphics_font	Initialize a marker batch primitive with the specified font. This is equivalent to constructing a text batch with the specified font and a set hint of Frequent.
initialize_with_graphics_font_and_set_hint	Initialize a marker batch primitive with the specified font and setHint.
initialize_with_graphics_font_and_set_hint_2d	Initialize a text batch primitive with the specified font and setHint, optimized for 2d screen space rendering.

Import detail

from ansys.stk.core.graphics import TextBatchPrimitiveFactory

Method detail

TextBatchPrimitiveFactory.initialize_with_graphics_font(self, font: GraphicsFont) → TextBatchPrimitive

Initialize a marker batch primitive with the specified font. This is equivalent to constructing a text batch with the specified font and a set hint of Frequent.

Parameters:

font : GraphicsFont

Returns:

TextBatchPrimitive

TextBatchPrimitiveFactory.initialize_with_graphics_font_and_set_hint(self, font: GraphicsFont, set_hint: SetHint) → TextBatchPrimitive

Initialize a marker batch primitive with the specified font and setHint.

Parameters:

font : GraphicsFont

set_hint : SetHint

Returns:

TextBatchPrimitive

TextBatchPrimitiveFactory.initialize_with_graphics_font_and_set_hint_2d(self, font: GraphicsFont, set_hint: SetHint, render_in_screen_space: bool) → TextBatchPrimitive

Initialize a text batch primitive with the specified font and setHint, optimized for 2d screen space rendering.

Parameters:

font : GraphicsFont

set_hint : SetHint

render_in_screen_space : bool

Returns:

TextBatchPrimitive