| JsPropertiesExtractor | Send comments on this topic. |
| vdrawObj Class Methods | |
| See Also | |
|
|
| vdWebLibrary Namespace : vdrawObj Class |
For a list of all members of this type, see vdrawObj members.
Public Methods
| Name | Description | |
|---|---|---|
 | ActionDrawEntities | 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. |
| AddArc | Adds a new vdArc in the document. |
| AddAttribDef | Adds a new vdAttribDef object to the passed block. |
| AddBlock | Add a block object in the blocks collection of the document. If the blockname already exists, the already created block is returned. |
| AddBlockFromFile | Creates a vdBlock object from a file and add it in the blocks collection of the document. |
| AddBlockSymbol | 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 | Creats a box as a vdPolyface object type and returns the created object. |
| AddCircle | Adds a new vdCircle object in the document. |
| AddCone | Creats a cone as a vdPolyface object type and returns the created object. |
| AddEllipse | Adds a new vdEllipse object in the document. |
| AddHeatMap | Create a vdPolyface by triangulating the passed points and color it by interpolating the paseed elevatedcolors. |
| AddImage | Adds a new vdImage in the document. |
| AddLayer | Adds a new layer to the document's layers collection. |
| AddLayout | Adds a new empty layout to document with name "test" and return the Layout index id |
| AddLine | Adds a new vdLine in the document. |
| AddPolyface | Adds a new vdPolyface in the document. |
| AddPolyline | Adds a new vdPolyline in the document. |
| AddRect | Adds a new vdRect in the document. |
| AddRect2 | Adds a new vdRect in the document. |
| AddSphere | Creats a sphere as a vdPolyface object type and returns the created object. |
| AddText | 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 | Adds a new view to the document's view collection. |
| AddViewport | Adds a new viewport to the active layout and returns the viewport object |
| AddXProperty | Adds a new XProperty to the passed entity. |
| ChangeOrder | Places an existing object of the collection to the beginning or the end of the passed collection. |
| CmdCopy | Copies an array of vdraw entities and moves the duplicates from one point to another. |
| CmdMove | Moves an array of vdraw entities from one point to another. |
| CmdRotate | Rotates an array of vdraw around a base point. |
| CmdScale | Scales an array of vdraw entities. |
| CmdSelect | Prompts the user to select objets and when finish passed throw the scriptCallBack delegate |
| CopyObjects | Returns an array with clone of the objects inside passed entities collection |
| createNewHatchProperties | Creates a new vdHatchProperties object. |
| DrawEntity | Draws the passed entity on the ActiveRender Bitmap. The Refresh need to be called in order to update the Screen view. |
| EnableOsnapMode | Enables or disables the osnap functionality without changing the osnap mode. |
| EnableRedraw | Disable / Enable the redraw call . |
| EnableWebGL | Enables/disables the use of WebGL in the library. Check article 70000445 for limitations and more information. |
| Fig_codeToString | Returns the corresponding vdFigure's name of the code passed.The supported values are: vdLine,vdPolyline,vdText,vdRect,vdCircle,vdEllipse,vdArc,vdImage,vdInsert,vd3DFace,vdPolyface, vdAttrib,vdAttribDef,vdInfinityLine,vdPoint,vdViewport,vdPolyhatch,vdDimension,vdMText,vdMultiline, vdGroundSurface,vdLeader,vdArcAlignedText. |
| FindBlock | Returns the Block defined by the given name. |
| FindLayer | Returns the layer defined by the given name. |
| FindLayout | Returns the layout index id of the given layout name. |
| FindLineType | Returns the LineType defined by the given name. |
| FindTextStyle | Returns the TextStyle defined by the given name. |
| FindView | Returns the vdView object defined by the given name. |
| GetActiveHatchProperties | Returns the active HatchProperties. |
| GetActiveLayout | Returns the active layout. |
| GetActiveLayoutId | Returns the active layout's id. |
| GetActivePenColor | Returns the active penColor. |
| GetActiveThickness | Returns the current active thickness. |
| GetActiveView | Returns the active view. |
| GetAttribValue | Returns the value of the first attribute matching the tag parameter. The check is no case sensitive. |
| GetBlocks | Returns a collection with all block objects of the document. |
| GetDictItem | Returns a table object(block,layer,textstyle,hatchpattern ,imagedefinition, linetype) from its handle string |
| GetDocument | Returns the vdObject's document. |
| GetEnableSelection | Get a value that defines if the selection is enabled. SetEnableSelection, GetEntityFromPoint ,GetEntitiesFromBox , GetEntitiesInWindowBox |
| GetEntitiesFromBox | Returns an array of vdraw entities that cross the specified box. Even if a small part of an entity lies inside the box, it is added in the array. The first two parameters define the first point of the box and the rest define the second point in pixel coordinates. |
| GetEntitiesFromLayer | Returns all entities assigned to a specific layer and belongs to a Layout object. |
| GetEntitiesInWindowBox | Returns an array of vdraw entities that lie entirely inside the specified box. Even if a small part of an entity lies outside the box, the entity is ignored. The first two parameters define the first point of the box and the rest define the second point in pixel coordinates. |
| GetEntityArea | Calculates the area of the given vdCurve object. The supported objects are vdPolyline, vdRect, vdCircle and vdEllipse. |
| GetEntityFromPoint | Returns the entity that resides under the given point. The point is defined by x and y coordinates in pixels relative to the upper left corner of the drawing area. |
| GetEntityItem | Returns an entity object from a handle string |
| GetEntityLength | Calculates the length of the passes entity. |
| GetExtents | Returns the extents of the visible entities of the active layout. |
| GetGrayScale | get the grayscale mode |
| GetHatchPatterns | Returns a collection with all hatchpattern objects of the document. |
| GetImageInterpolationMode | Returns the interpolation mode used in order to smoothen the images used in vdImages and Materials. |
| GetImages | Returns a collection with all image definition objects of the document. |
| GetLayers | Returns a collection with all Layer objects of the document. |
| GetLayouts | Returns a collection with all layout objects of the document included the Model |
| GetLineTypes | Returns a collection with all linetypes objects of the document. |
| GetOsnapMode | Gets the active osnap mode. |
| GetPixelSize | Returns the size of one pixel. |
| GetTextStyles | Returns a collection with all textstyle objects of the document. |
| GetUserLine | Initiates an action (check BaseActionObj) where the user will create a new line in the component's drawing area. |
| GetUserPoint | Initiates an action (check BaseActionObj) where the user will select a point in the component's drawing area. |
| GetUserRect | Initiates an action (check BaseActionObj) where the user will create a new line in the component's drawing area. |
| GetViewBox | Returns an object describing the current user's view in View Coordinates. |
| GetXProperty | Returns the first XProperty by the given name to be found in the passed entity. Null if none is found. |
| GetXREFS | Returns all the external references of the selected document. |
| GPS_AtPoint | Returns the Latitude , Longitude array in decimal degrees , from the passed point in Drawing World Coordinate System |
| LookAt | Changes the view of the document based on the passed parameters. |
| MeasureCurve | Calculates an array of points over the entity, where each point has a distance equal to length from the previous point. |
| MergeDocument | Merge the model entities of the passed document to this selected document |
| MoveView | Move the view on the x, y and z axis of View Coordinates. |
| NumLayouts | Returns the count of the document's layouts. |
| PixelToView | Converts and returns the given point from pixel coordinates to view coordinates. |
| PixelToWorld | Converts and returns the given point from pixel (relative to the upper left corner of the drawing area) coordinates to world coordinates. |
| PointAt_GPS | Returns a point in Drawing World Coordinate System from the passed (Latitude and Longitude) |
| printToImageData | Returns an array of data that can be used in an image in order to help the user print the drawing using the given parameters. |
| Prompt | Calls the vdPrompt event passing the given string as parameter. |
| redraw | Causes the component to redraw all the entities right away. |
| Refresh | Refresh the graphics area by draw the active render bitmap on the screen Usually called after DrawEntity method |
| RotateView | Rotate the view horizontally and vertically. |
| SaveDocument | Save the active document object GetDocument to a data steam |
| scroll | Moves the user's view on the x and y axis according to the given values. |
| SelectDocument | Opens the given filename. If reload is true the drawing will be reloaded from its source. |
| SetActionCrossFillColor | Sets the fill color of the new entity created (e.g through the GetUserRect action) when the rect's low point is to the right of the rect's high point. By default, the action's crossfillcolor property is the same to the fillcolor, so no collor will be used. |
| SetActionFillColor | Sets the fill color of the new rectangle created through the GetUserRect action. By default action's fillcolor property is null, so no collor will be used. |
| SetActionLineColor | Sets the color of the new lines created through the actions. |
| SetActionLineWidth | Sets the width of the new lines created through the actions. |
| SetActionOrthoMode | Set the orthomode property of the actions that waiting for a user point referenced by an other one. If true Constrains cursor movement to the perpendicular. |
| SetActionOsnapColor | Sets the passed 4 sized array (R,G,B,A) as the osnaps' mark color. |
| SetActionOsnapSize | Sets the passed number as the osnaps' mark size in pixels. |
| SetActiveHatchProperties | Sets the active HatchProperties to the specified object. |
| SetActiveLayer | Sets the given Layer as the document's active Layer. After setting the SetActiveLayer all of the new entities will be added as reference in the layer. |
| SetActiveLayout | Set the passed layout object as active.If it is null or undefined the Model is activated. This method also post a redraw action. |
| SetActiveLayoutId | Sets as active layout the one that has the given id. |
| SetActiveLineType | Sets the given LineType as the document's active LineType. |
| SetActiveLineWeight | Sets the given LineWeight as the document's active LineWeight. |
| SetActivePenColor | Sets the given PenColor as the document's active color. |
| SetActivePenWidth | Sets the given PenWidth as the document's active PenWidth. |
| SetActiveTextStyle | Sets the given TextStyle as the document's active TextStyle. |
| SetActiveThickness | Sets the active thickness value. This property gives all imported curves a stretch on Z axis. |
| SetActiveView | change the active layout and the zoom properties according to the passed view |
| SetAttribValue | Sets the defined value string to the attribute matching the tag parameter. The check is no case sensitive. |
| SetBlockSize | Sets the number of triangles to be drawn as a block when using WebGL. The higher value the quicker the render will be. Caution! some devices may fail after a specific limit. Used with EnableWebGL. |
| SetDefaultTimeOutMilliseconds | Sets 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. |
| SetDocument | Select a document object that previous was store into a variable by the GetDocument |
| SetEnableSelection | Enable / Disable the Selection buffer that keeps information of entities drawn in each pixel. If this value is false, no entities can be detected under a pixel (no selection). GetEntityFromPoint ,GetEntitiesFromBox , GetEntitiesInWindowBox |
| SetGrayScale | Sets the grayscale mode |
| SetImageInterpolationMode | Sets the interpolation mode used in order to smoothen the images used in vdImages and Materials. |
| SetOsnapMode | Sets the desired osnap mode, e.g for endpoint osnaps check the OsnapMode_END. |
| SetRenderMode | Change the Render mode of the active layout and post a redraw command |
| SetSize | Sets the size of the selected canvas to the given parameters and updates the rendering context acoording the the selected canvas size. |
| SetStdView | Positions the user's view to a prefixed position. Check StdView_TOP. |
| SetViewAngles | Modify the current World to View Matrix using azimouth, tilt and twist angles that specify the view direction relative to World Coordinate System. |
| TriangulatePolyface | Triangulates the VertexList of an existing vdPolyface using Delaunay algorithm and change the FaceList of the object according to calculated triangles. |
| UndoHistory | return the ModificationHistory. of the selected document object. |
| UpdateFig | Sets all property values of the given figure to null, in order for all these to be recalculated at the next redraw. |
| UpdateLayout | Update Bounding box extends of the passed layout. |
| ViewToPixel | Converts and returns the given point from view coordinates to pixel coordinates relative to the upper left corner of the drawing area. |
| ViewToWorld | Converts and returns the given point from world coordinates to view coordinates. |
| WebGLisActive | Returns true if webGl is intialized or false if it's not. |
| WorldToPixel | Converts and returns the given point from world coordinates to pixel coordinates relative to the upper left corner of the drawing area. |
| WorldToView | Converts and returns the given point from view coordinates to world coordinates. |
| zoomExtents | Zooms the view appropriately in order to show all entities in the document. |
| zoomScale | Scales the user's view in the component. The positive or negative scale is defined by the Delta value. X and y define the center point of the scaling in pixels. |
| zoomwindow | Zooms the view to the window specified by the two points. The two points are in the view coordination system and are defined by two 3 sized arrays. |