CreatePreviewEventArgs

EventArgsReferences
public class CreatePreviewEventArgs : EventArgs
Used in RenderPlugIn virtual CreatePreview function

Properties

Cancel

#Since v5.1
public bool Cancel { get; }
Get set by Rhino if the preview generation should be canceled for this

ContentKind

#Since v6.0
public RenderContentKind ContentKind { get; }
Description of content that preview is being generated for.

ContentTypeId

#Since v6.0
public Guid ContentTypeId { get; }
The class Id of content that preview is being generated for.

Environment

#Since v5.1
public RenderEnvironment Environment { get; }
The environment that the previewed object is rendered in.

Id

#Since v5.1
public int Id { get; }
Unique Id for this scene.

Lights

#Since v5.1
public List<Light> Lights { get; }

Objects

#Since v5.1
public List<CreatePreviewEventArgs.SceneObject> Objects { get; }

PreviewContent

#Since v5.1
public RenderContent PreviewContent { get; }
obsoleteNo one should really know what they are rendering for, just that they should render.
Obsolete, will return always null

PreviewImage

#Since v5.1
public Bitmap PreviewImage { get; set; }
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.

PreviewImageSize

#Since v5.1
public Size PreviewImageSize { get; }
Pixel size of the image that is being requested for the preview scene

PreviewNotifier

#Since v6.0
public PreviewNotification PreviewNotifier { get; }

Quality

#Since v5.1
public PreviewSceneQuality Quality { get; }
Quality of the preview image that is being requested for the preview scene

Reason

#Since v5.11
public CreatePreviewReason Reason { get; }
Reason the preview is getting generated

Viewport

#Since v5.1
public ViewportInfo Viewport { get; }

Methods

SkipInitialisation

#Since v6.0
public void SkipInitialisation()
Call this if you don't want the argument to handle data initialisation. This is for use with the ChangeQueue