ViewSettings

public static class ViewSettings
Contains static methods and properties to control view settings.

Properties

AlwaysPanParallelViews

#Since v5.0
public static bool AlwaysPanParallelViews { get; set; }
Gets or sets the 'always pan parallel views' value.

If the view is not looking straight at the construction plane, then sets parallel viewports so they will not rotate.

AutoAdjustTargetDepth

#Since v8.19
public static bool AutoAdjustTargetDepth { get; set; }
Gets or sets the 'Auto adjust camera target after Pan and Zoom' value.

DefinedViewSetClippingPlanes

#Since v8.19
public static bool DefinedViewSetClippingPlanes { get; set; }
Gets or sets the 'Named views set clipping planes' value.

DefinedViewSetCPlane

#Since v5.0
public static bool DefinedViewSetCPlane { get; set; }
Gets or sets the 'Named views set CPlane' value.

When true, restoring a named view causes the construction plane saved with that view to also restore.

DefinedViewSetDisplayMode

#Since v8.19
public static bool DefinedViewSetDisplayMode { get; set; }
Gets or sets the 'Named views set display mode' value.

DefinedViewSetProjection

#Since v5.0
public static bool DefinedViewSetProjection { get; set; }
Gets or sets the 'Named views set projection' value.

When true, restoring a named view causes the viewport projection saved with the view to also restore.

LinkedViewports

#Since v5.0
public static bool LinkedViewports { get; set; }
Gets or sets the 'linked views' activated setting.

true enables real-time view synchronization. When a standard view is manipulated, the camera lens length of all parallel projection viewports are set to match the current viewport.

PanPlanParallelViewsWithControlShiftRMB

#Since v8.19
public static bool PanPlanParallelViewsWithControlShiftRMB { get; set; }
Gets or sets the 'Pan plan parallel views with Control+Shift+RMB' value.

PanReverseKeyboardAction

#Since v5.0
public static bool PanReverseKeyboardAction { get; set; }
Gets or sets if panning with the keyboard is reversed.

false, then Rhino pans the camera in the direction of the arrow key you press. true, then Rhino pans the scene instead.

PanScreenFraction

#Since v5.0
public static double PanScreenFraction { get; set; }
Gets or sets the faction used as multiplier to pan the screen.

RotateCircleIncrement

#Since v5.0
public static int RotateCircleIncrement { get; set; }
Gets or sets the rotation increment.

When the user rotates a view with the keyboard, Rhino rotates the view in steps. The usual step is 1/60th of a circle, which equals six degrees.

RotateReverseKeyboard

#Since v5.0
public static bool RotateReverseKeyboard { get; set; }
Gets or sets the rotation direction.

If true, then Rhino rotates the camera around the scene, otherwise, rotates the scene itself.

RotateToView

#Since v5.0
public static bool RotateToView { get; set; }
Gets or sets the rotation reference.

If true, then the views rotates relative to the view axes; false, than relative to the world x, y, and z axes.

RotateViewAroundAutogumball

#Since v8.19
public static bool RotateViewAroundAutogumball { get; set; }
Gets or sets the 'Rotate view around auto gumball' value.

RotateViewAroundObjectAtMouseCursor

#Since v8.19
public static bool RotateViewAroundObjectAtMouseCursor { get; set; }
Gets or sets the 'Rotate view around object at mouse cursor' value.

SingleClickMaximize

#Since v5.0
public static bool SingleClickMaximize { get; set; }
Gets or sets the 'single-click maximize' value.

When true, maximizing a viewport needs a single click on the viewport title rather than a double-click.

ThreePointPerspectiveLensLength

#Since v8.20
public static double ThreePointPerspectiveLensLength { get; }
Gets the three point perspective lens length. The default is 50mm.

TwoPointPerspectiveLensLength

#Since v8.20
public static double TwoPointPerspectiveLensLength { get; }
Gets the two point perspective lens length. The default is 20mm.

ViewRotation

#Since v8.1
public static ViewSettings.ViewRotationStyle ViewRotation { get; set; }
Gets or sets the view rotation value.

ZoomExtentsParallelViewBorder

#Since v6.3
public static double ZoomExtentsParallelViewBorder { get; set; }
Border amount to apply to parallel viewport during zoom extents

ZoomExtentsPerspectiveViewBorder

#Since v6.3
public static double ZoomExtentsPerspectiveViewBorder { get; set; }
Border amount to apply to perspective viewport during zoom extents

ZoomScale

#Since v5.0
public static double ZoomScale { get; set; }
Gets or sets the step size for zooming with a wheeled mouse or the Page Up and Page Down keys.

Methods

GetCurrentState

#Since v5.0
public static ViewSettingsState GetCurrentState()
Gets the current settings.
Returns: A new view state with current settings.

GetDefaultState

#Since v5.0
public static ViewSettingsState GetDefaultState()
Gets the view factory settings.
Returns: A new view state with factory settings.

RestoreDefaults

#Since v5.0
public static void RestoreDefaults()
Updates from the default setting state.

UpdateFromState

#Since v5.0
public static void UpdateFromState(ViewSettingsState state)
Updates from a particular setting state.
Parameters:
state (ViewSettingsState)The new state that will be set.