Description

Gets or sets the per-batch eye offset, which is applied to each string in the text batch. The array contains the components of the offset arranged in the order x, y, z.

Property type

Read-write property

Syntax

[Visual Basic .NET]
Public Property EyeOffset() As System.Array

[C#]
public System.Array EyeOffset {get; set;}

[Managed C++]
public: __property System::Array get_EyeOffset(); public: __property void set_EyeOffset( System::Array );

[Managed C++]

public: __property System::Array get_EyeOffset();
public: __property void set_EyeOffset(
    System::Array
);

[Unmanaged C++]
public: HRESULT get_EyeOffset( SAFEARRAY * * ppRetVal ); public: HRESULT put_EyeOffset( SAFEARRAY * EyeOffset );

[Unmanaged C++]

public: HRESULT get_EyeOffset(
    SAFEARRAY * * ppRetVal
);
public: HRESULT put_EyeOffset(
    SAFEARRAY * EyeOffset
);

[Java]
public AgSafeArray getEyeOffset(); public void setEyeOffset( AgSafeArray );

[Python - STK API ]
@property def EyeOffset(self) -> list: @EyeOffset.setter def EyeOffset(self, EyeOffset:list) -> None:

[Python - STK API

]

@property
def EyeOffset(self) -> list:

@EyeOffset.setter
def EyeOffset(self, EyeOffset:list) -> None:

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.

If per-string eye offsets were specified with Set Eye Offsets the per-batch eye offset is ignored.

Example

Shows the format of the EyeOffset property when setting the per-batch eye offset.

[C#]

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

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