Rebel Fork Framework
Urho3D::MountPoint Class Referenceabstract

Access to engine file system mount point. More...

#include <Urho3D/IO/MountPoint.h>

Inheritance diagram for Urho3D::MountPoint:
Urho3D::Object Urho3D::RefCounted Urho3D::MountedExternalMemory Urho3D::MountedRoot Urho3D::PackageFile Urho3D::WatchableMountPoint Urho3D::MountedDirectory

Public Member Functions

 MountPoint (Context *context)
 Construct.
 
 ~MountPoint () override
 Destruct.
 
virtual bool AcceptsScheme (const ea::string &scheme) const =0
 Checks if mount point accepts scheme.
 
virtual bool Exists (const FileIdentifier &fileName) const =0
 
virtual AbstractFilePtr OpenFile (const FileIdentifier &fileName, FileMode mode)=0
 
virtual ea::optional< FileTime > GetLastModifiedTime (const FileIdentifier &fileName, bool creationIsModification) const
 
virtual const ea::string & GetName () const =0
 Returns human-readable name of the mount point.
 
virtual ea::string GetAbsoluteNameFromIdentifier (const FileIdentifier &fileName) const
 Return absolute file name for existing identifier in this mount point, if supported.
 
virtual FileIdentifier GetIdentifierFromAbsoluteName (const ea::string &absoluteFileName) const
 
virtual void SetWatching (bool enable)
 Enable or disable FileChanged events.
 
virtual bool IsWatching () const
 Returns true if FileChanged events are enabled.
 
virtual void Scan (ea::vector< ea::string > &result, const ea::string &pathName, const ea::string &filter, ScanFlags flags) const =0
 Enumerate objects in the mount point. Only files enumeration is guaranteed to be supported.
 
- 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 TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
virtual void SerializeInBlock (Archive &archive)
 Serialize content from/to archive. May throw ArchiveException.
 
bool IsInstanceOf (StringHash type) const
 Check current instance is type of specified type.
 
bool IsInstanceOf (const TypeInfo *typeInfo) const
 Check current instance is type of specified type.
 
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.
 
VariantMapGetEventDataMap () 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.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 
const VariantMapGetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &value)
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () 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.
 
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
int AddRef ()
 
int ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr () 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.
 

Private Member Functions

 URHO3D_OBJECT (MountPoint, Object)
 

Additional Inherited Members

- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.
 

Detailed Description

Access to engine file system mount point.

Member Function Documentation

◆ Exists()

virtual bool Urho3D::MountPoint::Exists ( const FileIdentifier fileName) const
pure virtual

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.

Implemented in Urho3D::PackageFile, Urho3D::MountedExternalMemory, Urho3D::MountedDirectory, and Urho3D::MountedRoot.

◆ GetIdentifierFromAbsoluteName()

FileIdentifier Urho3D::MountPoint::GetIdentifierFromAbsoluteName ( const ea::string &  absoluteFileName) const
virtual

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

Reimplemented in Urho3D::MountedDirectory, and Urho3D::MountedRoot.

◆ GetLastModifiedTime()

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

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

Reimplemented in Urho3D::PackageFile, and Urho3D::MountedDirectory.

◆ OpenFile()

virtual AbstractFilePtr Urho3D::MountPoint::OpenFile ( const FileIdentifier fileName,
FileMode  mode 
)
pure virtual

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.

Implemented in Urho3D::PackageFile, Urho3D::MountedExternalMemory, Urho3D::MountedRoot, and Urho3D::MountedDirectory.


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