Eyeshot 10 WinForms API Reference
ViewportLayout Class Methods


WinForms Assembly > devDept.Eyeshot Namespace : ViewportLayout Class

For a list of all members of this type, see ViewportLayout members.

Public Methods
 NameDescription
Public MethodActivateOverloaded.  For internal use only.  
Public MethodAdjustNearAndFarPlanes Adjusts camera near and far planes based on model extents and on origin symbol, grid and shadow visibility status.  
Public MethodBeginInitOverridden.   
Public MethodCancelWork Stops the asynchronous background work.  
Public MethodCheckSmallChecks the size on screen of the top level entities and hides the ones smaller that SmallSize, if HideSmall is true.  
Public MethodClear Clears all the viewport master collections: blocks, entities, materials, labels and layers.  
Public MethodCompareWithReferenceImageOverloaded.  Executes a 3D scene visual testing.  
Public MethodCompileUserInterfaceElementsOverloaded.  Compiles 3D user interface elements like the origin symbol, the bitmap background, the FEM restraint and load symbols, etc.  
Public MethodCopyToCopies all items inside control master collections (Entities, Labels, Blocks, Layers, Materials, TextStyles, LineTypes) to the specified ViewportLayout.  
Public MethodCopyToClipboardRasterOverloaded.  Copies a raster image of the current viewport scene on the clipboard.  
Public MethodCopyToClipboardVector Copies a vectorial image of the current scene of the active viewport on the clipboard.  
Public MethodCreateReferenceImage Create a bitmap for the image comparison.  
Public MethodDeactivate Deactivates the product.  
Public MethodDeleteLicenseFile For internal use only.  
Public Methodstatic (Shared in Visual Basic)DeleteObject  
Public MethodDoWorkAccomplishes the work.  
Public MethodDrawTextOutlinedDraws a text on the ViewportLayout's client area.  
Public MethodEndInitOverridden.   
Public Methodstatic (Shared in Visual Basic)EvaluateBoundingBox Evaluates the bounding box of a collection of entities without taking care of entity visibility.  
Public MethodExtrudeTextOverloaded.  Extrudes a text creating an array of new solids.  
Public MethodFindClosestTriangleOverloaded.  Finds the closest triangle to the viewer of the specified entity.  
Public MethodFindClosestVertexOverloaded. Looks for the model vertex whose 2D screen projection is closer to the mouse cursor skipping entities different from entType.  
Public MethodFindClosestVerticesOverloaded. Looks for the model vertices whose 2D screen projections are closer to the mouse than the maxDistance.  
Public MethodGetAllCrossingEntities Returns the list of all the visible and selectable entities geometrically crossing the selection box, regardless of their actual visibility on screen.  
Public MethodGetAllEnclosedEntities Selects all entities completely enclosed in the specified selection rectangle.  
Public MethodGetAllEntitiesUnderMouseCursor Returns all the visible (on screen) top level and selectable entities (which may include the parents stack for nested entities) under the mouse cursor in the active viewport.  
Public MethodGetAllItemsUnderMouseCursor Returns all the visible (on screen) and selectable entities (which may include the parents stack for nested entities) under the mouse cursor in the active viewport.  
Public MethodGetAllLabelsUnderMouseCursor Returns all the visible labels under the mouse cursor in the active viewport.  
Public MethodGetAllVisibleEntities Returns the list of all visible entities in the specified selection box in the active viewport.  
Public MethodGetAllVisibleItems Returns the list of all visible entities (which may include the parents stack for nested entities) in the specified selection box in the active viewport.  
Public MethodGetAllVisibleLabels Returns the list of all visible labels in the specified selection box.  
Public Methodstatic (Shared in Visual Basic)GetAssembly Gets the currently loaded assembly.  
Public MethodGetDefaultCursor Gets the default cursor for the viewport control.  
Public MethodGetDefaultLayoutMode For internal use only.  
Public Methodstatic (Shared in Visual Basic)GetEntityPattern Returns the entity's linetype pattern.  
Public MethodGetEntityUnderMouseCursor Returns the index of the first top level entity under the mouse cursor.  
Public MethodGetItemUnderMouseCursor Gets the first item under the mouse cursor (which may include the parents stack for nested entities).  
Public MethodGetLabelUnderMouseCursor Returns the index of the first label under the mouse cursor.  
Public MethodGetPixel Gets the color of the specified pixel in this viewport  
Public MethodGetPlanarReflectionsPlane Gets the plane used to draw the planar reflections.  
Public MethodGetThumbnail Returns a thumbnail bitmap of the whole viewportLayout. The maximum size is 256x256.  
Public MethodGroupSelection Creates a single unit from selected entities.  
Public MethodInitializeViewportsOverridden. Ensures that at least one Viewport is present in the Viewports collection.  
Public MethodInvalidateOverloaded.  Invalidates the entire surface of the control and causes the control to be redrawn.  
Public MethodIsDesignModeOverridden.  Gets a boolean indicating whether the control is running at design time.  
Public MethodIsErrorInPaintOverridden.   
Public MethodLicenseFileLocationOverloaded.  For internal use only.  
Public MethodLoadPickCursorOverridden.  Gets the Pick Cursor stream.  
Public MethodLoadSceneOverloaded. 

Restores the current scene from disk, including entities, textures, blocks and labels.

 
Public Methodstatic (Shared in Visual Basic)MakeFaceOverloaded.  Triangulates the specific region.  
Public Methodstatic (Shared in Visual Basic)MakeLoopAnalyzes a number of entities and returns a closed loop of points starting from the entity at startIndex. You can provide an array of 100 entities an get a 3D loop of a square made up of 4 lines. Entities connection is checked using chordalError parameter, if the end points of two entities are farther of this value they will not be connected.  
Public Methodstatic (Shared in Visual Basic)MakeLoopByLength Returns a closed loop of points at the specified distance.  
Public MethodMoveToPlaneOverloaded.  Moves a list of entities from plane XY to the specified plane.  
Public MethodNextViewRestores the next view previously saved on the Viewport.SavedViews stack.  
Public MethodOrientCamera Orients the Camera between the two specified points.  
Public MethodPageSetupOpens the Page Setup dialog.  
Public MethodPanCameraOverloaded.  Pans the view from one screen point to the other.  
Public MethodPanDown Pans the view downwards.  
Public MethodPanLeft Pans the view to the left.  
Public MethodPanRight Pans the view to the right.  
Public MethodPanUp Pans the view upwards.  
Public MethodPreFilterMessageOverloaded. Overridden.   
Public MethodPreviousViewRestores the previous view on the Viewport.SavedViews stack.  
Public MethodPrintComputes the hidden lines and opens the Print dialog.  
Public MethodPrintPreviewComputes the hidden lines and opens the Print Preview dialog.  
Public MethodProcessSelection Selects each entity crossing the specified selection rectangle.  
Public MethodProcessSelectionEnclosed Selects each entity completely enclosed in the specified selection rectangle.  
Public MethodProcessSelectionVisibleOnly Selects only visible entities in the specified rectangle.  
Public MethodProcessSelectionVisibleOnlyLabels Selects only visible labels in the specified rectangle.  
Public MethodRemoveJitteringOverloaded. Creates a block with the selected Entities, computes the center of their bounding box, translates them all of the negative of that quantity and returns a BlockReference to that block.  
Public MethodRenderToBitmapOverloaded. Returns an image of the current ViewportLayout scene. The image can be scaled even to a poster size one.  
Public MethodRestoreView Restores the previously saved view in the active viewport.  
Public MethodRestoreViewportsForDesignTime  
Public MethodRotateCameraOverloaded. Sets the view direction as the normal of the plane under the mouse cursor.  
Public MethodRotateDown Rotates the view downwards.  
Public MethodRotateLeft Rotates the view to the left.  
Public MethodRotateRight Rotates the view to the right.  
Public MethodRotateUp Rotates the view upwards.  
Public MethodSaveSceneOverloaded.  Saves the current scene on disk, including entities, textures, blocks and layouts.  
Public MethodSaveViewOverloaded. Saves the current view on the Viewport.SavedViews stack.  
Public MethodScaleForDPI Scales the element for high DPI settings.  
Public MethodScreenToPlaneOverloaded.  Maps screen coordinates to world coordinates in the active viewport.  
Public MethodScreenToWorldOverloaded.  Maps screen coordinates to world coordinates.  
Public Methodstatic (Shared in Visual Basic)SelectObject  
Public MethodSetColorDrawForSelection Sets a coded color depending on the entity id.  
Public MethodSetColorDrawForSelectionAndUpdateIdItemsMap<T> Sets a coded color depending on the entity id.  
Public Methodstatic (Shared in Visual Basic)SetColorRendered Rendered mat changer.  
Public Methodstatic (Shared in Visual Basic)SetColorShaded Shaded color changer.  
Public MethodSetCursor Sets the cursor.  
Public MethodSetDefaultCursor Sets the default cursor for the viewport control.  
Public MethodSetParentHandleOverridden.   
Public MethodSetSelectionScope Sets the parents stack that represents the starting point for the selection.  
Public MethodSetViewOverloaded. Sets the view direction of the camera to the specified direction.  
Public MethodSetViewportsForDesignTime  
Public MethodStartAnimationOverloaded. 

Starts the animation timer. After calling this method the Animate method of all the entities is called periodically to allow the computation of the new entity position.

To animate group of entities the recommended approach is the following:

  1. Create groups of moving objects (using Block class and adding entities to the Block.Entities collection)
  2. Add blocks created at point 1) to the Blocks collection
  3. Subclass the BlockReference class for each moving group of objects
  4. Override the BlockReference.MoveTo() method of the class at point 2) and add the code to move the objects at that specific time frame
  5. Add the block references created at point 4) to the Entities collection
  6. Call StartAnimation() providing the time interval between each frame
  7. Call StopAnimation() to stop the animation
 
Public MethodStartWork Starts the work asynchronously.  
Public MethodStopAnimationStops the animation timer. Call base class method when overriding.  
Public MethodSupportRequest For internal use only.  
Public MethodSuspendUpdate Suspends the updates of ViewportLayout.  
Public MethodUngroup Removes the group status from the specified group.  
Public MethodUnlock Validates the license for runtime usage.  
Public MethodUpdateDesignModeScene Used by the designer to update the graphics.  
Public MethodUpdateViewportLayout Updates the viewport in both desing-time and run-time mode. If necessary adjust near and far planes to accomodate origin symbols of various sizes.  
Public MethodUpdateViewportsSizeAndLocationUpdates the Viewports dimensions and locations depending on the LayoutMode property.  
Public MethodUpdateVisibleSelectionThis method needs to be called before using one of the visible selection action modes or one of the methods that get the entities (or labels) under the mouse cursor if the devDept.Eyeshot.Entities.Entity.Visible or the devDept.Eyeshot.Entities.Entity.Selectable (or devDept.Eyeshot.Labels.Label.Visible or devDept.Eyeshot.Labels.Label.Selectable in case of labels selection) changed and the camera was not moved.  
Public MethodWndProcMouse3DOverridden.   
Public MethodWorldToScreenOverloaded.  Maps world coordinates to screen coordinates.  
Public MethodWriteToFileRasterOverloaded. Saves a raster image of the current viewport scene on disk.  
Public MethodWriteToFileVector Saves a vectorial image of the current scene of the active viewport on disk in EMF format.  
Public MethodZoomCameraOverloaded.  Zooms the view of the specified amount.  
Public MethodZoomFitOverloaded.  Fits the entire model in the viewport control's client area.  
Public MethodZoomFitSelectedLeavesOverloaded.  Fits the selected entities, including the ones inside BlockReferences.  
Public MethodZoomIn Zooms the view in.  
Public MethodZoomOut Zooms the view out.  
Public MethodZoomWindow Zooms to the specified window.  
Top
Protected Methods
 NameDescription
Protected MethodCheckViewports For internal use only.  
Protected Internal MethodClearCharDefs  
Protected Internal MethodComputeNonCurrentEntityColor Gets the color used to draw the given non-current entity.  
Protected MethodDraw3D Draws model, shadow and bounding box.  
Protected Internal MethodDrawBackground Draws the Background of the ViewportLayout control.  
Protected Internal MethodDrawImageDraws an image on the ViewportLayout's client area.  
Protected MethodDrawOverlay Draws overlaying UI elements.  
Protected MethodDrawScene Main drawing method.  
Protected MethodDrawShadow Draws the model shadow  
Protected Internal MethodDrawTextOverloaded. Draws a text on the ViewportLayout's client area.  
Protected MethodDrawTexture Draws a texture.  
Protected MethodDrawVertexIndices  
Protected MethodDrawVertices Draws the vertices of the entities.  
Protected Internal MethodDrawViewport Draws the viewport.  
Protected MethodDrawViewportBackground Draws the viewport background and reflections.  
Protected MethodEndZoomPanRotate Starts a sequence of Zoom-Pan-Rotate movements.  
Protected MethodFireProgressChangedRaises the ProgressChanged event.  
Protected MethodFireWorkCancelledRaises the WorkCancelled event.  
Protected MethodFireWorkCompletedRaises the WorkCompleted event.  
Protected MethodFireWorkFailedRaises the WorkCancelled event.  
Protected MethodFreeCursorsOverridden.   
Protected MethodGetCrossingEntities Returns the list of all the visible and selectable entities crossing the specified selection box.  
Protected Methodstatic (Shared in Visual Basic)GetEntityLineWeight Gets the entity line weight.  
Protected MethodGetTextImage Gets the text bitmap.  
Protected Internal Methodstatic (Shared in Visual Basic)GetTextOutlinedImage Gets the outlined text image.  
Protected MethodGetViewportUnderMouse Returns the viewport under the given mouse position.  
Protected Internal MethodGetVisibleEntitiesFromBackBuffer Returns the indices of the entities read from the back buffer in the selectionBox.  
Protected Internal MethodIsCloserVertexTells if the projected point, whose square distance from the mouse cursor is squareDistance, is closer than the currentMinimumSquareDistance.  
Protected MethodIsDragActionTells if the current ActionMode requires dragging.  
Protected MethodIsInputKeyOverridden.   
Protected MethodIsSelectByBoxActionTells if the current ActionMode is one of the ByBox ones.  
Protected MethodIsSelectByPickActionTells if the current ActionMode is one of the ByPick ones.  
Protected MethodIsSelectByPolygonActionTells if the current ActionMode is one of the ByPolygon ones.  
Protected MethodOnAnimationTimerTickOccurs every timer tick. Call base class method when overriding.  
Protected MethodOnDoubleClickOverridden.   
Protected MethodOnGotFocusOverridden.   
Protected MethodOnHandleCreatedOverridden.   
Protected MethodOnHandleDestroyedOverridden.   
Protected MethodOnKeyDownOverridden.   
Protected MethodOnKeyUpOverridden.   
Protected MethodOnLostFocusOverridden. Synchronize hasFocus parameter, reset action, redraw the control.  
Protected Internal MethodOnMouse3DButtonDownOccurs every Mouse3DButtonDown event.  
Protected Internal MethodOnMouse3DButtonUpOccurs every Mouse3DButtonUp event.  
Protected Internal MethodOnMouse3DMoveOccurs every Mouse3DMove event.  
Protected MethodOnMouseClickOverridden.   
Protected MethodOnMouseDownOverridden.   
Protected MethodOnMouseEnterOverridden.   
Protected MethodOnMouseLeaveOverridden.   
Protected MethodOnMouseMoveOverridden.   
Protected MethodOnMouseUpOverridden.   
Protected MethodOnMouseWheelOverridden.   
Protected Internal MethodOnMultiTouchClickOccurs every MultiTouchClick event.  
Protected Internal MethodOnMultiTouchDoubleClickOccurs every MultiTouchDoubleClick event.  
Protected Internal MethodOnMultiTouchDownOccurs every MultiTouchDown event.  
Protected Internal MethodOnMultiTouchMoveOccurs every MultiTouchMove event.  
Protected Internal MethodOnMultiTouchUpOccurs every MultiTouchUp event.  
Protected MethodOnPaintOverloaded. Overridden.   
Protected MethodOnResizeOverridden.   
Protected Internal MethodPaintBackBuffer Paints the viewport surface without redrawing the whole scene.  
Protected MethodPaintDesignError  
Protected MethodProcessSelectionByPolygon Selects each entity crossing the specified selection polygon.  
Protected MethodProcessSelectionByPolygonEnclosed Selects each entity completely enclosed in the specified selection rectangle.  
Protected MethodProcessSelectionByPolygonVisibleOnly Selects each visible entity in the specified selection polygon.  
Protected MethodResizeViewports Resizes the Viewports.  
Protected Internal MethodRestoreCursor  
Protected Internal MethodSetWaitCursor  
Protected MethodSortEntitiesForTransparency Sorts the transparent entities from the farthest to the nearest to the camera for better rendering.  
Protected Internal MethodStartZoomPanRotate Starts a sequence of Zoom-Pan-Rotate movements if the proper keys/mouse buttons are pressed.  
Protected Internal MethodSwapBuffers Swaps the front and back buffers.  
Top
See Also

Reference

ViewportLayout Class
devDept.Eyeshot Namespace

 

 

Copyright © 2006-2016 devDept Software S.a.s. All rights reserved.

Send Feedback