Class ExpandedState<TState, TTarget>

Used in editor drawer part to store the state of expandable areas using EditorPrefBoolFlags.

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

An enum to use to describe the state.
TTarget

A type given to automatically compute the key.

Constructors

ExpandedState(TState, string, string)

Constructor will create the key to store in the EditorPref the state given generic type passed. The key will be formated as such prefix:TTarget:TState:UI_State.

Declaration
public ExpandedState(TState defaultValue, string prefix = "CoreRP", string stateId = "UI_State")
Parameters
Type Name Description
TState defaultValue

If key did not exist, it will be created with this value for initialization.
string prefix

[Optional] Prefix scope of the key (Default is CoreRP)
string stateId

[Optional] Postfix used to differentiate between different keys (Default is UI_State)

Fields

m_State

The variable which stores the state of expandable areas.

Declaration
protected EditorPrefBoolFlags<TState> m_State
Field Value
Type Description
EditorPrefBoolFlags<TState>

Methods

CollapseAll()

Utility to set all states to false

Declaration
public override void CollapseAll()
Overrides

ExpandAll()

Utility to set all states to true

Declaration
public override void ExpandAll()
Overrides

GetExpandedAreas(TState)

Accessor to the expended state of this specific mask.

Declaration
public override bool GetExpandedAreas(TState mask)
Parameters
Type Name Description
TState mask

The filtering mask
Returns
Type Description
bool

True: All flagged area are expended
Overrides

SetExpandedAreas(TState, bool)

Setter to the expended state.

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

The filtering mask
bool value

The expended state to set
Overrides

Extension Methods