All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ArNotice::ResolverChanged Class Reference

Notice sent when asset paths may resolve to a different path than before due to a change in the resolver. More...

+ Inheritance diagram for ArNotice::ResolverChanged:

Public Member Functions

AR_API ResolverChanged ()
 Create a notice indicating that the results of asset resolution might have changed, regardless of what ArResolverContext object is bound. More...
 
AR_API ResolverChanged (const std::function< bool(const ArResolverContext &)> &affectsFn)
 Create a notice using affectsFn to determine the ArResolverContext objects that are affected by this resolver change. More...
 
template<class ContextObj , typename std::enable_if< ArIsContextObject< ContextObj >::value >::type * = nullptr>
 ResolverChanged (const ContextObj &contextObj)
 Create a notice indicating that the results of asset resolution when any ArResolverContext containing contextObj is bound might have changed. More...
 
AR_API bool AffectsContext (const ArResolverContext &ctx) const
 Returns true if the results of asset resolution when ctx is bound may be affected by this resolver change. More...
 
- Public Member Functions inherited from TfNotice
TF_API size_t Send () const
 Deliver the notice to interested listeners, returning the number of interested listeners. More...
 
template<typename SenderPtr >
size_t Send (SenderPtr const &s) const
 Deliver the notice to interested listeners, returning the number of interested listeners. More...
 
TF_API size_t SendWithWeakBase (const TfWeakBase *senderWeakBase, const void *senderUniqueId, const std::type_info &type) const
 Variant of Send() that takes a specific sender in the form of a TfWeakBase pointer and a typeid. More...
 

Additional Inherited Members

- Public Types inherited from TfNotice
typedef TfWeakPtr< ProbeWeakProbePtr
 
typedef std::vector< KeyKeys
 A TfNotice::Key container. More...
 
- Static Public Member Functions inherited from TfNotice
static void InsertProbe (const WeakProbePtr &probe)
 Register a probe that will be invoked when notices are sent and delivered. More...
 
static void RemoveProbe (const WeakProbePtr &probe)
 Remove a probe that was previously registered with InsertProbe. More...
 
template<class LPtr , class MethodPtr >
static TfNotice::Key Register (LPtr const &listener, MethodPtr method)
 Register a listener as being interested in a TfNotice. More...
 
template<class LPtr , class MethodPtr , class SenderPtr >
static TfNotice::Key Register (LPtr const &listener, MethodPtr method, SenderPtr const &sender)
 
template<class LPtr , class MethodPtr >
static TfNotice::Key Register (LPtr const &listener, MethodPtr method, const TfType &noticeType, const TfAnyWeakPtr &sender)
 
static TF_API bool Revoke (TfNotice::Key &key)
 Revoke interest by a listener. More...
 
static TF_API void Revoke (TfNotice::Keys *keys)
 Revoke interest by listeners. More...
 

Detailed Description

Notice sent when asset paths may resolve to a different path than before due to a change in the resolver.

Definition at line 65 of file notice.h.

Constructor & Destructor Documentation

AR_API ResolverChanged ( )

Create a notice indicating that the results of asset resolution might have changed, regardless of what ArResolverContext object is bound.

AR_API ResolverChanged ( const std::function< bool(const ArResolverContext &)> &  affectsFn)

Create a notice using affectsFn to determine the ArResolverContext objects that are affected by this resolver change.

If affectsFn returns true, it means the results of asset resolution when the given ArResolverContext is bound might have changed.

ResolverChanged ( const ContextObj &  contextObj)
inline

Create a notice indicating that the results of asset resolution when any ArResolverContext containing contextObj is bound might have changed.

Definition at line 91 of file notice.h.

Member Function Documentation

AR_API bool AffectsContext ( const ArResolverContext ctx) const

Returns true if the results of asset resolution when ctx is bound may be affected by this resolver change.


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