PostEffectCollection

DocumentOrFreeFloatingBaseFreeFloatingBaseReferences
public sealed class PostEffectCollection : DocumentOrFreeFloatingBase, IEnumerable<PostEffectData>, IDisposable
Represents the collection of post effects in render settings.

Constructors

PostEffectCollection

#Since v8.0
public PostEffectCollection()
Create a utility object not associated with any document

PostEffectCollection

#Since v8.0
public PostEffectCollection(PostEffectCollection c)
Create a utility object not associated with any document from another object
Parameters:
c (PostEffectCollection)The other collection.

Finalizer

~PostEffectCollection

#
~PostEffectCollection()

Methods

BeginChange

public void BeginChange(ChangeContexts cc)
inherited fromDocumentOrFreeFloatingBase
Parameters:
cc (RenderContent.ChangeContexts)

CopyFrom

#Since v8.0
public override void CopyFrom(FreeFloatingBase src)
Parameters:
src (FreeFloatingBase)
Overrides: FreeFloatingBase.CopyFrom

Dispose

#Since v8.0
public void Dispose()

GetEnumerator

#Since v8.0
public IEnumerator<PostEffectData> GetEnumerator()

GetSelectedPostEffect

#Since v8.0
public bool GetSelectedPostEffect(PostEffectType type, out Guid id)
Gets the selected post effect for a certain type into 'id'. Returns true if successful or false if the selection information could not be found.
Parameters:
type (PostEffectType)
id (out Guid)

MovePostEffectBefore

#Since v8.0
public bool MovePostEffectBefore(Guid id_move, Guid id_before)
Move a post effect before another post effect in the list. Param 'id_move' is the id of the post effect to move. Param 'id_before' is the id of a post effect before which the post effect should be moved. If this is Guid.Empty, the post effect is moved to the end of the list. If the post effect identified by 'id_before' is not found, the method will fail. Returns true if successful, else false.
Parameters:
id_move (Guid)
id_before (Guid)

PostEffectDataFromId

#Since v8.0
public PostEffectData PostEffectDataFromId(Guid id)
Get a post effect data for an id.
Parameters:
id (Guid)

SetSelectedPostEffect

#Since v8.0
public void SetSelectedPostEffect(PostEffectType type, Guid id)
Sets the selected post effect for a certain type.
Parameters:
type (PostEffectType)
id (Guid)
Explicit

IEnumerable.GetEnumerator

#Since v8.0
IEnumerator IEnumerable.GetEnumerator()
Get an enumerator for accessing PostEffectData.