TextBatchPrimitiveSetPartial Method (IEnumerableCartesian, IEnumerableString, TextBatchPrimitiveOptionalParameters, IEnumerableInt32, IndicesOrderHint, RenderPassHint) |
Updates a subset of positions, text, and/or optional per-string parameters in a text batch.
Namespace:
AGI.Foundation.Graphics
Assembly:
AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax public void SetPartial(
IEnumerable<Cartesian> positions,
IEnumerable<string> text,
TextBatchPrimitiveOptionalParameters optionalParameters,
IEnumerable<int> indices,
IndicesOrderHint indicesOrderHint,
RenderPassHint renderPassHint
)
Public Sub SetPartial (
positions As IEnumerable(Of Cartesian),
text As IEnumerable(Of String),
optionalParameters As TextBatchPrimitiveOptionalParameters,
indices As IEnumerable(Of Integer),
indicesOrderHint As IndicesOrderHint,
renderPassHint As RenderPassHint
)
public:
void SetPartial(
IEnumerable<Cartesian>^ positions,
IEnumerable<String^>^ text,
TextBatchPrimitiveOptionalParameters^ optionalParameters,
IEnumerable<int>^ indices,
IndicesOrderHint indicesOrderHint,
RenderPassHint renderPassHint
)
member SetPartial :
positions : IEnumerable<Cartesian> *
text : IEnumerable<string> *
optionalParameters : TextBatchPrimitiveOptionalParameters *
indices : IEnumerable<int> *
indicesOrderHint : IndicesOrderHint *
renderPassHint : RenderPassHint -> unit
Parameters
- positions
- Type: System.Collections.GenericIEnumerableCartesian
A collection of new positions used to update a subset of positions in the text batch. - text
- Type: System.Collections.GenericIEnumerableString
A collection of new text used to update a subset of text in the text batch. - optionalParameters
- Type: AGI.Foundation.GraphicsTextBatchPrimitiveOptionalParameters
Optional per-batch parameters or per-string parameters corresponding to positions.
Each per-string parameter must have the same number of elements as positions.
- indices
- Type: System.Collections.GenericIEnumerableInt32
A collection of zero-based indices that map a corresponding position in
positions to a position already in the primitive.
For example, if a primitive is first given 5 positions with
a call to Set, positions 1 and 3 can be modified
with SetPartial by passing in positions containing
two new positions and an indices collection with two
elements, e.g. [1, 3]. The first position in positions
will modify the position at index 1 in the primitive and the second
will modify the position at index 3.
- indicesOrderHint
- Type: AGI.Foundation.Graphics.AdvancedIndicesOrderHint
An optimization hint indicating how indices are sorted.
- renderPassHint
- Type: AGI.Foundation.Graphics.AdvancedRenderPassHint
An optimization hint indicating the RenderPass
implied by per-marker colors defined in optionalParameters.
Exceptions Remarks
To call SetPartial, the primitive must be constructed with
Partial
so the primitive builds the data structures necessary for partial
updates. See the Set Hint topic for more information on
selecting an appropriate value.
If the primitive's
AutomaticallyComputeBoundingSphere
property is , the primitive's
BoundingSphere
is computed based the primitive's unmodified positions and the updated positions from the
positions collection.
Otherwise, it is the caller's responsibility to update the primitive's
BoundingSphere
to a sphere that encompasses all the positions in the primitive.
See Also