SafeFrame

Public Class

Safe frame

Inheritance Hierarchy

System.Object
Rhino.Render.FreeFloatingBase
Rhino.Render.DocumentOrFreeFloatingBase
Rhino.Render.SafeFrame

Namespace: Rhino.Render

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public sealed class SafeFrame : DocumentOrFreeFloatingBase,
  IDisposable

The SafeFrame type exposes the following members.

Constructors

Name

Description

---

Public Method

SafeFrame.

Create a utility object not associated with any document

---

Public Method

SafeFrame(RhinoDoc)

Create the SafeFrame object which is associated with the document

---

Public Method

SafeFrame(SafeFrame)

Create a utility object not associated with any document from another object

---

Properties

Name

Description

---

Public Property

ActionFrameLinked

Action Frame Linked, On = Use the same scale for X and Y. Off = use different scales for X and Y.

---

Public Property

ActionFrameOn

Turn on the user specified action area, which shown with blue frames.

---

Public Property

ActionFrameXScale

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.

---

Public Property

ActionFrameYScale

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.

---

Public Property

Enabled

Determines whether the safe-frame is enabled.

---

Public Property

FieldsOn

Show the 4 by 3 field grid in the safe-frame.

---

Public Property

LiveFrameOn

Turn on the live area, which shows the size of the rendered view as a yellow frame in the viewport.

---

Public Property

PerspectiveOnly

Show the safe-frame only in perspective views.

---

Public Property

TitleFrameLinked

Title Frame Linked, On = Use the same scale for X and Y. Off = use different scales for X and Y.

---

Public Property

TitleFrameOn

Show a user specified title area frame in orange.

---

Public Property

TitleFrameXScale

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.

---

Public Property

TitleFrameYScale

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

Name

Description

---

Public Method

BeginChange

(Inherited from DocumentOrFreeFloatingBase.)

---

Public Method

CopyFrom

(Overrides

FreeFloatingBase.CopyFrom(FreeFloatingBase)

.)

---

Public Method

Dispose

Releases all resources used by the SafeFrame

---

Public Method

EndChange

(Inherited from DocumentOrFreeFloatingBase.)

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Protected Method

Finalize

(Overrides

FreeFloatingBase.Finalize.

.)

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---

Events

Name

Description

---

Public Event
Static Member

Changed

This event is raised when a SafeFrame property value is changed.

---