| JsPropertiesExtractor | Send comments on this topic. |
| BaseActionObj Class Members | |
| See Also Properties Methods | |
|
|
| vdWebLibrary Namespace : BaseActionObj Class |
The following tables list the members exposed by BaseActionObj.
Public Properties
| Name | Description | |
|---|---|---|
 | actionCount | Gets the count of the actions that have been initiated whithoug being ended in the document. |
| actionType | Gets the action's type (check ACTION_POINT_WORLD, ACTION_LINE_WORLD, ACTION_RECT_VIEW). |
| CurrentPoint | Returns the current mouse location in World Coordinate System |
| customData | Returns the user custom data for this action |
| DefaultActions | Defines if the basic actions (panning with left mouse, zoomming with mouse wheel, zoomExtents with double click) will be used during the Action. Any of them can be disabled or enabled. |
| DispProps | Gets and sets the action's display properties number. This number defines if the fill color of the created Entities will be using the action's crossfillcolor or fillcolor (check ACTION_DISPLAY_USEFILLCOLOR, ACTION_DISPLAY_USECROSSCOLOR, ACTION_DISPLAY_DEFAULT). |
| DrawActionDefault | Get/Set if the default rubber reference line will be drawn |
| OsnapPoint | Returns the current osnap location in current View Coordinate System as an array of 4 values x,y,z,osnaptype osnaptype can be one of the following OsnapMode_END , OsnapMode_MID , OsnapMode_CEN, OsnapMode_INS, OsnapMode_NEA, OsnapMode_NODE, OsnapMode_QUA |
| PanMouseButton | Specifies which mouse button will perform the pan action. Default is MouseLeftButton |
| ReferencePoint | Returns the reference point of the action in World Coordinate System or null if the actionType is ACTION_POINT_WORLD |
| render | Return the render context used to draw when the action is active. It can be passed as extra parameter in DrawEntity exmaple vdcanvas.DrawEntity(entity,vdcanvas.ActiveAction().render); |
| ResValue | Gets the point or points concerning the action that is being executed. In the first case it's a 3 sized array object, in the second case it's a two dimensional array object containing all the points. |
| RotateMouseButton | Specifies which mouse button will perform the pan action. Default is MouseMiddleButton |
| TouchCancelTimeOut | Get/Set a delay in miliseconds after which the action will be canceled, and when the user pointer is pressed and is holds for this delay. If it is 0 then the action will not canceled. Default value is negative(-1200) then automatically scan if is touch screen device supported and if so , uses absolute of the value for delay, else it uses value of 0. Usefull for touch pointers. A suggested value for single touch pointers is 1200. |
| TouchSupported | Returns true if tha action is supported by touch events. |
| ZoomScaleMouseButton | Specifies which mouse button will perform the zoom in - zoom out action. Default is MouseMiddleButton |
Public Methods
| Name | Description | |
|---|---|---|
 | cancel | Cancel user active action |
| IsCanceled | If true, the Action has been canceled by the user. |
| IsPaused | Get the pause status of the action |
| IsStarted | If true, the Action has been initiated. |
| parse | Parses the passed command string For example user can pass a text input from a textbox in the following form 1. x,y,z coordinate values separate values by ',' symbol vdcanvas.ActiveAction().parse('5.5,2.1,0.5'); 2. distance < angle polar values distance is a double value in drawing units angle is a double value in degrees separate values by '<' symbol vdcanvas.ActiveAction().parse('7.8 < 45.0'); 3. Xoffset,Yoffset relative values vdcanvas.ActiveAction().parse('@2.5,3.7'); NOTE: A prefix '@' is needed |
| Pause | Pause the active user action. |
| Resume | Resume the active user action previous paused by Pause. |
| vdrawOwner | The action's vdrawObj owner. |