Urho3D::PackageFile Class Reference

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

#include <Urho3D/IO/PackageFile.h>

Inheritance diagram for Urho3D::PackageFile:

Collaboration diagram for Urho3D::PackageFile:

Public Member Functions
	PackageFile (Context *context)
	Construct.
	PackageFile (Context *context, const String &fileName, unsigned startOffset=0)
	Construct and open.
	~PackageFile () override
	Destruct.
bool	Open (const String &fileName, unsigned startOffset=0)
	Open the package file. Return true if successful.
bool	Exists (const String &fileName) const
	Check if a file exists within the package file. This will be case-insensitive on Windows and case-sensitive on other platforms.
const PackageEntry *	GetEntry (const String &fileName) const
	Return the file entry corresponding to the name, or null if not found. This will be case-insensitive on Windows and case-sensitive on other platforms.
const HashMap< String, PackageEntry > &	GetEntries () const
	Return all file entries.
const String &	GetName () const
StringHash	GetNameHash () const
	Return hash of the package file name.
unsigned	GetNumFiles () const
unsigned	GetTotalSize () const
unsigned	GetTotalDataSize () const
unsigned	GetChecksum () const
bool	IsCompressed () const
const Vector< String >	GetEntryNames () const
	Return list of file names in the package.
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 String &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
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	SubscribeToEvent (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
void	SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
	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 PODVector< StringHash > &exceptions, bool onlyUserData)
	Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events).
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, Args... args)
	Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
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 String &	GetCategory () const
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.
void	AddRef ()
	Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void	ReleaseRef ()
	Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Private Member Functions
	URHO3D_OBJECT (PackageFile, Object)

Private Attributes
HashMap< String, PackageEntry >	entries_
	File entries.
String	fileName_
	File name.
StringHash	nameHash_
	Package file name hash.
unsigned	totalSize_
	Package file total size.
unsigned	totalDataSize_
	Total data size in the package using each entry's actual size if it is a compressed package file.
unsigned	checksum_
	Package file checksum.
bool	compressed_
	Compressed flag.

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.

Detailed Description

Stores files of a directory tree sequentially for convenient access.

Member Function Documentation

GetChecksum()

unsigned Urho3D::PackageFile::GetChecksum ( ) const

inline

Return checksum of the package file contents.

Here is the caller graph for this function:

GetName()

const String& Urho3D::PackageFile::GetName ( ) const

inline

Return the package file name.

Here is the caller graph for this function:

GetNumFiles()

unsigned Urho3D::PackageFile::GetNumFiles ( ) const

inline

Return number of files.

Here is the caller graph for this function:

GetTotalDataSize()

unsigned Urho3D::PackageFile::GetTotalDataSize ( ) const

inline

Return total data size from all the file entries in the package file.

GetTotalSize()

unsigned Urho3D::PackageFile::GetTotalSize ( ) const

inline

Return total size of the package file.

Here is the caller graph for this function:

IsCompressed()

bool Urho3D::PackageFile::IsCompressed ( ) const

inline

Return whether the files are compressed.

---

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

• Source/Urho3D/IO/PackageFile.h
• Source/Urho3D/IO/PackageFile.cpp