RhinoCommon documentation has a new look. The old site can still be found here.

/

Rhino.Render.PostEffects

/

PostEffect

PostEffect class

Derived Classes:

Namespace: Rhino.Render.PostEffects
PostEffect: references

Constructors (1)

PostEffect()

Properties (11)

CanDisplayHelp

ExecuteWhileRenderingOption

Id

IsSelected

Return True if the post effect is selected.

LocalName

On

PostEffectType

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.

SerialNumber

Shown

Styles

Methods (19)

AddUISections(PostEffectUI ui)

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.

BeginChange(ChangeContexts changeContext)

CanExecute(PostEffectPipeline pipeline)

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.

Changed()

DisplayHelp()

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

Dispose()

Dispose(bool bDisposing)

EndChange()

Execute(PostEffectPipeline pipeline, Rectangle rect)

Execute the post effect.

GetHashCode()

A CRC of the state of this post effect.

GetParam(string param, ref object v)

Get a parameter.

ReadFromDocumentDefaults(RhinoDoc doc)

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

ReadState(PostEffectState state)

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

RegisterPostEffect(PlugIn plugin)

RegisterPostEffect(Assembly assembly,Guid pluginId)

ResetToFactoryDefaults()

Reset the state to factory defaults.

SetParam(string param, object v)

Set a parameter.

WriteState(ref PostEffectState state)

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

WriteToDocumentDefaults(RhinoDoc doc)

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

Nothing found