AGI STK Graphics 11 Send comments on this topic.
IAgStkGraphicsTextBatchPrimitive Interface Members
See Also  Overview 

Public Methods

Public Method Set Defines the positions and text of strings in a text batch. The strings are rendered in the primitive's Reference Frame.
Public Method SetCartographic 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.
Public Method SetCartographicWithOptionalParameters 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.
Public Method SetCartographicWithOptionalParametersAndRenderPass 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.
Public Method SetPartial Updates a subset of positions and/or text in a text batch.
Public Method SetPartialCartographic 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 Set Partial.
Public Method SetPartialCartographicWithIndicesOrder 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 Set Partial.
Public Method SetPartialCartographicWithOptionalParameters 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 Set Partial.
Public Method SetPartialCartographicWithOptionalParametersIndicesOrderAndRenderPass 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 Set Partial.
Public Method SetPartialWithIndicesOrder Updates a subset of positions and/or text in a text batch.
Public Method SetPartialWithOptionalParameters Updates a subset of positions, text, and/or optional per-string parameters in a text batch.
Public Method SetPartialWithOptionalParametersIndicesOrderAndRenderPass Updates a subset of positions, text, and/or optional per-string parameters in a text batch.
Public Method SetWithOptionalParameters Defines the positions, text, and optional parameters of strings in a text batch. The strings are rendered in the primitive's Reference Frame.
Public Method SetWithOptionalParametersAndRenderPass Defines the positions, text, and optional parameters of strings in a text batch. The strings are rendered in the primitive's Reference Frame. renderPassHint is provided for efficiency.

Public Properties

Public Property AlignToPixel Gets or sets whether the screen space position of each string is aligned to a pixel.
Public Property BoundingSphereScale Gets or sets the scale applied to the radius of this primitive's bounding sphere.
Public Property DistanceDisplayConditionPerString Gets or sets a Distance Display Condition that is evaluated per string in the text batch during rendering. This is different than Display Condition, which is evaluated once for the entire text batch. When DistanceDisplayConditionPerString is null, no per string display condition is evaluated.
Public Property Font Gets the font used to render the text batch.
Public Property OutlineColor Gets or sets the text's outline color.
Public Property OutlineTranslucency Gets or sets the text's outline translucency. Translucency is between 0 and 1, where 0 is opaque and 1 is transparent.
Public Property 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.
Public Property RenderInScreenSpace Gets or sets whether the primitive is positioned and rendered in screen space coordinates.
Public Property SetHint Gets the primitive's Set Hint. See the Set Hint Performance Overview for selecting an appropriate value to construct the primitive with.
Public Property TextureFilter Gets or sets the filter used to filter the texture-based Font.

See Also

© 2016 Analytical Graphics, Inc. All Rights Reserved.

STK 11.1 Programming Interface