Urho3D::MountedDirectory Class Reference

Stores files of a directory tree sequentially for convenient access. More...

#include <Urho3D/IO/MountedDirectory.h>

Inheritance diagram for Urho3D::MountedDirectory:

Public Member Functions
	MountedDirectory (Context *context, const ea::string &directory, ea::string scheme=EMPTY_STRING)
	Construct and open.
	~MountedDirectory () override
	Destruct.
const ea::string &	GetDirectory () const
	Get mounted directory path.
bool	AcceptsScheme (const ea::string &scheme) const override
bool	Exists (const FileIdentifier &fileName) const override
AbstractFilePtr	OpenFile (const FileIdentifier &fileName, FileMode mode) override
ea::optional< FileTime >	GetLastModifiedTime (const FileIdentifier &fileName, bool creationIsModification) const override
const ea::string &	GetName () const override
	Returns human-readable name of the mount point.
ea::string	GetAbsoluteNameFromIdentifier (const FileIdentifier &fileName) const override
	Return absolute file name for existing identifier in this mount point, if supported.
FileIdentifier	GetIdentifierFromAbsoluteName (const ea::string &absoluteFileName) const override
void	Scan (ea::vector< ea::string > &result, const ea::string &pathName, const ea::string &filter, ScanFlags flags) const override
	Enumerate objects in the mount point. Only files enumeration is guaranteed to be supported.
Public Member Functions inherited from Urho3D::WatchableMountPoint
	WatchableMountPoint (Context *context)
void	SetWatching (bool enable) override
bool	IsWatching () const override
	Returns true if FileChanged events are enabled.
Public Member Functions inherited from Urho3D::MountPoint
	MountPoint (Context *context)
	Construct.
	~MountPoint () override
	Destruct.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const ea::string &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.
template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.
void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const ea::string &	GetCategory () const
void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
int	AddRef ()
int	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.
bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.
bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Protected Member Functions
ea::string	SanitizeDirName (const ea::string &name) const
void	StartWatching () override
void	StopWatching () override
	Stop file watcher.

Private Member Functions
	URHO3D_OBJECT (MountedDirectory, WatchableMountPoint)
void	ProcessUpdates ()

Private Attributes
const ea::string	scheme_
	Expected file locator scheme.
const ea::string	directory_
	Target directory.
const ea::string	name_
	Name of the mount point.
SharedPtr< FileWatcher >	fileWatcher_
	File watcher for resource directory, if automatic reloading enabled.

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Stores files of a directory tree sequentially for convenient access.

Member Function Documentation

AcceptsScheme()

bool Urho3D::MountedDirectory::AcceptsScheme ( const ea::string &  scheme ) const

overridevirtual

Implement MountPoint.

Implements Urho3D::MountPoint.

Exists()

bool Urho3D::MountedDirectory::Exists ( const FileIdentifier &  fileName ) const

overridevirtual

Check if a file exists within the mount point. The file name may be be case-insensitive on Windows and case-sensitive on other platforms.

Implements Urho3D::MountPoint.

GetIdentifierFromAbsoluteName()

FileIdentifier Urho3D::MountedDirectory::GetIdentifierFromAbsoluteName ( const ea::string &  absoluteFileName ) const

overridevirtual

Return identifier in this mount point for absolute file name, if supported. Works even if the file does not exist.

Reimplemented from Urho3D::MountPoint.

GetLastModifiedTime()

ea::optional< FileTime > Urho3D::MountedDirectory::GetLastModifiedTime ( const FileIdentifier &  fileName, bool  creationIsModification  ) const

overridevirtual

Return modification time, or 0 if not supported. Return nullopt if file does not exist.

Reimplemented from Urho3D::MountPoint.

OpenFile()

AbstractFilePtr Urho3D::MountedDirectory::OpenFile ( const FileIdentifier &  fileName, FileMode  mode  )

overridevirtual

Open file in a virtual file system. Returns null if file not found. The file name may be be case-insensitive on Windows and case-sensitive on other platforms.

Implements Urho3D::MountPoint.

StartWatching()

void Urho3D::MountedDirectory::StartWatching ( )

overrideprotectedvirtual

Implement WatchableMountPoint.

Implements Urho3D::WatchableMountPoint.

---

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

• Urho3D/IO/MountedDirectory.h
• Urho3D/IO/MountedDirectory.cpp