Class Inspector<T>

Base class for defining a custom inspector for values of type .

Inheritance

Object

Inspector<T>

PropertyDrawer<TValue, TAttribute>

InspectorAndDrawerTypeInspector

MultipleInspectorsTypeInspector

MultipleInspectorsTypeInspectorWithTag

SingleInspectorTypeInspector

Namespace: Unity.Properties.UI

Syntax

public abstract class Inspector<T> : IInspector<T>, IInspector

Type Parameters

Name	Description
T	The type of the value to inspect.

Properties

DisplayName

Returns the display name of the current value.

Declaration

protected string DisplayName { get; }

Property Value

Type	Description
String

IsDelayed

Returns true if the value field was tagged with the DelayedAttribute.

Declaration

protected bool IsDelayed { get; }

Property Value

Type	Description
Boolean

IsReadOnly

Returns true if the value field is read-only.

Declaration

protected bool IsReadOnly { get; }

Property Value

Type	Description
Boolean

Name

Returns the property name of the current value.

Declaration

protected string Name { get; }

Property Value

Type	Description
String

Part

Returns the property path of the current value.

Declaration

public PropertyPath.Part Part { get; }

Property Value

Type	Description
PropertyPath.Part

PropertyPath

Returns the full property path of the current target.

Declaration

public PropertyPath PropertyPath { get; }

Property Value

Type	Description
PropertyPath

Target

Accessor to the value being inspected.

Declaration

protected T Target { get; set; }

Property Value

Type	Description
T

Tooltip

Returns the tooltip of the current value.

Declaration

protected string Tooltip { get; }

Property Value

Type	Description
String

Type

Declaration

public Type Type { get; }

Property Value

Type	Description
Type

Methods

Build()

Declaration

public virtual VisualElement Build()

Returns

Type	Description
VisualElement

DoDefaultGui()

Generates the default inspector.

Declaration

protected VisualElement DoDefaultGui()

Returns

Type	Description
VisualElement	The parent VisualElement containing the generated inspector.

DoDefaultGui(VisualElement, String)

Allows to revert to the default drawing handler for a specific field.

Declaration

public void DoDefaultGui(VisualElement parent, string propertyPath)

Parameters

Type	Name	Description
VisualElement	parent	The parent element.
String	propertyPath	The property path to the field that needs to be drawn.

DoDefaultGui(VisualElement, PropertyPath)

Allows to revert to the default drawing handler for a specific property path.

Declaration

public void DoDefaultGui(VisualElement parent, PropertyPath propertyPath)

Parameters

Type	Name	Description
VisualElement	parent	The parent element.
PropertyPath	propertyPath	The property path to the field that needs to be drawn.

DoDefaultGuiAtIndex(VisualElement, Int32)

Allows to revert to the default drawing handler for a specific field.

Declaration

public void DoDefaultGuiAtIndex(VisualElement parent, int index)

Parameters

Type	Name	Description
VisualElement	parent	The parent element.
Int32	index	The index of the field that needs to be drawn.

DoDefaultGuiAtKey<TKey>(VisualElement, TKey)

Allows to revert to the default drawing handler for a specific field.

Declaration

public void DoDefaultGuiAtKey<TKey>(VisualElement parent, TKey key)

Parameters

Type	Name	Description
VisualElement	parent	The parent element.
TKey	key	The key of the field that needs to be drawn.

Type Parameters

Name	Description
TKey

GetAttribute<TAttribute>()

Declaration

public TAttribute GetAttribute<TAttribute>()
    where TAttribute : Attribute

Returns

Type	Description
TAttribute

Type Parameters

Name	Description
TAttribute

GetAttributes<TAttribute>()

Declaration

public IEnumerable<TAttribute> GetAttributes<TAttribute>()
    where TAttribute : Attribute

Returns

Type	Description
IEnumerable<TAttribute>

Type Parameters

Name	Description
TAttribute

GetContext<TInspectionContext>(String)

Declaration

public TInspectionContext GetContext<TInspectionContext>(string contextName = null)
    where TInspectionContext : InspectionContext

Parameters

Type	Name	Description
String	contextName

Returns

Type	Description
TInspectionContext

Type Parameters

Name	Description
TInspectionContext

HasAttribute<TAttribute>()

Declaration

public bool HasAttribute<TAttribute>()
    where TAttribute : Attribute

Returns

Type	Description
Boolean

Type Parameters

Name	Description
TAttribute

HasContext<TInspectionContext>(String)

Declaration

public bool HasContext<TInspectionContext>(string contextName = null)
    where TInspectionContext : InspectionContext

Parameters

Type	Name	Description
String	contextName

Returns

Type	Description
Boolean

Type Parameters

Name	Description
TInspectionContext

IsPathValid(PropertyPath)

Declaration

public bool IsPathValid(PropertyPath path)

Parameters

Type	Name	Description
PropertyPath	path

Returns

Type	Description
Boolean

NotifyChanged()

Notifies the root element that a change occured on this value. This must be called when doing manual data binding.

Declaration

protected void NotifyChanged()

Remarks

This is called automatically when the "binding=path" is set to a valid value/field combination.

Update()

Declaration

public virtual void Update()