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

EyeOffsets: An array containing the x, y, and z eye offset for each string in the batch. There must be one x eye offset, followed by one y eye offset, followed by one z eye offset for each string passed to the Text Batch Primitive's Set or SetPartial method.

Description

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

Syntax

[Visual Basic .NET]
Public Sub SetEyeOffsets( _ ByVal EyeOffsets As System.Array _ )

[C#]
public void SetEyeOffsets( System.Array EyeOffsets );

[Managed C++]
public: void SetEyeOffsets( System::Array ^ EyeOffsets );

[Unmanaged C++]
public: HRESULT SetEyeOffsets( SAFEARRAY * * EyeOffsets );

[Java]
public void setEyeOffsets( AgSafeArray EyeOffsets );

[Python - STK API ]
def SetEyeOffsets(self, EyeOffsets:list) -> None:

Parameters

EyeOffsets: An array containing the x, y, and z eye offset for each string in the batch. There must be one x eye offset, followed by one y eye offset, followed by one z eye offset for each string passed to the Text Batch Primitive's Set or SetPartial method.

Remarks

Eye offsets define an eye-space translation. In eye-space, the x axis points to the right, the y axis points up, and the z axis points into the screen. Eye offsets are commonly used when more than one primitive is located at the same position. For example, if a string in a text batch is located at the same position as a model primitive, an eye offset in the positive y direction can be applied to the string so it appears a specified distance above the model.

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

Example

Shows the format of the EyeOffsets parameter when setting per string eye offsets.

[C#]

Array eyeoffset = new object[]
{
    2, 3, 4,
    2, 3, 4
};

IAgStkGraphicsTextBatchPrimitiveOptionalParameters parameters = sceneManager.Initializers.TextBatchPrimitiveOptionalParameters.Initialize();
parameters.SetEyeOffsets(ref eyeoffset);