Click or drag to resize

ViewInfo Class

Represents the name and orientation of a View (and named view).

views can be thought of as cameras.

Inheritance Hierarchy
SystemObject
  Rhino.DocObjectsViewInfo

Namespace:  Rhino.DocObjects
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public class ViewInfo : IDisposable

The ViewInfo type exposes the following members.

Constructors
  NameDescription
Public methodViewInfo
Create a default ViewInfo instance
Public methodViewInfo(RhinoViewport)
Access to the ViewInfo for given RhinoViewport
Public methodViewInfo(UInt32)
Construct the ViewInfo for active viewport of given doc.
Top
Properties
  NameDescription
Public propertyClippingPlanesIds
Returns a list of clipping plane Ids associated with this view.
Public propertyDisplayModeId
The id of the display mode this view opens in - wireframe, shaded, rendered, or any custom display mode. DisplayModeDescription holds the standard ids. A nil id means the view has no display mode of its own and opens in wireframe, which is what every template generated without this property did.
Public propertyFocalBlurAperture
Gets or sets the Focal blur aperture of the active viewport
Public propertyFocalBlurDistance
Gets or sets the Focal blur distance of the active viewport
Public propertyFocalBlurJitter
Gets or sets the Focal blur jitter of the active viewport
Public propertyFocalBlurMode
Gets or sets the Focal blur mode of the active viewport
Public propertyFocalBlurSampleCount
Gets or sets the Focal blur sample count of the active viewport
Public propertyLockedProjection
Whether the view's projection is locked against changes.
Public propertyMaximized
Gets or sets whether the view window is maximized in the frame window. Together with the window position (see GetWindowPosition(Double, Double, Double, Double)) this is stored in the 3dm file and controls the viewport layout when the file is opened.
Public propertyName
Gets or sets the name of the view.
Public propertyNamedViewId
Returns a unique id if this is a named view otherwise an empty Guid.
Public propertyRenderingSize
The pixel size this view renders at.
Public propertySectionBehavior
How a view will interact with clipping planes
Public propertyShowConstructionAxes
Whether the construction plane x and y axes are drawn in this view.
Public propertyShowConstructionGrid
Whether the construction plane grid is drawn in this view.
Public propertyShowConstructionZAxis
Whether the construction plane z axis is drawn in this view.
Public propertyShowWallpaperInGrayScale
True if wallpaper (if any) is to be shown in gray scale in this view.
Public propertyShowWorldAxes
Whether the world axes icon is drawn in the corner of this view.
Public propertyViewport
Gets the viewport, or viewing frustum, associated with this view.
Public propertyViewType
Whether this view is a model view, a layout page, a nested (detail) view, or one of the special editor views. A page view must be an orthographic top view; see PageSettings for its paper size.
Public propertyWallpaperFilename
Get filename for wallpaper set to this view, if any.
Public propertyWallpaperHidden
True if wallpaper (if any) is to be hidden from this view.
Top
Methods
  NameDescription
Public methodClippingPlaneSurfaces
Returns a list of ClippingPlaneSurfaces for this view.
Public methodDispose
Actively reclaims unmanaged resources that this instance uses.
Protected methodDispose(Boolean)
For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Overrides ObjectFinalize.)
Public methodGetConstructionPlane
Gets the view's construction plane, including its grid settings: grid and snap spacing, grid line count, thick-line frequency, and depth buffering.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPageSettings
Gets the paper size and margins of this view. Only meaningful when ViewType is PageView.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetWindowPosition
Gets the position of the view window in the frame window, expressed as fractions (0 to 1) of the frame window size.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetConstructionPlane
Sets the view's construction plane, including its grid settings.
Public methodSetPageSettings
Sets the paper size and margins of this view. Set ViewType to PageView as well, or the page settings are ignored.
Public methodSetWindowPosition
Sets the position of the view window in the frame window, expressed as fractions (0 to 1) of the frame window size. The Maximized state is preserved.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also