#include <EdBaseUserIO.h>
Inheritance diagram for OdEdBaseUserIO:
Public Member Functions | |
| ODRX_DECLARE_MEMBERS (OdEdBaseUserIO) | |
| virtual OdGePoint3d | getLASTPOINT () const =0 |
| virtual void | setLASTPOINT (const OdGePoint3d &pt)=0 |
| virtual OdEdPointDefTrackerPtr | createRubberBand (const OdGePoint3d &base, OdGsModel *pModel=NULL) const =0 |
| virtual OdEdPointDefTrackerPtr | createRectFrame (const OdGePoint3d &base, OdGsModel *pModel=NULL) const =0 |
| virtual OdGePoint3d | getPoint (const OdString &prompt, int options=OdEd::kGptDefault, const OdGePoint3d *pDefaultValue=0, const OdString &keywords=OdString::kEmpty, OdEdPointTracker *pTracker=0)=0 |
| virtual double | getAngle (const OdString &prompt, int options=OdEd::kInpDefault, double defaultValue=0.0, const OdString &keywords=OdString::kEmpty, OdEdRealTracker *pTracker=0)=0 |
| virtual double | getDist (const OdString &prompt, int options=OdEd::kInpDefault, double defaultValue=0.0, const OdString &keywords=OdString::kEmpty, OdEdRealTracker *pTracker=0)=0 |
 Public Member Functions inherited from OdEdUserIO | |
| ODRX_DECLARE_MEMBERS (OdEdUserIO) | |
| virtual bool | interactive () |
| virtual int | getKeyword (const OdString &prompt, const OdString &keywords, int defVal=-1, int options=OdEd::kInpDefault, OdEdIntegerTracker *pTracker=0)=0 |
| virtual int | getInt (const OdString &prompt, int options=OdEd::kInpDefault, int defVal=0, const OdString &keywords=OdString::kEmpty, OdEdIntegerTracker *pTracker=0)=0 |
| virtual double | getReal (const OdString &prompt, int options=OdEd::kInpDefault, double defVal=0.0, const OdString &keywords=OdString::kEmpty, OdEdRealTracker *pTracker=0)=0 |
| virtual OdString | getString (const OdString &prompt, int options=OdEd::kInpDefault, const OdString &defValue=OdString::kEmpty, const OdString &keywords=OdString::kEmpty, OdEdStringTracker *pTracker=0)=0 |
| virtual void | putString (const OdString &string)=0 |
| virtual OdSharedPtr< OdCmColorBase > | getCmColor (const OdString &prompt, int options=OdEd::kInpDefault, const OdCmColorBase *pDefaultValue=0, const OdString &keywords=OdString::kEmpty, OdEdColorTracker *pTracker=0)=0 |
| virtual OdString | getFilePath (const OdString &prompt, int options=OdEd::kGfpForOpen, const OdString &dialogCaption=OdString::kEmpty, const OdString &defExt=OdString::kEmpty, const OdString &fileName=OdString::kEmpty, const OdString &filter=OdString::kEmpty, const OdString &keywords=OdString::kEmpty, OdEdStringTracker *pTracker=0) |
| virtual void | putError (const OdString &errmsg) |
| Public Member Functions inherited from OdRxObject | |
| ODRX_HEAP_OPERATORS () | |
| OdRxObject () | |
| virtual | ~OdRxObject () |
| virtual OdRxObject * | queryX (const OdRxClass *pClass) const |
| virtual OdRxObject * | x (const OdRxClass *pClass) const |
| virtual OdRxClass * | isA () const |
| virtual void | addRef ()=0 |
| virtual void | release ()=0 |
| virtual long | numRefs () const |
| bool | isKindOf (const OdRxClass *pClass) const |
| virtual OdRxObjectPtr | clone () const |
| virtual void | copyFrom (const OdRxObject *pSource) |
| virtual OdRx::Ordering | comparedTo (const OdRxObject *pOther) const |
| virtual bool | isEqualTo (const OdRxObject *pOther) const |
Additional Inherited Members | |
| Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Detailed Description
This class implements geometric interactive user IO functionality for custom interactive command objects. Corresponding C++ library: TD_Root <group OdEd_Classes>
Definition at line 54 of file EdBaseUserIO.h.
Member Function Documentation
◆ createRectFrame()
|
pure virtual |
Implemented in CFxUserIO.
◆ createRubberBand()
|
pure virtual |
Implemented in CFxUserIO.
◆ getAngle()
|
pure virtual |
Returns user input of an angle.
- Parameters
-
prompt [in] Message displayed to prompt the user. options [in] Combination of OdEd::GetPointOptions enum values. defaultValue [in] Default value to return if an empty string is received as input. keywords [in] Keyword string. pTracker [in] Pointer to a User IO tracker.
- Remarks
- This function uses the underlying OdEdBaseIO functions putString and getString for low level output and input.
If prompt is an empty string, a default prompt string is used.
- Remarks
- All angles are expressed in radians.
Implemented in CFxUserIO.
◆ getDist()
|
pure virtual |
Returns user input of a distance.
- Parameters
-
prompt [in] Message displayed to prompt the user. options [in] Combination of OdEd::GetPointOptions enum values. defaultValue [in] Default value to return if an empty string is received as input. keywords [in] Keyword string. pTracker [in] Pointer to a User IO tracker.
- Remarks
- This function uses the underlying OdEdBaseIO functions putString and getString for low level output and input.
If prompt is an empty string, a default prompt string is used.
Implemented in CFxUserIO.
◆ getLASTPOINT()
|
pure virtual |
Implemented in CFxUserIO.
◆ getPoint()
|
pure virtual |
Returns user input of a point.
- Parameters
-
prompt [in] Message displayed to prompt the user. options [in] Combination of OdEd::GetPointOptions enum values. pDefaultValue [in] Pointer to a default value to return if an empty string is received as input. keywords [in] Keyword string. pTracker [in] Pointer to a User IO tracker.
- Remarks
- This function uses the underlying OdEdBaseIO functions putString and getString for low level output and input.
If prompt is an empty string, a default prompt string is used.
Implemented in CFxUserIO.
◆ ODRX_DECLARE_MEMBERS()
| OdEdBaseUserIO::ODRX_DECLARE_MEMBERS | ( | OdEdBaseUserIO | ) |
◆ setLASTPOINT()
|
pure virtual |
Implemented in CFxUserIO.
The documentation for this class was generated from the following file: