Click or drag to resize

ViewCaptureSettings Class

Holds the information required to generate high resolution output of a RhinoViewport. This is used for generating paper prints or image files
Inheritance Hierarchy

Namespace:  Rhino.Display
Assembly:  RhinoCommon (in RhinoCommon.dll)
public class ViewCaptureSettings : IDisposable

The ViewCaptureSettings type exposes the following members.

Public methodViewCaptureSettings
Initializes a new instance of the ViewCaptureSettings class
Public methodViewCaptureSettings(RhinoPageView, Double)
Initializes a new instance of the ViewCaptureSettings class
Public methodViewCaptureSettings(RhinoView, Size, Double)
Initializes a new instance of the ViewCaptureSettings class
Public propertyArrowheadSizeMillimeters
arrowhead size in millimeters
Public propertyCropRectangle
Actual area of output rectangle that view capture is sent to.
Public propertyDefaultPrintWidthMillimeters
Line thickness used to print objects with no defined thickness (in mm)
Public propertyDocument
Public propertyDrawAxis
Public propertyDrawBackground
Public propertyDrawBackgroundBitmap
Public propertyDrawClippingPlanes
Public propertyDrawGrid
Public propertyDrawLights
Public propertyDrawLockedObjects
Public propertyDrawMargins
Public propertyDrawSelectedObjectsOnly
Public propertyDrawWallpaper
Public propertyFooterText
Text drawn at the bottom of the output
Public propertyHeaderText
Text drawn at the top of the output
Public propertyIsScaleToFit
Returns true if the model has been scaled to fit.
Public propertyIsValid
Public propertyMatchLinetypePatternDefinition
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 propertyMediaSize
Total size of the image or page in dots
Public propertyModelScaleType
Public propertyOffsetAnchor
Public propertyOutputColor
Public propertyPointSizeMillimeters
size of point objects in millimeters if scale <= 0 the size is minimized so points are always drawn as small as possible
Public propertyRasterMode
Public propertyResolution
Capture "density" in dots per inch
Public propertyUsePrintWidths
Public propertyViewArea
How the RhinoViewport is mapped to the output rectangle
Public propertyWireThicknessScale
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
Public methodCreatePreviewSettings
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 methodDispose
Actively reclaims unmanaged resources that this instance uses.
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetMargins
Get distances from the edge of the paper (MediaSize) to the CropRectangle in a defined unit system
Public methodGetModelScale
Returns the model scale factor.
Public methodGetOffset
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodMatchViewportAspectRatio
Adjust crop rectangle to match the aspect ratio of the original viewport that these settings reference
Public methodMaximizePrintableArea
Minimize cropping so the full drawable area is used
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetLayout
Public methodSetMargins
Set distances from the edge of the paper (MediaSize) to the CropRectange in a defined unit system
Public methodSetModelScaleToFit
Scales the model to fit.
Public methodSetModelScaleToValue
Sets the model scale to a value.
Public methodSetOffset
Public methodSetViewport
Public methodSetWindowRect(Point2d, Point2d)
Set the print area to a window selection based on two points in screen coordinates
Public methodSetWindowRect(Point3d, Point3d)
Set the print area to a window selection based on two points in world coordinates
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
See Also