View Class

This class is the abstract base class for classes that implement Viewport objects in GUI display windows. Each Viewport object consists of a collection of objects to be viewed and camera parameters that define the view. For more information, see Working with Views.
Inheritance Hierarchy
SystemObject
  SystemMarshalByRefObject
    Teigha.RuntimeDisposableWrapper
      Teigha.RuntimeRXObject
        Teigha.GraphicsSystemView

Namespace: Teigha.GraphicsSystem
Assembly: TD_Mgd (in TD_Mgd.dll) Version: 26.9.0.0
Syntax
public class View : RXObject

The View type exposes the following members.

Constructors
  Name Description
Public method View Default constructor for the View class. Creates a view with default values for its properties. For more information, see OdGsViewImpl::OdGsViewImpl Constructor.
Protected method View(IntPtr, Boolean) Constructor for the View class.
Top
Properties
  Name Description
Public property AutoDelete Property that indicates whether the object should be automatically deleted by the Garbage Collector.
(Inherited from DisposableWrapper)
Public property BackClip Property that represents back clip distance from the target of this Viewport object.
Public property Background Property that represents background object for this view.
Public property ClearColor Property that represents clear color for this view.
Public property ClientViewInfo Property that represents the ClientViewInfo that encapsulates the viewport ID, window ID, viewport object ID, and the contextual colors object for the viewport.
Public property Device Property that represents GS Device object associated with this view.
Public property EnableBackClip Property that indicates whether back clipping is enabled for this Viewport object.
Public property EnableFrontClip Property that indicates whether front clipping is enabled for this Viewport object.
Public property EnableStereo Property that indicates whether stereo viewing is enabled for this Viewport object.
Public property ExceededBounds Property that indicates whether any view parameters have exceeded their boundaries. The following calls are monitored: * dolly() * orbit() * pan() * roll() * setBackClip() * setFrontClip() * setView() * zoom()
Public property FieldHeight Property that represents WCS projection plane (field) height for this Viewport object.
Public property FieldWidth Property that represents WCS projection plane (field) width for this Viewport object.
Public property FrontClip Property that represents front clip distance from the target of this Viewport object.
Public property IsDisposed Property that indicates whether pointer to native code unmanaged object == IntPtr::Zero.
(Inherited from DisposableWrapper)
Public property IsPerspective Property that indicates whether the projection type for the viewport object is perspective or parallel.
Public property IsValid Property that indicates whether this Viewport shows the correct image. If this property is true, the following conditions are met: * No part of GUI area is flagged for refresh. * All rasterizations are complete. * The rendering pipeline has been flushed.
Public property IsVisible Property that indicates whether the view is not hidden.
Public property LensLength Property that represents perspective lens length for this Viewport object.
Public property LinetypeScaleMultiplier Property that represents multiplier that is used to scale all linetypes in this Viewport object.
Public property LineweightToDcScale Property that represents the scale factor for displaying Lineweights in this Viewport object.
Public property Mode Property that represents rendering mode for this view. This property can be one of the following: Name Value Description BoundingBox -1 Bounding box. For internal use only. Optimized2D 0 Standard *display*. Optimized for 2D. Wireframe 1 Standard *display*. Uses 3D pipeline. HiddenLine 2 Wireframe *display*. Hidden lines removed. FlatShaded 3 Faceted *display*. One *color* per face. GouraudShaded 4 Smooth shaded *display*. Colors interpolated between *vertices*. FlatShadedWithWireframe 5 Faceted *display* with wireframe overlay. GouraudShadedWithWireframe 6 Smooth shaded *display* with wireframe overlay. None 7 None
Public property ObjectToDeviceMatrix Property that represents the matrix that transforms coordinates from model space to screen space for this Viewport object.
Public property Position Property that represents WCS camera position for this Viewport object.
Public property ProjectionMatrix Property that represents the matrix that transforms view space to normalized device space for this Viewport object.
Public property ScreenMatrix Property that represents the matrix that transforms normalized device space to screen space for this Viewport object.
Public property StereoParameters Property that represents stereo viewing parameters for this Viewport Object. The StereoParameters encapsulate magnitude of view separation and parallax value. Magnitude controls view eye separation, and hence the stereo effect. * A magnitude of 1.0 is the default value. * A magnitude of 0.0 produces no stereo effect. * A magnitude of 2.0 produces a double stereo effect. Parallax adjusts the zero parallax plane. * A parallax of 1.0 is the default value. An object centered at the target will be half-in and half-out of the screen. * A parallax of 0.0 moves the object into the screen. * A parallax of 2.0 move the object out of the screen.
Public property Target Property that represents WCS camera target for this Viewport object.
Public property UnmanagedObject Property that represents a pointer to an unmanaged object.
(Inherited from DisposableWrapper)
Public property UpVector Property that represents WCS camera up vector for this Viewport object.
Public property UserGiContext Property that represents GiContext object associated with this Viewport object.
Public property ViewingMatrix Property that represents the matrix that transforms world space to view space for this Viewport object.
Public property Viewport Property that represents the size and position of this Viewport object. The extents are based on 2 points: * lower-left corner in nomalized device coordinates [0.0 .. 1.0] * upper-right corner in nomalized device coordinates [0.0 .. 1.0]
Public property ViewportBorderProperties Property that represents the color and width of the border for this Viewport object.
Public property ViewportBorderVisibility Property that indicates whether viewport border is visible.
Public property ViewportClipRegion Property that represents polygonal clip region for this Viewport object.
Public property VisualStyle Property that represents a visual style that is used.
Public property VisualStyleId Property that represents ID of visual style that is used.
Public property WorldToDeviceMatrix Property that represents a matrix that transforms coordinates from world space to screen space for this Viewport object.
Top
Methods
  Name Description
Public method Add(Drawable) Adds the specified scene graph to this Viewport object.
Public method Add(Drawable, Model) Adds the specified scene graph to this Viewport object.
Public method BeginInteractivity Puts this Viewport object into an interactive state.
Public method ClearFrozenLayers Thaws all Layer objects in this Viewport object.
Public method Clone Creates a *clone* of this object, and returns a pointer to the *clone*.
(Inherited from RXObject)
Public method CloneView Clones this view object.
Public method CloneView(Boolean) Clones this View object.
Public method CloneView(Boolean, Boolean) Clones this View object.
Public method CompareTo Allows classes to compare class objects.
(Inherited from RXObject)
Public method CopyFrom Copies the contents of the specified object into this object.
(Inherited from RXObject)
Public method CreateObjRef
(Inherited from MarshalByRefObject)
Protected method DeleteUnmanagedObject
(Overrides RXObjectDeleteUnmanagedObject)
Public method Dispose
(Inherited from DisposableWrapper)
Protected method Dispose(Boolean)
(Inherited from DisposableWrapper)
Public method Dolly(Vector3d) Translates the camera position and target by the specified camera coordinate dolly amount.
Public method Dolly(Double, Double, Double) Translates the camera position and target by the specified camera coordinate dolly amount.
Public method EnableDefaultLighting(Boolean) Enables default lighting for this view.
Public method EnableDefaultLighting(Boolean, DefaultLightingType) Enables default lighting for this view.
Public method EndInteractivity Disables the interactive mode for this Viewport object.
Public method Equals Checks objects for equality.
(Inherited from DisposableWrapper)
Public method Erase Removes the specified scene graph from this Viewport object.
Public method EraseAll Removes all scene graphs from this Viewport object.
Public method ExtentsInView Checks whether the specified WCS box is visible completely or partially inside the current view frustum.
Protected method Finalize
(Inherited from DisposableWrapper)
Public method Flush Flushes the graphics pipeline and renders this Viewport object. This method should be called only during interactivity.
Public method FreezeLayer Freezes the specified Layer object in this Viewport object.
Public method GetHashCode Retrieves the object hash code.
(Inherited from DisposableWrapper)
Public method GetLifetimeService
(Inherited from MarshalByRefObject)
Public method GetMetaObject
(Inherited from RXObject)
Public method GetModel Returns the Model object associated with the specified Drawable object in this Viewport object.
Public method GetModelList Returns the array of OdGsModel objects associated with this Viewport object.
Public method GetNumPixelsInUnitSquare(Point3d) Returns the display pixel density at the specified point for this Viewport object.
Public method GetNumPixelsInUnitSquare(Point3d, Boolean) Returns the display pixel density at the specified point for this Viewport object.
Public method GetRXClass Gets a class describing instance dynamically associated with this object as the OdRxClass object.
(Inherited from RXObject)
Public method GetSnapshot Returns the image of the current view buffer.
Public method GetType
(Inherited from Object)
Public method Hide Hides this Viewport object.
Public method InitializeLifetimeService
(Inherited from MarshalByRefObject)
Public method InitLights Associates lights with this Viewport object by traversing with the specified iterator.
Public method Invalidate Marks for refresh the entire area of this view.
Public method Invalidate(Rectangle) Marks for refresh the specified region of this Viewport object.
Public method InvalidateCachedViewportGeometry Marks for regeneration all subViewportDraw() geometry for this Viewport object.
Protected method MemberwiseClone
(Inherited from Object)
Protected method MemberwiseClone(Boolean)
(Inherited from MarshalByRefObject)
Public method Orbit Orbits the camera about the target by the specified amounts.
Public method Pan Pans the camera by the specified X and Y values.
Public method PointInView Checks whether the specified point is visible inside the current view frustum.
Public method PointInViewport Checks whether the specified point is inside the viewport area.
Public method QueryX Checks whether the object belongs to the specified class and returns a pointer to this object if this object can be converted to the specified class.
(Inherited from RXObject)
Public method RemoveViewportClipRegion Removes the clipping region that was previously set with the ViewportClipRegion property.
Public method Roll Rotates the camera by the specified amount about the eye vector.
Public method Select Runs the selection procedure inside this Viewport object.
Public method SetLineweights Sets the lineweights for this Viewport object.
Public method SetView(Point3d, Point3d, Vector3d, Double, Double) Sets the camera parameters for this Viewport object.
Public method SetView(Point3d, Point3d, Vector3d, Double, Double, Projection) Sets the camera parameters for this Viewport object.
Public method Show Unhides this Viewport object.
Public method ThawLayer Thaws the specified Layer object in this Viewport object.
Public method ToString
(Inherited from Object)
Public method Update Updates this view (propagates layer changes, makes device surface area for this view invalid, updates view properties, updates the viewport, sets invalid, and checks for validation flags depending on the regenAbort() call).
Public method ViewParameters Retrieves the view parameters of this Viewport object.
Public method X Checks whether the object belongs to the specified class and returns a pointer to this object if this object can be converted to the specified class, or throws an exception if it cannot.
(Inherited from RXObject)
Public method Zoom Scales the focal length of the camera by the specified amount.
Public method ZoomExtents Scales the camera to completely include the specified WCS box inside the view frustum.
Public method ZoomWindow Scales the camera to completely include the specified screen area.
Top
See Also

©  Bricsys NV. All rights reserved.