TextBatchPrimitiveOptionalParameters#

class ansys.stk.core.graphics.TextBatchPrimitiveOptionalParameters#: Optional per-string and per-batch parameters for text batch primitive…

Overview#

Methods

`set_origins`	Define a collection of origins, one for each string in the batch.
`set_eye_offsets`	Define a collection of eye offsets, one for each string in the batch.
`set_pixel_offsets`	Define a collection of pixel offsets, one for each string in the batch.
`set_colors`	Define a collection of colors, one for each string in the batch.

Properties

`origin`	Get or set the per-batch origin, which is applied to each string in the text batch.
`eye_offset`	Get or set the per-batch eye offset, which is applied to each string in the text batch. The array contains the components of the offset arranged in the order x, y, z.
`pixel_offset`	Get or set the per-batch pixel offset, which is applied to each string in the text batch. The array contains one x pixel offset followed by one y pixel offset.
`maximum_string_length`	Get or set the maximum length of each string in the text batch.
`screen_space_rendering`	Get or set a flag that informs the CTextBatchPrimitive to use rendering optimized for screen space text.

from ansys.stk.core.graphics import TextBatchPrimitiveOptionalParameters

property TextBatchPrimitiveOptionalParameters.origin: Origin#: Get or set the per-batch origin, which is applied to each string in the text batch.

property TextBatchPrimitiveOptionalParameters.eye_offset: list#: Get or set the per-batch eye offset, which is applied to each string in the text batch. The array contains the components of the offset arranged in the order x, y, z.

property TextBatchPrimitiveOptionalParameters.pixel_offset: list#: Get or set the per-batch pixel offset, which is applied to each string in the text batch. The array contains one x pixel offset followed by one y pixel offset.

property TextBatchPrimitiveOptionalParameters.maximum_string_length: int#: Get or set the maximum length of each string in the text batch.

property TextBatchPrimitiveOptionalParameters.screen_space_rendering: bool#: Get or set a flag that informs the CTextBatchPrimitive to use rendering optimized for screen space text.

TextBatchPrimitiveOptionalParameters.set_origins(self, origins: list) → None#

Define a collection of origins, one for each string in the batch.

TextBatchPrimitiveOptionalParameters.set_eye_offsets(self, eye_offsets: list) → None#

Define a collection of eye offsets, one for each string in the batch.

TextBatchPrimitiveOptionalParameters.set_pixel_offsets(self, pixel_offsets: list) → None#

Define a collection of pixel offsets, one for each string in the batch.

TextBatchPrimitiveOptionalParameters.set_colors(self, colors: list) → None#

Define a collection of colors, one for each string in the batch.