ViewInfo

References
public class ViewInfo : IDisposable
Represents the name and orientation of a View (and named view).

views can be thought of as cameras.

Constructors

ViewInfo

#Since v8.2
public ViewInfo()
Create a default ViewInfo instance

ViewInfo

#Since v6.0
public ViewInfo(RhinoViewport rhinoViewPort)
Access to the ViewInfo for given RhinoViewport
rhinoViewPort (RhinoViewport)

ViewInfo

#Since v6.0
[CLSCompliant(false)] public ViewInfo(uint docRuntimeSerialNumber)
Construct the ViewInfo for active viewport of given doc.
docRuntimeSerialNumber (uint)Runtime serial number of the document to query for the active viewport

Finalizer

~ViewInfo

#
~ViewInfo()
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

Properties

ClippingPlanesIds

#Since v8.15
public Guid[] ClippingPlanesIds { get; }
Returns a list of clipping plane Ids associated with this view.

DisplayModeId

#Since v8.36
public Guid DisplayModeId { get; set; }
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.

FocalBlurAperture

#Since v6.0
public double FocalBlurAperture { get; set; }
Gets or sets the Focal blur aperture of the active viewport

FocalBlurDistance

#Since v6.0
public double FocalBlurDistance { get; set; }
Gets or sets the Focal blur distance of the active viewport

FocalBlurJitter

#Since v6.0
public double FocalBlurJitter { get; set; }
Gets or sets the Focal blur jitter of the active viewport

FocalBlurMode

#Since v6.0
[CLSCompliant(false)] public ViewInfoFocalBlurModes FocalBlurMode { get; set; }
Gets or sets the Focal blur mode of the active viewport

FocalBlurSampleCount

#Since v6.0
[CLSCompliant(false)] public uint FocalBlurSampleCount { get; set; }
Gets or sets the Focal blur sample count of the active viewport

LockedProjection

#Since v8.36
public bool LockedProjection { get; set; }
Whether the view's projection is locked against changes.

Maximized

#Since v9.0
public bool Maximized { get; set; }
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.

Name

#Since v5.0
public string Name { get; set; }
Gets or sets the name of the view.

NamedViewId

#Since v7.28
public Guid NamedViewId { get; set; }
Returns a unique id if this is a named view otherwise an empty Guid.

RenderingSize

#Since v8.36
public Size RenderingSize { get; set; }
The pixel size this view renders at.

SectionBehavior

#Since v8.0
public ViewSectionBehavior SectionBehavior { get; set; }
How a view will interact with clipping planes

ShowConstructionAxes

#Since v8.36
public bool ShowConstructionAxes { get; set; }
Whether the construction plane x and y axes are drawn in this view.

ShowConstructionGrid

#Since v8.36
public bool ShowConstructionGrid { get; set; }
Whether the construction plane grid is drawn in this view.

ShowConstructionZAxis

#Since v8.36
public bool ShowConstructionZAxis { get; set; }
Whether the construction plane z axis is drawn in this view.

ShowWallpaperInGrayScale

#Since v6.0
public bool ShowWallpaperInGrayScale { get; }
True if wallpaper (if any) is to be shown in gray scale in this view.

ShowWorldAxes

#Since v8.36
public bool ShowWorldAxes { get; set; }
Whether the world axes icon is drawn in the corner of this view.

Viewport

#Since v5.0
public ViewportInfo Viewport { get; }
Gets the viewport, or viewing frustum, associated with this view.

ViewType

#Since v8.36
public ViewType ViewType { get; set; }
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.

WallpaperFilename

#Since v6.0
public string WallpaperFilename { get; }
Get filename for wallpaper set to this view, if any.

WallpaperHidden

#Since v6.0
public bool WallpaperHidden { get; }
True if wallpaper (if any) is to be hidden from this view.

Methods

ClippingPlaneSurfaces

#Since v8.17
public ClippingPlaneSurface[] ClippingPlaneSurfaces()
Returns a list of ClippingPlaneSurfaces for this view.

Dispose

#Since v5.0
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.

Dispose

#
protected virtual void Dispose(bool disposing)
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.

disposing (bool)true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.

GetConstructionPlane

#Since v8.35
public ConstructionPlane GetConstructionPlane()
Gets the view's construction plane, including its grid settings: grid and snap spacing, grid line count, thick-line frequency, and depth buffering.
A copy of the view's construction plane.

GetPageSettings

#Since v8.36
public PageSettings GetPageSettings()
Gets the paper size and margins of this view. Only meaningful when ViewType is ViewType.PageView.

GetWindowPosition

#Since v9.0
public void GetWindowPosition(out double left, out double right, out double top, out double bottom)
Gets the position of the view window in the frame window, expressed as fractions (0 to 1) of the frame window size.
left (out double)Left edge fraction.
right (out double)Right edge fraction.
top (out double)Top edge fraction.
bottom (out double)Bottom edge fraction.

SetConstructionPlane

#Since v8.35
public void SetConstructionPlane(ConstructionPlane constructionPlane)
Sets the view's construction plane, including its grid settings.
constructionPlane (ConstructionPlane)The construction plane to store on the view.

SetPageSettings

#Since v8.36
public void SetPageSettings(PageSettings pageSettings)
Sets the paper size and margins of this view. Set ViewType to ViewType.PageView as well, or the page settings are ignored.
pageSettings (PageSettings)

SetWindowPosition

#Since v9.0
public void SetWindowPosition(double left, double right, double top, double bottom)
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.
left (double)Left edge fraction.
right (double)Right edge fraction.
top (double)Top edge fraction.
bottom (double)Bottom edge fraction.