Vector.ArcTan2 Method

function ArcTan2(Y: TMtxVec; X: TMtxVec): TMtxVec;

Inverse tangens of Y/X.

#NameTypeDescription
1YTMtxVecsource TVec or TMtx
2XTMtxVecsource TVec or TMtx

Result: stored in self (calling object), returns self for chaining

Remarks:

Calculates the inverse tangens of Y/X, and returns an angle in the correct quadrant. The results are stored in calling object elements. Size and Vector.Complex properties of calling object are adjusted automatically to match those of X and Y objects. An exception is raised if X and Y size and Vector.Complex properties do not match.

The result will fall in the range from -PI to PI radians. Note that Vector.ArcTan is calculated as ArcTan2(1, X).

See Also: Vector.ArcTan

Indexed: function ArcTan2(Y: TMtxVec; X: TMtxVec; YIndex: Integer; XIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Calculate the inverse tangens of Y/X by using Y elements [YIndex]..[YIndex+Len-1], X elements [XIndex]..[XIndex+Len-1].

#NameTypeDescription
1YTMtxVecsource TVec or TMtx
2XTMtxVecsource TVec or TMtx
3YIndexIntegerY start index
4XIndexIntegerX start index
5IndexIntegerstart index
6LenIntegerelement count

Result: stored in self (calling object), returns self for chaining

Remarks:

Store the results in calling object elements [Index]..[Index+Len-1]. An exception is raised if array borders are overrun.