Class AdditionalPropertiesStateBase<TState>

Used in editor drawer part to store the state of additional properties areas.

Inheritance
object
AdditionalPropertiesStateBase<TState>
AdditionalPropertiesState<TState, TTarget>
Inherited Members
Namespace: UnityEditor.Rendering
Assembly: Unity.RenderPipelines.Core.Editor.dll
Syntax
public abstract class AdditionalPropertiesStateBase<TState> where TState : struct, IConvertible
Type Parameters
Name Description
TState

An enum to use to describe the state.

Properties

this[TState]

Get or set the state given the mask.

Declaration
public bool this[TState mask] { get; set; }
Parameters
Type Name Description
TState mask

The filtering mask
Property Value
Type Description
bool

True: All flagged area are expended

Methods

GetAdditionalPropertiesState(TState)

Accessor to the expended state of this specific mask.

Declaration
public abstract bool GetAdditionalPropertiesState(TState mask)
Parameters
Type Name Description
TState mask

The filtering mask
Returns
Type Description
bool

True: All flagged area are expended

HideAll()

Utility to set all states to false

Declaration
public abstract void HideAll()

RegisterEditor(Editor)

Register an editor for this set of additional properties.

Declaration
public void RegisterEditor(Editor editor)
Parameters
Type Name Description
Editor editor

Editor to register.

ResetAnimation(TState)

Resets the animation associated with the given mask to a default state with the animated value set to 1.0 and the target value set to 0.0.

Declaration
protected void ResetAnimation(TState mask)
Parameters
Type Name Description
TState mask

The state mask used to retrieve the associated animation.

SetAdditionalPropertiesState(TState, bool)

Setter to the expended state.

Declaration
public void SetAdditionalPropertiesState(TState mask, bool value)
Parameters
Type Name Description
TState mask

The filtering mask.
bool value

True to show the additional properties.

SetAdditionalPropertiesStateValue(TState, bool)

Setter to the expended state without resetting animation.

Declaration
protected abstract void SetAdditionalPropertiesStateValue(TState mask, bool value)
Parameters
Type Name Description
TState mask

The filtering mask.
bool value

True to show the additional properties.

ShowAll()

Utility to set all states to true

Declaration
public abstract void ShowAll()

UnregisterEditor(Editor)

Unregister an editor for this set of additional properties.

Declaration
public void UnregisterEditor(Editor editor)
Parameters
Type Name Description
Editor editor

Editor to unregister.

Extension Methods