Click or drag to resize

SafeFrame Class

SafeFrame
Inheritance Hierarchy

Namespace:  Rhino.Render
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public class SafeFrame : DocumentOrFreeFloatingBase

The SafeFrame type exposes the following members.

Constructors
  NameDescription
Public methodSafeFrame
Create an utility object not associated with any document
Public methodSafeFrame(RhinoDoc)
Create the SafeFrame object which is associated with the document
Public methodSafeFrame(SafeFrame)
Create an utility object not associated with any document from another object
Top
Properties
  NameDescription
Public propertyActionFrameLinked
Action Frame Linked, On = Use the same scale for X and Y. Off = use different scales for X and Y.
Public propertyActionFrameOn
Turn on the user specified action area, which shown with blue frames.
Public propertyActionFrameXScale
Action Frame Scale X
Public propertyActionFrameYScale
Action Frame Scale Y
Public propertyEnabled
Determines whether the safeframe is enabled.
Public propertyFieldsOn
Show a 4 by 3 grid in the safe-frame.
Public propertyLiveFrameOn
Turn on the live area, which shows the size of the rendered view as a yellow frame in the viewport.
Public propertyPerspectiveOnly
Show the safe-frame only in perspective views.
Public propertyTitleFrameLinked
Title Frame Linked, On = Use the same scale for X and Y. Off = use different scales for X and Y.
Public propertyTitleFrameOn
Show a user specified title area frame in orange.
Public propertyTitleFrameXScale
Title Frame Scale X
Public propertyTitleFrameYScale
Title Frame Scale Y
Top
Methods
  NameDescription
Public methodBeginChange
Call this function before making any change to this object (calling a setter) otherwise undo will not work correctly. Calls to BeginChange must be paired with a call to EndChange.
(Inherited from DocumentOrFreeFloatingBase.)
Public methodCopyFrom (Overrides FreeFloatingBaseCopyFrom(FreeFloatingBase).)
Public methodEndChange
See BeginChange
(Inherited from DocumentOrFreeFloatingBase.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Handle destruction of the un-managed CPP object.
(Inherited from FreeFloatingBase.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventStatic memberChanged
This event is raised when a SafeFrame property value is changed.
Top
See Also