PostEffect

Public Class

Inheritance Hierarchy

System.Object
Rhino.Render.PostEffects.PostEffect

Namespace: Rhino.Render.PostEffects

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public abstract class PostEffect : IDisposable

The PostEffect type exposes the following members.

Constructors

Name

Description

---

Public Method

PostEffect

Initializes a new instance of the PostEffect class

---

Properties

Name

Description

---

Public Property

CanDisplayHelp

---

Public Property

ExecuteWhileRenderingOption

---

Public Property

Id

---

Public Property

IsSelected

Return true if the post effect is selected.

---

Public Property

LocalName

---

Public Property

On

---

Public Property

PostEffectType

---

Public Property

RequiredChannels

The RDK calls this method to determine which channels a post effect requires. If a required channel is not available, the RDK will hide the post effect’s UI and display explanatory text instead. Note: As a convenience, the default implementation adds IRhRdkRenderWindow::chanRGBA to the output array. Most post effects should be able to use this default with no need to override the method.

---

Public Property

SerialNumber

---

Public Property

Shown

---

Public Property

Styles

---

Methods

Name

Description

---

Public Method

AddUISections

Create each of your UI sections using ‘new’ and then call ui.AddSection() on them. RDK takes ownership of the sections.If your post effect does not need a UI, then your implementation of this method can be a no-op.

---

Public Method

BeginChange

---

Public Method

CanExecute

Return true if the post effect can execute, else false. The base implementation checks if the post effect is ‘On’ and ‘Shown’. Post effect authors can override this to include other criteria but cannot disable the base criteria.

---

Public Method

Changed

---

Public Method

DisplayHelp

Displays the post effect’s help page, if any.

---

Public Method

Dispose.

Releases all resources used by the PostEffect

---

Public Method

Dispose(Boolean)

Releases the unmanaged resources used by the PostEffect and optionally releases the managed resources

---

Public Method

EndChange

---

Public Method

Equals

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

(Inherited from Object.)

---

Public Method

Execute

Execute the post effect.

---

Protected Method

Finalize

(Overrides Object.Finalize..)

---

Public Method

GetHashCode

A CRC of the state of this post effect.

(Overrides Object.GetHashCode..)

---

Public Method

GetParam

Get a parameter.

---

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

ReadFromDocumentDefaults

Obsolete.

Because post effects are now in the render settings, this function can no longer be called.

---

Public Method

ReadState

Read the state. If your post effect has no state, you must still return true for success.

---

Public Method
Static Member

RegisterPostEffect(PlugIn)

---

Public Method
Static Member

RegisterPostEffect(Assembly, Guid)

---

Public Method

ResetToFactoryDefaults

Reset the state to factory defaults.

---

Public Method

SetParam

Set a parameter.

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---

Public Method

WriteState

Write the state. If your post effect has no state, you must still return true for success.

---

Public Method

WriteToDocumentDefaults

Obsolete.

Because post effects are now in the render settings, this function can no longer be called.

---