TextBatchPrimitive Class |
Renders 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 topic.
Inheritance HierarchyNamespace: AGI.Foundation.Graphics
Assembly: AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 24.2.419.0 (24.2.419.0)
SyntaxThe TextBatchPrimitive type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TextBatchPrimitive(GraphicsFont) |
Initializes a marker batch primitive with the specified font.
This is equivalent to constructing a text batch with the
specified font and
a SetHint of Frequent.
|
| TextBatchPrimitive(GraphicsFont, SetHint) |
Initializes a marker batch primitive with the specified font
and setHint.
|
| TextBatchPrimitive(GraphicsFont, SetHint, Boolean) |
Initializes a text batch primitive with the specified font
and setHint, optimized for 2d screen space rendering.
|
Properties| Name | Description | |
|---|---|---|
 | AlignToPixel |
Gets or sets whether the screen space position of each string is aligned to a pixel.
|
| AutomaticallyComputeBoundingSphere |
Gets or sets if the primitive's BoundingSphere is automatically computed.
(Inherited from Primitive.) |
| BoundingSphere |
Gets or sets the bounding sphere that encompasses the primitive.
The center is defined in the primitive's ReferenceFrame.
(Inherited from Primitive.) |
| BoundingSphereScale |
Gets or sets the scale applied to the radius of this primitive's bounding sphere.
|
| Color |
Gets or sets the color that affects every string in the batch.
(Overrides PrimitiveColor.) |
| Display |
Gets or sets if the primitive should be
rendered.
Both this and DisplayCondition must evaluate to true for
the primitive to be rendered.
(Inherited from Primitive.) |
| DisplayCondition |
Gets or sets the display condition that determines if the primitive should be
rendered.
Both this and Display must evaluate to true for
the primitive to be rendered.
(Inherited from Primitive.) |
| DistanceDisplayConditionPerString |
Gets or sets a
DistanceDisplayCondition
that is evaluated per string in the text batch during rendering. This is different than
DisplayCondition,
which is evaluated once for the entire text batch.
When DistanceDisplayConditionPerString is null, no per string display condition is evaluated.
|
| Font |
Gets the font used to render the text batch.
|
| OutlineColor |
Gets or sets the text's outline color.
|
| OutlineTranslucency |
Gets or sets the text's outline translucency.
Translucency is between 0 and 1,
where 0 is opaque and 1 is transparent.
|
| PerItemCullingEnabled |
Gets or sets whether individual text indices will be culled individually.
|
| PerItemPickingEnabled |
Gets or sets whether individual text indices will be included in the PickResults returned
from the Scene's Pick method. Each text
index that is picked will be returned as a BatchPrimitiveIndex.
|
| ReferenceFrame |
Gets or sets the reference frame this primitive is defined and rendered in.
(Inherited from Primitive.) |
| RenderInScreenSpace |
Gets or sets whether the primitive is positioned and rendered in screen space coordinates.
|
| SetHint |
Gets the primitive's SetHint.
See the Set Hint topic for more information on
selecting an appropriate value to construct the primitive with.
|
| Tag |
Gets or sets custom data associated with this primitive.
(Inherited from Primitive.) |
| TextureFilter |
Gets or sets the filter used to filter the texture-based Font.
|
| Translucency |
Gets or sets the translucency that affects every string in the batch.
Translucency is between 0 and 1,
where 0 is opaque and 1 is transparent.
(Overrides PrimitiveTranslucency.) |
Methods| Name | Description | |
|---|---|---|
| Dispose | (Inherited from Primitive.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Set(IEnumerableCartesian, IEnumerableString) |
Defines the positions and text of strings in a text batch. The strings are rendered in the primitive's
ReferenceFrame.
|
| Set(IEnumerableCartesian, IEnumerableString, TextBatchPrimitiveOptionalParameters) |
Defines the positions, text, and optional parameters of strings in a
text batch. The strings are rendered in the primitive's
ReferenceFrame.
|
| Set(IEnumerableCartesian, IEnumerableString, TextBatchPrimitiveOptionalParameters, RenderPassHint) |
Defines the positions, text, and optional parameters of strings in a
text batch. The strings are rendered in the primitive's
ReferenceFrame.
renderPassHint is provided for efficiency.
|
| SetCartographic(CentralBody, IEnumerableCartographic, IEnumerableString) |
For convenience. Defines the positions and text of strings in a text batch using
Cartographic positions.
Longitude and latitude are in radians, and altitude is in meters.
This is equivalent to
converting each position in positions to
Cartesian and calling
Set(IEnumerableCartesian, IEnumerableString).
|
| SetCartographic(CentralBody, IEnumerableCartographic, IEnumerableString, TextBatchPrimitiveOptionalParameters) |
For convenience. Defines the positions, text, and optional parameters of strings in a text batch using
Cartographic positions.
Longitude and latitude are in radians, and altitude is in meters.
This is equivalent to
converting each position in positions to
Cartesian and calling
Set(IEnumerableCartesian, IEnumerableString).
|
| SetCartographic(CentralBody, IEnumerableCartographic, IEnumerableString, TextBatchPrimitiveOptionalParameters, RenderPassHint) |
For convenience. Defines the positions, text, and optional parameters of strings in a text batch using
Cartographic positions.
Longitude and latitude are in radians, and altitude is in meters.
This is equivalent to
converting each position in positions to
Cartesian and calling
Set(IEnumerableCartesian, IEnumerableString).
|
| SetPartial(IEnumerableCartesian, IEnumerableString, IEnumerableInt32) |
Updates a subset of positions and/or text in a text batch.
|
| SetPartial(IEnumerableCartesian, IEnumerableString, TextBatchPrimitiveOptionalParameters, IEnumerableInt32) |
Updates a subset of positions, text, and/or optional per-string parameters in a text batch.
|
| SetPartial(IEnumerableCartesian, IEnumerableString, IEnumerableInt32, IndicesOrderHint) |
Updates a subset of positions and/or text in a text batch.
|
| SetPartial(IEnumerableCartesian, IEnumerableString, TextBatchPrimitiveOptionalParameters, IEnumerableInt32, IndicesOrderHint, RenderPassHint) |
Updates a subset of positions, text, and/or optional per-string parameters in a text batch.
|
| SetPartialCartographic(CentralBody, IEnumerableCartographic, IEnumerableString, IEnumerableInt32) |
For convenience. Updates a subset of positions and/or text in a text batch using
Cartographic positions.
Longitude and latitude are in radians, and altitude is in meters.
This is equivalent to
converting each position in positions to
Cartesian and calling
SetPartial(IEnumerableCartesian, IEnumerableString, IEnumerableInt32).
|
| SetPartialCartographic(CentralBody, IEnumerableCartographic, IEnumerableString, TextBatchPrimitiveOptionalParameters, IEnumerableInt32) |
For convenience. Updates a subset of positions, text, and/or per-string parameters in a text batch using
Cartographic positions.
Longitude and latitude are in radians, and altitude is in meters.
This is equivalent to
converting each position in positions to
Cartesian and calling
SetPartial(IEnumerableCartesian, IEnumerableString, TextBatchPrimitiveOptionalParameters, IEnumerableInt32).
|
| SetPartialCartographic(CentralBody, IEnumerableCartographic, IEnumerableString, IEnumerableInt32, IndicesOrderHint) |
For convenience. Updates a subset of positions and/or text in a text batch using
Cartographic positions.
Longitude and latitude are in radians, and altitude is in meters.
This is equivalent to
converting each position in positions to
Cartesian and calling
SetPartial(IEnumerableCartesian, IEnumerableString, IEnumerableInt32, IndicesOrderHint).
|
| SetPartialCartographic(CentralBody, IEnumerableCartographic, IEnumerableString, TextBatchPrimitiveOptionalParameters, IEnumerableInt32, IndicesOrderHint, RenderPassHint) |
For convenience. Updates a subset of positions, text, and/or per-string parameters in a text batch using
Cartographic positions.
Longitude and latitude are in radians, and altitude is in meters.
This is equivalent to
converting each position in positions to
Cartesian and calling
SetPartial(IEnumerableCartesian, IEnumerableString, TextBatchPrimitiveOptionalParameters, IEnumerableInt32, IndicesOrderHint, RenderPassHint).
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also