PostEffect Methods |
The PostEffect type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | 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.
|
| BeginChange | |
| 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.
|
| Changed | |
| DisplayHelp |
Displays the post effect's help page, if any.
|
| Dispose | |
| Dispose(Boolean) | |
| EndChange | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Execute |
Execute the post effect.
|
 | Finalize | (Overrides ObjectFinalize.) |
| GetHashCode |
A CRC of the state of this post effect.
(Overrides ObjectGetHashCode.) |
| GetParam |
Get a parameter.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ReadFromDocumentDefaults | Obsolete.
Because post effects are now in the render settings, this function can no longer be called.
|
| ReadState |
Read the state. If your post effect has no state, you must still return true for success.
|
 | RegisterPostEffect(PlugIn) | |
| RegisterPostEffect(Assembly, Guid) | |
| ResetToFactoryDefaults |
Reset the state to factory defaults.
|
| SetParam |
Set a parameter.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WriteState |
Write the state. If your post effect has no state, you must still return true for success.
|
| WriteToDocumentDefaults | Obsolete.
Because post effects are now in the render settings, this function can no longer be called.
|
See Also