PostEffect

References
public abstract class PostEffect : IDisposable

Constructors

PostEffect

#Since v7.0
public PostEffect()

Finalizer

~PostEffect

#
~PostEffect()

Properties

CanDisplayHelp

#Since v7.0
public bool CanDisplayHelp { get; }

ExecuteWhileRenderingOption

#Since v7.0
public PostEffectExecuteWhileRenderingOptions ExecuteWhileRenderingOption { get; }

Id

#Since v7.0
public Guid Id { get; }

IsSelected

#Since v7.0
public bool IsSelected { get; }
Return true if the post effect is selected.

LocalName

#Since v7.0
public string LocalName { get; }

On

#Since v7.0
public bool On { get; set; }

PostEffectType

#Since v7.0
public PostEffectType PostEffectType { get; }

RequiredChannels

#Since v7.0
public virtual Guid[] RequiredChannels { get; }
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.
Returns: The channel Ids.The post effect should return all channels used by its implementation to this array.

SerialNumber

#Since v7.0
public int SerialNumber { get; set; }

Shown

#Since v7.0
public bool Shown { get; set; }

Styles

#Since v7.0
public PostEffectStyles Styles { get; }

Methods

AddUISections

#Since v7.0
public abstract void 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.
Parameters:
ui (PostEffectUI)PostEffectUI

BeginChange

#Since v7.0
public void BeginChange(ChangeContexts changeContext)
Parameters:
changeContext (RenderContent.ChangeContexts)

CanExecute

#Since v7.0
public virtual bool 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.
Parameters:
pipeline (PostEffectPipeline)PostEffectPipeline
Returns: Return true if the post effect can execute, else false

Changed

#Since v7.0
public void Changed()

DisplayHelp

#Since v7.0
public abstract bool DisplayHelp()
Displays the post effect's help page, if any.
Returns: Return true if successful, else false.

Dispose

#Since v7.0
public void Dispose()

Dispose

#Since v7.0
public virtual void Dispose(bool bDisposing)
Parameters:
bDisposing (bool)

EndChange

#Since v7.0
public bool EndChange()

Execute

#Since v7.0
public abstract bool Execute(PostEffectPipeline pipeline, Rectangle rect)
Execute the post effect.
Parameters:
pipeline (PostEffectPipeline)pipeline provides access to the post-effect pipeline.
rect (Rectangle)rect is the pixel area to process.
Returns: Return true if successful, else false.

GetHashCode

#Since v7.0
public override int GetHashCode()
A CRC of the state of this post effect.
Returns: returns a crc of post effect state
Overrides: Object.GetHashCode

GetParam

#Since v7.0
public abstract bool GetParam(string param, ref object v)
Get a parameter.
Parameters:
param (string)is the name of the parameter to get.
v (ref object)accepts the parameter value.
Returns: Returns true if successful or false if the parameter was not found.

ReadFromDocumentDefaults

#Since v7.0 Obsolete v8.0
public virtual bool ReadFromDocumentDefaults(RhinoDoc doc)
obsoleteThis function is no longer called
Because post effects are now in the render settings, this function can no longer be called.
Parameters:
doc (RhinoDoc)

ReadState

#Since v7.0
public abstract bool ReadState(PostEffectState state)
Read the state. If your post effect has no state, you must still return true for success.
Parameters:
state (PostEffectState)PostEffectState
Returns: Return true if successful, else false.

RegisterPostEffect

#Since v7.0
public static Type[] RegisterPostEffect(Assembly assembly, Guid pluginId)
Parameters:
assembly (Assembly)
pluginId (Guid)

RegisterPostEffect

#Since v7.0
public static Type[] RegisterPostEffect(PlugIn plugin)
Parameters:
plugin (PlugIn)

ResetToFactoryDefaults

#Since v7.0
public abstract void ResetToFactoryDefaults()
Reset the state to factory defaults.

SetParam

#Since v7.0
public abstract bool SetParam(string param, object v)
Set a parameter.
Parameters:
param (string)is the name of the parameter to set.
v (object)specifies the type and value to set.
Returns: Return true if successful or false if the parameter could not be set.

WriteState

#Since v7.0
public abstract bool WriteState(ref PostEffectState state)
Write the state. If your post effect has no state, you must still return true for success.
Parameters:
state (ref PostEffectState)PostEffectState
Returns: Return true if successful, else false.

WriteToDocumentDefaults

#Since v7.0 Obsolete v8.0
public virtual bool WriteToDocumentDefaults(RhinoDoc doc)
obsoleteThis function is no longer called
Because post effects are now in the render settings, this function can no longer be called.
Parameters:
doc (RhinoDoc)