CreatePreviewEventArgs

EventArgsReferences
Used in RenderPlugIn virtual CreatePreview function

Properties

Cancel

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

ContentKind

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

ContentTypeId

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

Environment

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

Id

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

Lights

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

Objects

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

PreviewContent

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

PreviewImage

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

PreviewImageSize

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

PreviewNotifier

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

Quality

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

Reason

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

Viewport

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

Methods

SkipInitialisation

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