Share

acedGetOrient

C++

int acedGetOrient(
    const ads_point pt, 
    const ACHAR * prompt, 
    double * result
);

File

acedads.h

Description

Gets user input for an angle.

The AutoCAD user can specify the angle by entering a number in the current angular units format. The user can specify the angle also by specifying two 2D locations on the graphics screen. AutoCAD draws a rubber-band line from the first point to the current crosshair position to help the user visualize the angle. If the pt argument is not null, AutoCAD uses this value as the first of the two points. The angle is measured in the XY plane of the current UCS (acedGetOrient() ignores the Z field of pt). The direction of angular increase is always counterclockwise.

Regardless of the method used to specify the angle, acedGetOrient() always sets result to a value expressed in radians.

The acedGetOrient() function is similar to acedGetAngle(), but it ignores the current direction of angle 0 stored in the AutoCAD ANGBASE system variable. The 0 angle employed by acedGetOrient() is always to the right: "east" or "3 o'clock."

The user cannot respond to acedGetOrient() by entering an AutoLISP expression.

The acedGetOrient() function returns one of the following: RTNORM if it succeeds, RTERROR if it fails, or RTCAN if the user cancels the request (by pressing [Esc]). It returns RTMODELESS, if the active command was registered using the ACRX_CMD_INTERRUPTIBLE flag and the document has received a modeless interrupt signal from a call to AcApDocManager::sendModelessInterrupt(). A prior call to acedInitGet() can also enable return values of RTNONE or RTKWORD.

Parameters

Parameters Description
pt Optional angle base point in the current (two-dimensional) UCS used by AutoCAD to display the point on the graphics screen, or, if not used, a null pointer
prompt Optional prompt string that acedGetOrient() displays before it pauses, or null for no prompt
result Output angle selected by the user in radians

Returns

Pointer to the entered angle, a memory area large enough to store a double-precision floating-point number.

Previous Declaration

AutoCAD 2024 and earlier

int acedGetOrient (const ads_point pt, const ACHAR *prompt, ads_real *result);

History

AutoCAD 2025

result argument changed from ads_real to double.

Was this information helpful?