SafeFrame Class |
Safe frame
Inheritance HierarchySystemObject
Rhino.RenderFreeFloatingBase
Rhino.RenderDocumentOrFreeFloatingBase
Rhino.RenderSafeFrame
Rhino.RenderFreeFloatingBase
Rhino.RenderDocumentOrFreeFloatingBase
Rhino.RenderSafeFrame
Namespace: Rhino.Render
Assembly: RhinoCommon (in RhinoCommon.dll)
SyntaxThe SafeFrame type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SafeFrame |
Create a utility object not associated with any document
|
| SafeFrame(RhinoDoc) |
Create the SafeFrame object which is associated with the document
|
| SafeFrame(SafeFrame) |
Create a utility object not associated with any document from another object
|
Properties| Name | Description | |
|---|---|---|
 | ActionFrameLinked |
Action Frame Linked, On = Use the same scale for X and Y. Off = use
different scales for X and Y.
|
| ActionFrameOn |
Turn on the user specified action area, which shown with blue frames.
|
| 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.
|
| 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.
|
| Enabled |
Determines whether the safe-frame is enabled.
|
| FieldsOn |
Show the 4 by 3 field grid in the safe-frame.
|
| LiveFrameOn |
Turn on the live area, which shows the size of the rendered view as a yellow frame
in the viewport.
|
| PerspectiveOnly |
Show the safe-frame only in perspective views.
|
| TitleFrameLinked |
Title Frame Linked, On = Use the same scale for X and Y. Off = use
different scales for X and Y.
|
| TitleFrameOn |
Show a user specified title area frame in orange.
|
| 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.
|
| 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 | |
|---|---|---|
| BeginChange | (Inherited from DocumentOrFreeFloatingBase.) |
| CopyFrom | (Overrides FreeFloatingBaseCopyFrom(FreeFloatingBase).) |
| Dispose | Releases all resources used by the SafeFrame |
| EndChange | (Inherited from DocumentOrFreeFloatingBase.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | (Overrides FreeFloatingBaseFinalize.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events
See Also