STK Graphics Primitives	Send comments on this topic.
SetPixelOffsets Method (IAgStkGraphicsTextBatchPrimitiveOptionalParameters)
See Also

PixelOffsets: An array containing a X and Y pixel offset for each string in the batch. There must be one X pixel offset followed by one Y pixel offset for each string passed to the Text Batch Primitive's Set or SetPartial method.

Description

Defines a collection of pixel offsets, one for each string in the batch.

Syntax

[Visual Basic .NET]
Public Sub SetPixelOffsets( _ ByVal PixelOffsets As System.Array _ )

[C#]
public void SetPixelOffsets( System.Array PixelOffsets );

[Managed C++]
public: void SetPixelOffsets( System::Array ^ PixelOffsets );

[Unmanaged C++]
public: HRESULT SetPixelOffsets( SAFEARRAY * * PixelOffsets );

[Java]
public void setPixelOffsets( AgSafeArray PixelOffsets );

[Python - STK API ]
def SetPixelOffsets(self, PixelOffsets:list) -> None:

Parameters

PixelOffsets: An array containing a X and Y pixel offset for each string in the batch. There must be one X pixel offset followed by one Y pixel offset for each string passed to the Text Batch Primitive's Set or SetPartial method.

Remarks

The pixel offset defines a screen-space translation for a string from its position. Positive x values translate to the right and positive y values translate up. This is commonly used when more than one primitive is located at the same position. For example, if a string in a text batch and a point in a point batch have the same position, the string may have a pixel offset applied to it so it doesn't overlap the point.

Per-string pixel offsets override the per-batch pixel offset. Therefore, when per-string pixel offsets are defined with this method, Pixel Offset is ignored.

Example

Shows the format of the PixelOffsets parameter when setting per string pixel offsets.

[C#]

Array pixelOffset = new object[]
{
    1, 2,
    2, 1
};

IAgStkGraphicsTextBatchPrimitiveOptionalParameters parameters = sceneManager.Initializers.TextBatchPrimitiveOptionalParameters.Initialize();
parameters.SetPixelOffsets(ref pixelOffset);