ViewCaptureSettings
ReferencesHolds information required to generate high resolution output of a RhinoViewport. This is used for generating paper prints or image files
Constructors
Constructor
public ViewCaptureSettings()
sourcePageView,
The Rhino page view to capture or print.
dpi
Capture "density" in dots per inch.
Constructor
Copy constructor
public ViewCaptureSettings()
ViewCaptureSettings
other
settings to copy data from
Finalizer
~ViewCaptureSettings
#Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
~ViewCaptureSettings()
Properties
Should curves and edges have their thicknesses scaled based the on the display mode settings for a view being captured (default is false)
Arrowhead size in millimeters.
Actual area of output rectangle that view capture is sent to.
Line thickness, in millimeters, used to print objects with no defined thickness.
Rectangle where drawing is confined to on MediaSize
Horizontal stretch to be applied to output. Useful for calibrating printers
Returns true if the model has been scaled to fit.
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.
Size of point objects in millimeters. if scale <= 0 the size is minimized so points are always drawn as small as possible
Font point size use for printing text dots. The default value is 10.0. This has morphed into a scale setting as individual text dots have their own sizes. A value of 20 will print dots at double of their size setting while a value of 10 will print with no scaling applied.
Vertical stretch to be applied to output. Useful for calibrating printers
How the RhinoViewport is mapped to the output rectangle
Methods
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
Returns: new ViewCaptureSettings instance on success. Null on failure
Actively reclaims unmanaged resources that this instance uses.
public void Dispose()
Check if the contents of this object is the same as another object
Get distances from the edge of the paper (MediaSize) to the CropRectangle in a defined unit system
public bool GetMargins()
lengthUnits,
Units to get distances in
out double
left,
Distance from left edge of paper to left edge of CropRectangle
out double
top,
Distance from top edge of paper to top edge of CropRectangle
out double
right,
Distance from right edge of paper to right edge of CropRectangle
out double
bottom
Distance from bottom edge of paper to bottom edge of CropRectangle
Returns: True if successful. False if unsuccessful (this could happen if there is no set device_dpi)
Get RhinoViewport that this view capture settings is targeting
Adjust crop rectangle to match the aspect ratio of the original viewport that these settings reference
Returns: true on success
Minimize cropping so the full drawable area is used
public void MaximizePrintableArea()
Set the distance from the bottom edge of the paper to the CropRectangle
Returns: True if successful. False if unsuccessful (this could happen if there is no set device_dpi)
Set the distance from the left edge of the paper to the CropRectangle
Returns: True if successful. False if unsuccessful (this could happen if there is no set device_dpi)
Set the distance from the right edge of the paper to the CropRectangle
Returns: True if successful. False if unsuccessful (this could happen if there is no set device_dpi)
Set distances from the edge of the paper (MediaSize) to the CropRectange in a defined unit system
public bool SetMargins()
lengthUnits,
Units that left, top, right, and bottom are defined in
left,
Distance from left edge of paper to left edge of CropRectangle
top,
Distance from top edge of paper to top edge of CropRectangle
right,
Distance from right edge of paper to right edge of CropRectangle
bottom
Distance from bottom edge of paper to bottom edge of CropRectangle
Returns: True if successful. False if unsuccessful (this could happen if there is no set device_dpi)
Set the distance from the top edge of the paper to the CropRectangle
Returns: True if successful. False if unsuccessful (this could happen if there is no set device_dpi)
Scales the model to fit.
Sets the model scale to a value.
Set the print area to a window selection based on two points in screen coordinates
Set the print area to a window selection based on two points in world coordinates