Class vdrawObj

Namespace: vdWebLibrary

Assembly: JsPropertiesExtractor.dll

Represents the primary drawing canvas and high-level API surface used by the engine.

public class vdrawObj

Inheritance: object

vdrawObj

Inherited Members: object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Examples

// Obtain a vdrawObj from a vdmanager and create a new document:
var canvas = vdmanager.vdrawObject("canvasId");
canvas.New();
canvas.AddLine([0,0,0],[10,0,0], true);

Remarks

`vdrawObj` exposes methods, properties and events for creating and manipulating drawing

entities, managing views and layouts, handling user input and script commands, and

integrating with the rest of the engine (for example, saving/loading documents,

rendering and selection)

Instances are obtained from a vdmanager (for example, via vdmanager.vdrawObject).

Fields

AfterDrawInView: Represents a user define function of type AfterDrawInViewDelegate that will be called just after all document entities drawn.

AfterRedraw: Get/Set a method that called whenever a redraw of the vdraw canvas is finished.

OnCustomDraw: Represents a user define function of type CustomDrawDelegate that will be called just before a user custom define entity drawn.

OnCustomGetGrips: Represents a user define function of type CustomGetGripsDelegate that will be called when grips of a user custom define entity needed.

OnCustomGetOsnaps

Represents a user define function of type CustomGetOsnapsDelegate that will be called when Osnaps of a user custom define entity needed.

When implemented must return the Osnap points of the passed object, in the Object's Coordinate System

OnCustomMovegrips

Represents a user define function of type CustomMovegripsDelegate that will be called when grips of a user custom define entity is going to be moved .

OnIsCustom OnCustomDraw OnCustomGetGrips

OnCustomTransforms

Represents a user define function of type CustomTransformsDelegate that will be called when a matrix transformation is going to be applied to an entity.

When implemented geometrical properties must be transformed with passed matrix ofCustomTransformsArgs

OnIsCustom: Represents a user define function of type IsCustomDelegate that will be called by the cade when need to be checked if an entity is user custom define.

vdActionDraw: Represents a user define function of type vdActionDrawDelegate that will be called after default action draw.

vdAfterOpenDocument: Get/Set a method that called after a document is successfully opened and can be handled by a function described by the vdAfterOpenDocumentDelegate.

vdAfterSaveDocument: Get/Set a method that called after a document is successfully saved and can be handled by a function described by the vdAfterSaveDocumentDelegate.

vdDrawCursor

Represents a user define function of type vdActionDrawDelegate that will be called during the default cursor (cross) drawn.

The ovverride function returns true in order to cancel the default draw of the cursor

vdError: Get/Set a method that called whenever an error occurs and can be handled by a function described by the vdErrorDelegate.

vdFIlterActionPoint

Represents a user define function of type vdFIlterActionPointDelegate will be called just before action ends.

In order to allow the user to change the default SelectedPoint.

vdKeyDown: Get/Set a method that called whenever a key is held down and can be handled by a function described by the vdKeyDownDelegate.

vdLoadXref: Get/Set a method of vdLoadXrefDelegate type , that called when an External Reference Block need to be loaded from a file

vdPrompt: Get/Set a method that called whenever a messaged has to be showed for the completion of an action or likewise and can be handled by a function described by the vdPromptDelegate.

vdSelectionModified: Represents a user define function of type vdSelectionModifiedDelegate that will be called for every user select

vdUpdateView: Get/Set a method that called whenever the user's view is about to change (e.g. when panning).

vdXrefLoaded: Get/Set a method of vdLoadXrefDelegate type , that called when an External Reference Block is completly loaded.

vdclick: Get/Set a method that called whenever a click action is performed and can be handled by a function described by the vdclickDelegate.

vddblclick: Get/Set a method that called whenever a double click action is performed and can be handled by a function described by the vddblclickDelegate.

vdmousedown: Get/Set a method that called whenever a mouse button is held down and can be handled by a function described by the vdmousedownDelegate.

vdmousemove: Get/Set a method that called whenever the mouse moves and can be handled by a function described by the vdmousemoveDelegate.

vdmousemoveAfter: Get/Set a method that called whenever the mouse moves, after default web control actions and can be handled by a function described by the vdmousemoveDelegate.

vdmouseout: Get/Set a method that called whenever the cursor goes outside the area of the component's drawing area and can be handled by a function described by the vdmouseoutDelegate.

vdmouseup: Get/Set a method that called whenever a mouse button is released and can be handled by a function described by the vdmouseupDelegate.

vdmousewheel: Get/Set a method that called whenever the mouse wheel is rotated and can be handled by a function described by the vdmousewheelDelegate.

vdprogress: Get/Set a method that called whenever progress is made during the opening of a drawing and can be handled by a function described by the vdprogressDelegate.

vdtouchMove: Get/Set a method that called whenever a touch action is performed and can be handled by a function described by the vdtouchMoveDelegate.

Properties

ActionScaleMode: Get / Set the way that user scale action is applied, when user run the CmdScale(object, object, double, CmdScriptCallback) or scale(object, double, ScriptSelectDelegate).

ApplyDrawEdges: If it is true all the edge lines of polyfaces will be shown using the active pen color of the vdpolyface object. If it is false the edge lines of polyfaces will not be drawn.

CommandSelectionMode: Get/Set a value that controls the way that the user select entities with commands move, scale, rotate, copy , mirror, and select

DrawOverallEntities: Get/Set a collection of temporary entities that will be drawn over all default drawing entities.

GetDefaultTimeOutMilliseconds: Returns the default time out in milliseconds. Default time out is the time that the component waits after a draw action in order to start redrawing the entities. This happens for usability reasons, panning and scrolling are smoother.

GripManager: Manage the grips of the active layout.Currently supported entities are:vdLine,vdPolyline,vdRect,vdText,vdCircles,vdArcs,vdEllipses,vdPoint,vdAttrib,vdAttribDef,vdInsert,vdImage,vdNote.

GroupsManager: Returns an vdgroupsManager object that manage groups of the selected document

HideActionOnMouseOut: Get / Set if the action will be hide when the mouse is out of the canvas or not. Set it to false so the action will be shown either the cursor is out of the canvas. By default value is false.

IgnoreLockLayers: If true the Lock property of layers is ignored and entities inside locked layers are selectable and can be modified. Default value is false.

MaxImageSize: Controls the maximum possible value of an image's bitmap. Default value is 552960 (a resolution of 768 * 720). If 0 is set, the default value is used.

MessagesDictionary: Returns the messagesdictionary object for this control.

MouseWheelZoomScale: Get/Set the zooming scale used when zooming with the mouse wheel.Set this value under 1.0 to inverse the mouse wheel operation.Default value is 1.2

OSnapTrack: Enable / Disable the object snap tracking.

PickSize: Gets and sets the size of the rectangle, in pixels, around the point clicked in order to select the desired entities.

PolarTrack

Enable/disable the polar track behaviour

Default value is true

PolarTrackActionFlag

Get / Set if the PolarTrackAngle begins based to previous action line segment for line(object[], ScriptEntityDelegate) and polyline(object[], bool, int, ScriptEntityDelegate)

Default value is true

PolarTrackAngle

Get/Set the polar track angle in radians.

If is true then as you move your cursor to specify points, and a user action is open

waiting a reference point, a dotted polar tracking line appears at the tracking angles you specified with

PolarTrackAngle property. Also A text tool tip display the polar coordinates, you can disable it using ToolTip ShowPolarTrackToolTipText property.

Default value is HALF_PI 90 degrees

ProgressBarColor: Get / Set the progress bar color in [Red,Green,Blue].Defualt value is [0,0,128]

SelectionSort

Get / Set if user selection will be sorted or not

It can be one of the SelectionSort_NONE for no sorted or

SelectionSort_DEFAULT in wire 2d render mode sorted depend on draworder from the last entity drawn as first in the return collection

and in 3d render mode sorted depend on the depth of the entity from the entity nearest to eye first.

ToolTip: Contains all the tooltip functionality.

canvas: Returns the HTML object that displays all of the component's entities.

licval: Get/Set a string value that can be used to set the license for page and drawing paths. This value can be requested by the library distributor. With out this value a message will be displayed in the drawing area.

scriptCommand: Returns the ScriptCommands object for selected document control.

viewcube: Manage the 3d cube.

Methods

ActionDrawEntities(object, bool): Draws the passed entities on the library's drawing area without adding them to the Document. This way they are drawn rapidly even if the Document has many entities.

ActiveAction(): Returnes the active action (check BaseActionObj) of the document.

ActiveRender(): returns the active Layout vdRender object

AddArc(object, double, double, bool, object): Adds a new vdArc in the document.

AddAttribDef(object, int, double, string, string, object): Add a new vdAttribDef to block definition with passed tag ,set the other passed properties to it and returns the new created vdAttribDef

AddBlock(string, object): Add a block object in the blocks collection of the document. If the blockname already exists, the already created block is returned.

AddBlockFromFile(string, string, bool, vdLoadXrefDelegate, string, int): Creates a vdBlock object from a file and add it in the blocks collection of the document. The function is running asynchronously, so you need to wait for the passed loadedDelegate event/delegate to be fired before you can get/manage the method results

AddBlockSymbol(string, object, double, double, bool, object): Adds a new vdInsert object in the document. The insert's block is found in the Document's collection and by using the given blockname.

AddBox(object, double, double, double, double, bool, object): Creats a box as a vdPolyface object type and returns the created object.

AddCircle(object, double, bool, object): Adds a new vdCircle object in the document.

AddCone(object, double, double, double, int, bool, object): Creats a cone as a vdPolyface object type and returns the created object.

AddEllipse(object, double, double, double, double, double, bool, object): Adds a new vdEllipse object in the document.

AddFigureToCollection(object, object): Adds a figure to the passed collection.

AddHeatMap(object[], object[], int, bool, object): Create a vdPolyface by triangulating the passed points and color it by interpolating the paseed elevatedcolors.

AddImage(string, string, object, double, double, bool, object): Adds a new vdImage in the document.

AddImageDefinition(string, string, ImageLoadedDelegate): Adds a new Image Definition in the document. The function is running asynchronously, so you need to implement imageloadedCallback event/delegate to manage the method results

AddInfinityLine(int, object, object, bool, object): Create and add a new infinity line to active layout entities using the active common properties. It can be Ray or Xline.

AddLayer(string): Adds a new layer to the document's layers collection.

AddLayout(string): Adds a new empty layout to document with the passed name and returns the Layout index id.

AddLine(object, object, bool, object): Adds a new vdLine in the document.

AddPoint(object, bool, object): Adds a vdPoint in the document.

AddPointCloud(object, object, bool, object): Adds a vdPointCloud in the document.

AddPolyHatch(object[], object[], bool, object): Adds a new vdPolyhatch in the document.

AddPolyface(object[], object[], bool, object)

Adds a new vdPolyface in the document.

There is a property of the polyface DrawEdges which by default is undefined.

If it is true the edge lines are drawn using the active PenColor of the polyface.

When the render mode is Shade or Render the color of the faces is specified by the fifth element of each face of the face list and the width of edge lines

can be changed by set a bigger value of line weight.

When WebGl is active so we use RenderGl or ShadeGl note that the line width of edge lines is always one pixel by a limitation of WebGl.

Also a new propery ApplyDrawEdges of canvas has been added which by default is true so the edge lines of polyfaces will be drawn.

We can set it to false in order not to be drawn any edge line of all the polyfaces of the document.For more information see ApplyDrawEdges

NOTE also that the edge lines of the polyface have NOT compatibility with the VDF component.This feature is only for WebControl.

AddPolyline(object, bool, object): Adds a new vdPolyline in the document.

AddRect(object, object, bool, object): Adds a new vdRect in the document.

AddRect2(object, double, double, double, bool, object): Adds a new vdRect in the document.

AddSphere(object, double, int, int, bool, object): Creats a sphere as a vdPolyface object type and returns the created object.

AddText(string, double, object, int, int, double, bool, object): Adds the given string object as vdText in the document. The vdText is defined by the height, the insertionPt wich is a 3 sized array, the horizontal and vertical justifications. Also defined by the rotation.

AddView(string): Adds a new view to the document's view collection.

AddViewport(object, double, double, object, double, bool): Adds a new viewport to the active layout and returns the viewport object

AddXProperty(object, string, object): Adds a new XProperty to the passed entity.

ChangeOrder(object, bool, object): Places an existing object of the collection to the beginning or the end of the passed collection.

CmdCopy(object, object, object, CmdScriptCallback): Copies an array of vdraw entities and moves the duplicates from one point to another. Check the function finished throw the passed scriptCallBack delegate

CmdMirror(object, object, double, CmdScriptCallback, bool): Mirror an array of vdraw entities around a 2d axis. Check the function finished throw the passed scriptCallBack delegate

CmdMove(object, object, object, CmdScriptCallback): Moves an array of vdraw entities from one point to another. Check the function finished throw the passed scriptCallBack delegate

CmdRotate(object, object, double, CmdScriptCallback): Rotates an array of vdraw entities around a base point. Check the function finished throw the passed scriptCallBack delegate

CmdRotate3D(object, object, double, object, CmdScriptCallback): Rotates an array of vdraw entities around an axis. Check the function finished throw the passed scriptCallBack delegate

CmdScale(object, object, double, CmdScriptCallback): Scales an array of vdraw entities. Check the function finished throw the passed scriptCallBack delegate

CmdSelect(CmdScriptCallback): The function is running asynchronously.Prompts the user to select objets and when finish passed throw the scriptCallBack delegate

CopyObjects(object): Returns an array with clone of the objects inside passed entities collection

DrawEntity(object, object, int): Draws the passed entity on the ActiveRender Bitmap. The Refresh() need to be called in order to update the Screen view.

EnableOsnapMode(bool): Enables or disables the osnap functionality without changing the osnap mode.

EnableRedraw(bool): Disable / Enable the redraw() call .

EnableWebGL(bool): Enables/disables the use of WebGL in the library. Check article 70000445 for limitations and more information.

ExplodeObjects(object)

Note supported exploded objects are vdInsert, vdRect , vdPolyline(with lines and bulges) , vd3dFace, vdPolyface and entities with Explode collection property like dimensions or vdProxyFigures.

Note also that the ExplodeObjects does not support External Reference blocks.

Returns an array of the exploded entities of the passed entities collection.

Table of Contents