SafeFrame

DocumentOrFreeFloatingBaseFreeFloatingBaseReferences
public sealed class SafeFrame : DocumentOrFreeFloatingBase, IDisposable
Safe frame

Constructors

SafeFrame

#Since v7.12
public SafeFrame()
Create a utility object not associated with any document

SafeFrame

#Since v7.12
public SafeFrame(RhinoDoc doc)
Create the SafeFrame object which is associated with the document
Parameters:
doc (RhinoDoc)

SafeFrame

#Since v7.12
public SafeFrame(SafeFrame sf)
Create a utility object not associated with any document from another object
Parameters:
sf (SafeFrame)

Finalizer

~SafeFrame

#
~SafeFrame()

Properties

ActionFrameLinked

#Since v7.12
public bool ActionFrameLinked { get; set; }
Action Frame Linked, On = Use the same scale for X and Y. Off = use different scales for X and Y.

ActionFrameOn

#Since v7.12
public bool ActionFrameOn { get; set; }
Turn on the user specified action area, which shown with blue frames.

ActionFrameXScale

#Since v7.12
public double ActionFrameXScale { get; set; }
Action Frame X-scale. This value should be in the range 0..1 but it is not clamped. It is displayed in the UI in the range 0..100.

ActionFrameYScale

#Since v7.12
public double ActionFrameYScale { get; set; }
Action Frame Y-scale. This value should be in the range 0..1 but it is not clamped. It is displayed in the UI in the range 0..100.

Enabled

#Since v7.12
public bool Enabled { get; set; }
Determines whether the safe-frame is enabled.

FieldsOn

#Since v7.12
public bool FieldsOn { get; set; }
Show the 4 by 3 field grid in the safe-frame.

LiveFrameOn

#Since v7.12
public bool LiveFrameOn { get; set; }
Turn on the live area, which shows the size of the rendered view as a yellow frame in the viewport.

PerspectiveOnly

#Since v7.12
public bool PerspectiveOnly { get; set; }
Show the safe-frame only in perspective views.

TitleFrameLinked

#Since v7.12
public bool TitleFrameLinked { get; set; }
Title Frame Linked, On = Use the same scale for X and Y. Off = use different scales for X and Y.

TitleFrameOn

#Since v7.12
public bool TitleFrameOn { get; set; }
Show a user specified title area frame in orange.

TitleFrameXScale

#Since v7.12
public double TitleFrameXScale { get; set; }
Title Frame X-scale. This value should be in the range 0..1 but it is not clamped. It is displayed in the UI in the range 0..100.

TitleFrameYScale

#Since v7.12
public double TitleFrameYScale { get; set; }
Title Frame Y-scale. This value should be in the range 0..1 but it is not clamped. It is displayed in the UI in the range 0..100.

Methods

BeginChange

public void BeginChange(ChangeContexts cc)
inherited fromDocumentOrFreeFloatingBase
Parameters:
cc (RenderContent.ChangeContexts)

CopyFrom

#Since v7.12
public override void CopyFrom(FreeFloatingBase src)
Parameters:
src (FreeFloatingBase)
Overrides: FreeFloatingBase.CopyFrom

Dispose

#Since v8.0
public void Dispose()

Events

Changed

#
public static event EventHandler<RenderPropertyChangedEvent> Changed
This event is raised when a SafeFrame property value is changed.