Class AnalyzerIssueReportBase

Abstract base class for analyzer issue reports that provides common functionality for data source management, report display, and object inspection.

Inheritance
object
AnalyzerIssueReportBase
Inherited Members
Namespace: UnityEditor.U2D.Tooling.Analyzer
Assembly: Unity.2D.Tooling.Editor.dll
Syntax
public abstract class AnalyzerIssueReportBase

Constructors

AnalyzerIssueReportBase(Type[])

Initializes a new instance of the AnalyzerIssueReportBase class.

Declaration
protected AnalyzerIssueReportBase(Type[] dataSourceInterestedType)
Parameters
Type Name Description
Type[] dataSourceInterestedType

Array of data source types this report should monitor.

Properties

isFilteringReport

Gets or sets a value indicating whether the report is currently being filtered. When set to true, shows a loading state in the UI. When set to false, shows the current item count.

Declaration
public bool isFilteringReport { get; protected set; }
Property Value
Type Description
bool

reportContent

Gets the main content visual element for this report.

Declaration
public abstract VisualElement reportContent { get; }
Property Value
Type Description
VisualElement

reportTitle

Gets the title for this report.

Declaration
public abstract string reportTitle { get; }
Property Value
Type Description
string

settingsContent

Gets the settings content visual element for this report.

Declaration
public abstract VisualElement settingsContent { get; }
Property Value
Type Description
VisualElement

Methods

Dispose()

Performs cleanup by unsubscribing from events and clearing data sources.

Declaration
public virtual void Dispose()

InspectObject(Object)

Triggers the object inspection event for the specified Unity object.

Declaration
protected void InspectObject(Object obj)
Parameters
Type Name Description
Object obj

The Unity object to inspect.

OnReportDataSourceChanged(IReportDataSource)

Abstract method called when a monitored data source changes. Derived classes must implement this to handle data source updates.

Declaration
protected abstract void OnReportDataSourceChanged(IReportDataSource reportDataSource)
Parameters
Type Name Description
IReportDataSource reportDataSource

The data source that changed.

RequestCapture(string[])

Request capture of data from all interested data sources.

Declaration
protected void RequestCapture(string[] path)
Parameters
Type Name Description
string[] path

The paths to folder or asset to capture.

SetReportListItemName(string)

Sets the display name for this report in the list item.

Declaration
public void SetReportListItemName(string name)
Parameters
Type Name Description
string name

The name to display.

SetReportListemCount(string)

Sets the item count display for this report and clears filtering state.

Declaration
public void SetReportListemCount(string count)
Parameters
Type Name Description
string count

The count string to display.

Events

m_OnInspectObject

Event triggered when an object needs to be inspected.

Declaration
protected event Action<AnalyzerIssueReportBase, Object> m_OnInspectObject
Event Type
Type Description
Action<AnalyzerIssueReportBase, Object>