CreatePreviewEventArgs

Public Class

Used in RenderPlugIn virtual CreatePreview function

Inheritance Hierarchy

System.Object
System.EventArgs
Rhino.Render.CreatePreviewEventArgs

Namespace: Rhino.Render

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class CreatePreviewEventArgs : EventArgs

The CreatePreviewEventArgs type exposes the following members.

Properties

Name

Description

---

Public Property

Cancel

Get set by Rhino if the preview generation should be canceled for this

---

Public Property

ContentKind

Description of content that preview is being generated for.

---

Public Property

ContentTypeId

The class Id of content that preview is being generated for.

---

Public Property

Environment

The environment that the previewed object is rendered in.

---

Public Property

Id

Unique Id for this scene.

---

Public Property

Lights

---

Public Property

Objects

---

Public Property

PreviewContent

Obsolete.

Obsolete, will return always null

---

Public Property

PreviewImage

Initially null. If this image is set, then this image will be used for the preview. If never set, the default internal simulation preview will be used.

---

Public Property

PreviewImageSize

Pixel size of the image that is being requested for the preview scene

---

Public Property

PreviewNotifier

---

Public Property

Quality

Quality of the preview image that is being requested for the preview scene

---

Public Property

Reason

Reason the preview is getting generated

---

Public Property

Viewport

---

Methods

Name

Description

---

Public Method

Equals

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

(Inherited from Object.)

---

Protected Method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

(Inherited from Object.)

---

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.)

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Public Method

SkipInitialisation

Call this if you don’t want the argument to handle data initialisation. This is for use with the ChangeQueue

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---