Inherits AZ::DocumentPropertyEditor::MetaAdapter.

Classes
struct	MatchInfoNode

Public Member Functions
void	SetIncludeAllMatchDescendants (bool includeAll)

bool	FilterIsActive () const

Dom::Path	MapFromSourcePath (const Dom::Path &sourcePath) const override

Dom::Path	MapToSourcePath (const Dom::Path &filterPath) const override

Public Member Functions inherited from AZ::DocumentPropertyEditor::MetaAdapter
void	SetSourceAdapter (DocumentAdapterPtr sourceAdapter)

virtual Dom::Path	MapFromSourcePath (const Dom::Path &sourcePath) const =0

virtual Dom::Path	MapToSourcePath (const Dom::Path &filterPath) const =0

ExpanderSettings *	CreateExpanderSettings (DocumentAdapter *referenceAdapter, const AZStd::string &settingsRegistryKey=AZStd::string(), const AZStd::string &propertyEditorName=AZStd::string()) override

Public Member Functions inherited from AZ::DocumentPropertyEditor::DocumentAdapter
	AZ_RTTI (DocumentAdapter, "{8CEFE485-45C2-4ECC-B9D1-BBE75C7B02AB}")

Dom::Value	GetContents () const

void	ConnectResetHandler (ResetEvent::Handler &handler)

void	ConnectChangedHandler (ChangedEvent::Handler &handler)

void	ConnectMessageHandler (MessageEvent::Handler &handler)

virtual void	SetRouter (RoutingAdapter *router, const Dom::Path &route)

Dom::Value	SendAdapterMessage (const AdapterMessage &message)

bool	IsEmpty ()

virtual ExpanderSettings *	CreateExpanderSettings (DocumentAdapter *referenceAdapter, const AZStd::string &settingsRegistryKey=AZStd::string(), const AZStd::string &propertyEditorName=AZStd::string())

Protected Types
enum	PatchType { Incremental , RemovalsFromSource , PatchToSource }

Protected Types inherited from AZ::DocumentPropertyEditor::DocumentAdapter
enum class	DocumentResetType { SoftReset , HardReset }
	Specifies the type of reset operation triggered in NotifyResetDocument. More...

Protected Member Functions
virtual MatchInfoNode *	NewMatchInfoNode () const =0

virtual void	CacheDomInfoForNode (const Dom::Value &domValue, MatchInfoNode *matchNode) const =0

virtual bool	MatchesFilter (MatchInfoNode *matchNode) const =0

MatchInfoNode *	MakeNewNode (MatchInfoNode *parentNode, unsigned int creationFrame)

void	SetFilterActive (bool activateFilter)

void	InvalidateFilter ()

Dom::Value	GenerateContents () override

void	HandleReset () override

void	HandleDomChange (const Dom::Patch &patch) override

MatchInfoNode *	GetMatchNodeAtPath (const Dom::Path &sourcePath)

Dom::Path	GetSourcePathForNode (const MatchInfoNode *matchNode)

void	PopulateNodesAtPath (const Dom::Path &sourcePath, bool replaceExisting)

void	GenerateFullTree ()

void	GeneratePatch (PatchType patchType, AZ::Dom::Patch &patchToFill)

void	UpdateMatchState (MatchInfoNode *rowState)

void	UpdateMatchDescendants (MatchInfoNode *startNode)
	calls UpdateMatchState on the subtree starting at startNode

Protected Member Functions inherited from AZ::DocumentPropertyEditor::MetaAdapter
void	HandleDomMessage (const AZ::DocumentPropertyEditor::AdapterMessage &message, Dom::Value &value)

virtual void	HandleReset ()=0

virtual void	HandleDomChange (const Dom::Patch &patch)=0

bool	IsRow (const Dom::Path &sourcePath) const

Dom::Path	GetRowPath (const Dom::Path &sourcePath) const
	returns the first path in the ancestry of sourcePath that is of type Row, including self

Protected Member Functions inherited from AZ::DocumentPropertyEditor::DocumentAdapter
virtual Dom::Value	GenerateContents ()=0

virtual Dom::Value	HandleMessage (const AdapterMessage &message)

void	NotifyResetDocument (DocumentResetType resetType=DocumentResetType::SoftReset)

void	NotifyContentsChanged (const Dom::Patch &patch)

Static Protected Member Functions
static void	CullUnmatchedChildRows (Dom::Value &rowValue, const MatchInfoNode *rowMatchNode)

Static Protected Member Functions inherited from AZ::DocumentPropertyEditor::MetaAdapter
static bool	IsRow (const Dom::Value &domValue)
	convenience method to determine whether a particular Dom Value is a row

Protected Attributes
unsigned int	m_updateFrame = 0

bool	m_filterActive = false

MatchInfoNode *	m_root = nullptr

Protected Attributes inherited from AZ::DocumentPropertyEditor::MetaAdapter
DocumentAdapter::ResetEvent::Handler	m_resetHandler

ChangedEvent::Handler	m_changedHandler

MessageEvent::Handler	m_domMessageHandler

DocumentAdapterPtr	m_sourceAdapter

Additional Inherited Members
Public Types inherited from AZ::DocumentPropertyEditor::DocumentAdapter
using	ResetEvent = Event<>

using	ChangedEvent = Event< const Dom::Patch & >

using	MessageEvent = Event< const AdapterMessage &, Dom::Value & >

Static Public Member Functions inherited from AZ::DocumentPropertyEditor::DocumentAdapter
static bool	IsDebugModeEnabled ()

static void	SetDebugModeEnabled (bool enableDebugMode)

static bool	IsRow (const Dom::Value &domValue)
	convenience method to determine whether a particular Dom Value is a row

Member Function Documentation

◆ GenerateContents()

Dom::Value AZ::DocumentPropertyEditor::RowFilterAdapter::GenerateContents ( )

overrideprotectedvirtual

Generates the contents of this adapter. This must be an Adapter DOM node. These contents will be cached - to notify clients of changes to the structure, NotifyResetDocument or NotifyContentsChanged must be used.

See also: AdapterBuilder for building out this DOM structure.

Implements AZ::DocumentPropertyEditor::DocumentAdapter.

◆ HandleDomChange()

void AZ::DocumentPropertyEditor::RowFilterAdapter::HandleDomChange ( const Dom::Patch & patch )

overrideprotectedvirtual

Implements AZ::DocumentPropertyEditor::MetaAdapter.

◆ HandleReset()

void AZ::DocumentPropertyEditor::RowFilterAdapter::HandleReset ( )

overrideprotectedvirtual

Implements AZ::DocumentPropertyEditor::MetaAdapter.

◆ MapFromSourcePath()

Dom::Path AZ::DocumentPropertyEditor::RowFilterAdapter::MapFromSourcePath ( const Dom::Path & sourcePath ) const

overridevirtual

Implements AZ::DocumentPropertyEditor::MetaAdapter.

◆ MapToSourcePath()

Dom::Path AZ::DocumentPropertyEditor::RowFilterAdapter::MapToSourcePath ( const Dom::Path & filterPath ) const

overridevirtual

Implements AZ::DocumentPropertyEditor::MetaAdapter.

◆ PopulateNodesAtPath()

void AZ::DocumentPropertyEditor::RowFilterAdapter::PopulateNodesAtPath	(	const Dom::Path &	sourcePath,
		bool	replaceExisting
	)

protected

populates the MatchInfoNode nodes for the given path and any descendant row children created. All new nodes have their m_matchesSelf, m_matchingDescendants, and m_matchableDomTerms set

◆ UpdateMatchState()

void AZ::DocumentPropertyEditor::RowFilterAdapter::UpdateMatchState ( MatchInfoNode * rowState )

protected

updates the match states (m_matchesSelf, m_matchingDescendants) for the given row node, and updates the m_matchingDescendants state for all its ancestors

Parameters

rowState the row to operate on

Member Data Documentation

◆ m_updateFrame

unsigned int AZ::DocumentPropertyEditor::RowFilterAdapter::m_updateFrame = 0

protected

this increases every time the source Adapter changes or resets to keep track of which node updates are new

The documentation for this class was generated from the following file:

Code/Framework/AzFramework/AzFramework/DocumentPropertyEditor/FilterAdapter.h

Classes

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ GenerateContents()

◆ HandleDomChange()

◆ HandleReset()

◆ MapFromSourcePath()

◆ MapToSourcePath()

◆ PopulateNodesAtPath()

◆ UpdateMatchState()

Member Data Documentation

◆ m_updateFrame