TextBatchPrimitive Constructor (GraphicsFont, SetHint, Boolean) |
Initializes a text batch primitive with the specified font
and setHint, optimized for 2d screen space rendering.
Namespace: AGI.Foundation.Graphics
Assembly: AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 24.2.419.0 (24.2.419.0)
Syntaxpublic TextBatchPrimitive( GraphicsFont font, SetHint setHint, bool renderInScreenSpace )
Parameters
- font
- Type: AGI.Foundation.GraphicsGraphicsFont
The font used to render text in the text batch. - setHint
- Type: AGI.Foundation.GraphicsSetHint
The expected usage for Set and SetPartial methods. See the Set Hint topic for more information on selecting an appropriate value. - renderInScreenSpace
- Type: SystemBoolean
Exceptions| Exception | Condition |
|---|---|
| ArgumentNullException | font is null. |
| UnsupportedCaseException | setHint must be a valid enumeration value in SetHint. |
RemarksAfter constructing the primitive, call a method such as Set(IEnumerableCartesian, IEnumerableString) or SetCartographic(CentralBody, IEnumerableCartographic, IEnumerableString) to provide it with text.
The primitive's properties are initialized to the following values:
- AutomaticallyComputeBoundingSphere: true
- BoundingSphere: BoundingSphere.MaximumRadiusBoundingSphere
- Color: White
- Display: true
- DisplayCondition: null
- ReferenceFrame: The earth's FixedFrame
- Translucency: 0
- AlignToPixel: true
- BoundingSphereScale: 1
- DistanceDisplayConditionPerString: null
- Font: font
- OutlineColor: Blue
- OutlineTranslucency: 0
- SetHint: setHint
- TextureFilter: NearestClampToEdge
Once the primitive is constructed, it must be added to Primitives before it will be rendered.
See Also