F_VN_ClipLineToBoundary

Syntax

Definition:

FUNCTION F_VN_ClipLineToBoundary : HRESULT
VAR_IN_OUT
    aLine       : TcVnVector4_LREAL;
END_VAR
VAR_INPUT
    nX1         : DINT;
    nY1         : DINT;
    nX2         : DINT;
    nY2         : DINT;
END_VAR
VAR_IN_OUT
    aStartPoint : TcVnPoint2_REAL;
    aEndPoint   : TcVnPoint2_REAL;
END_VAR
VAR_INPUT
    hrPrev      : HRESULT;
END_VAR

Inputs

Name	Type	Description
nX1	DINT	x of top left rectangle point
nY1	DINT	y of top left rectangle point
nX2	DINT	x of bottom right rectangle point
nY2	DINT	Y of bottom right rectangle point
hrPrev	HRESULT	HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.)

In/Outputs

Name	Type	Description
aLine	TcVnVector4_LREAL	The first and second element describe the x and y component of the direction vector. The third and fourth element describe the x and y component of the position vector.
aStartPoint	TcVnPoint2_REAL	Returns the clipped starting point of the line.
aEndPoint	TcVnPoint2_REAL	Returns the clipped end point of the line.

Return value

HRESULT

Further information

This function adjusts a line to a specified area.

Different functions exist for various definition forms in this area:

Definition of the rectangular area	Function to be used
Specified by individual X/Y coordinates	F_VN_ClipLineToBoundary
By the size of an image	F_VN_ClipLineToBoundary_ITcVnImage
By a rectangular structure	F_VN_ClipLineToBoundary_TcVnRectangle_DINT

Required License

TC3 Vision Base

System Requirements

Development environment	Target platform	PLC libraries to include
TwinCAT V3.1.4024.54 or later	PC or CX (x64) with PL50, e.g. Intel 4-core Atom CPU	Tc3_Vision