ViewCaptureSettings
Holds information required to generate high resolution output of a RhinoViewport. This is used for generating paper prints or image files
Inheritance Hierarchy
System.Object
Rhino.Display.ViewCaptureSettings
Namespace: Rhino.Display
Assembly: RhinoCommon (in RhinoCommon.dll)
Syntax
public class ViewCaptureSettings : IDisposableThe ViewCaptureSettings type exposes the following members.
Constructors
Name
Description
Public Method
ViewCaptureSettings.
Construct default view capture settings
Public Method
ViewCaptureSettings(ViewCaptureSettings)
Copy constructor
Public Method
ViewCaptureSettings(RhinoPageView, Double)
Constructor
Public Method
ViewCaptureSettings(RhinoView, Size, Double)
Constructor
Properties
Name
Description
Public Property
ApplyDisplayModeThicknessScales
Should curves and edges have their thicknesses scaled based the on the display mode settings for a view being captured (default is false)
Public Property
ArrowheadSizeMillimeters
Arrowhead size in millimeters.
Public Property
CropRectangle
Actual area of output rectangle that view capture is sent to.
Public Property
DefaultPrintWidthMillimeters
Line thickness, in millimeters, used to print objects with no defined thickness.
Public Property
Document
Public Property
DrawAxis
Public Property
DrawBackground
Public Property
DrawBackgroundBitmap
Public Property
DrawClippingPlanes
Public Property
DrawGrid
Public Property
DrawLights
Public Property
DrawLockedObjects
Public Property
DrawMargins
Public Property
DrawRectangle
Rectangle where drawing is confined to on MediaSize
Public Property
DrawSelectedObjectsOnly
Public Property
DrawWallpaper
Public Property
FooterText
Text drawn at the bottom of the output
Public Property
HeaderText
Text drawn at the top of the output
Public Property
HorizontalScale
Horizontal stretch to be applied to output. Useful for calibrating printers
Public Property
IsScaleToFit
Returns true if the model has been scaled to fit.
Public Property
IsValid
Public Property
LinetypeWidthUnitsArePageLengths
Public Property
MatchLinetypePatternDefinition
Default is true. Linetype scales are normally generated right before printing/view capture in order to get linetypes to print to the same lengths as defined. If false, the linetypes are not scaled and the current pattern lengths as seen on the screen as used.
Public Property
MediaSize
Total size of the image or page in dots
Public Property
ModelScaleType
Public Property
OffsetAnchor
Public Property
OutputColor
Public Property
PointSizeMillimeters
Size of point objects in millimeters. if scale <= 0 the size is minimized so points are always drawn as small as possible
Public Property
RasterMode
Public Property
Resolution
Capture “density” in dots per inch.
Public Property
TextDotPointSize
Font point size use for printing text dots. The default value is 10.0.
Public Property
UsePrintWidths
Public Property
VerticalScale
Vertical stretch to be applied to output. Useful for calibrating printers
Public Property
ViewArea
How the RhinoViewport is mapped to the output rectangle
Public Property
WireThicknessScale
Scaling factor to apply to object print widths (typically 1.0). This is helpful when printing something at 1/2 scale and having all of the curves print 1/2 as thick.
Methods
Name
Description
Public Method
CreatePreviewSettings
Create a ViewCaptureSettings based on this instance, but scaled to fit in a different sized area. Scaling is also performed on dpi. This is primarily used to for capturing images that are shown as print previews
Public Method
Dispose
Actively reclaims unmanaged resources that this instance uses.
Public Method
Equals(Object)
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public Method
Equals(ViewCaptureSettings)
Check if the contents of this object is the same as another object
Protected Method
Finalize
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Overrides Object.Finalize..)
Public Method
GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public Method
GetMargins
Get distances from the edge of the paper (MediaSize) to the CropRectangle in a defined unit system
Public Method
GetModelScale
Returns the model scale factor.
Public Method
GetOffset
Public Method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public Method
GetViewport
Get RhinoViewport that this view capture settings is targeting
Public Method
Load
Public Method
MatchViewportAspectRatio
Adjust crop rectangle to match the aspect ratio of the original viewport that these settings reference
Public Method
MaximizePrintableArea
Minimize cropping so the full drawable area is used
Protected Method
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public Method
Save
Public Method
SetLayout
Public Method
SetMarginBottom
Set the distance from the bottom edge of the paper to the CropRectangle
Public Method
SetMarginLeft
Set the distance from the left edge of the paper to the CropRectangle
Public Method
SetMarginRight
Set the distance from the right edge of the paper to the CropRectangle
Public Method
SetMargins
Set distances from the edge of the paper (MediaSize) to the CropRectange in a defined unit system
Public Method
SetMarginTop
Set the distance from the top edge of the paper to the CropRectangle
Public Method
SetModelScaleToFit
Scales the model to fit.
Public Method
SetModelScaleToValue
Sets the model scale to a value.
Public Method
SetOffset
Public Method
SetViewport
Public Method
SetWindowRect(Point2d, Point2d)
Set the print area to a window selection based on two points in screen coordinates
Public Method
SetWindowRect(Point3d, Point3d)
Set the print area to a window selection based on two points in world coordinates
Public Method
ToString
Returns a string that represents the current object.
(Inherited from Object.)