Click or drag to resize

TextBatchPrimitiveOptionalParameters Class

Optional per-string and per-batch parameters for TextBatchPrimitive. To use optional parameters, create an instance of TextBatchPrimitiveOptionalParameters, then call the desired methods or properties to define per-string and per-batch parameters, and finally pass the object to the text batch's Set or SetPartial method.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.GraphicsTextBatchPrimitiveOptionalParameters

Namespace:  AGI.Foundation.Graphics
Assembly:  AGI.Foundation.Graphics (in AGI.Foundation.Graphics.dll) Version: 20.3.405.0 (20.3.405.0)
Syntax
public sealed class TextBatchPrimitiveOptionalParameters : IDisposable

The TextBatchPrimitiveOptionalParameters type exposes the following members.

Constructors
  NameDescription
Public methodTextBatchPrimitiveOptionalParameters
Initializes default text batch primitive optional parameters.
Top
Properties
  NameDescription
Public propertyEyeOffset
Gets or sets the per-batch eye offset, which is applied to each string in the text batch.
Public propertyMaximumStringLength
Gets or sets the maximum length of each string in the text batch.
Public propertyOrigin
Gets or sets the per-batch origin, which is applied to each string in the text batch.
Public propertyPixelOffset
Gets or sets the per-batch pixel offset, which is applied to each string in the text batch.
Public propertyScreenSpaceRendering
Gets or sets a flag that informs the CTextBatchPrimitive to use rendering optimized for screen space text.
Top
Methods
  NameDescription
Public methodDispose
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodSetColors
Defines a collection of colors, one for each string in the batch.
Public methodSetDisplays
Defines a collection of boolean display flags, one for each string in the batch.
Public methodSetEyeOffsets
Defines a collection of eye offsets, one for each string in the batch.
Public methodSetOrigins
Defines a collection of origins, one for each string in the batch.
Public methodSetPixelOffsets
Defines a collection of pixel offsets, one for each string in the batch.
Public methodSetTimeIntervalDisplayConditions
Defines a collection of TimeIntervalDisplayConditions, one for each string in the batch.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also