A common root class for objects that implement both Serializer and Deserializer. More...

#include <Urho3D/IO/AbstractFile.h>

Inheritance diagram for Urho3D::AbstractFile:

Public Member Functions
	AbstractFile ()
	Construct.

	AbstractFile (unsigned int size)
	Construct.

	~AbstractFile () override=default
	Destruct.

virtual void	SetName (const ea::string &name)

virtual bool	IsOpen () const

virtual const ea::string &	GetAbsoluteName () const

virtual void	Close ()
	Close the file.

const ea::string &	GetName () const override
	Return the file name.

Public Member Functions inherited from Urho3D::Deserializer
	Deserializer ()
	Construct with zero size.

	Deserializer (unsigned size)
	Construct with defined size.

virtual	~Deserializer ()
	Destruct.

virtual unsigned	Read (void *dest, unsigned size)=0
	Read bytes from the stream. Return number of bytes actually read.

virtual unsigned	Seek (unsigned position)=0
	Set position from the beginning of the stream. Return actual new position.

virtual unsigned	GetChecksum ()

virtual bool	IsEof () const

unsigned	SeekRelative (int delta)
	Set position relative to current position. Return actual new position.

unsigned	GetPosition () const

unsigned	Tell () const
	Return current position.

unsigned	GetSize () const

long long	ReadInt64 ()
	Read a 64-bit integer.

int	ReadInt ()
	Read a 32-bit integer.

short	ReadShort ()
	Read a 16-bit integer.

signed char	ReadByte ()
	Read an 8-bit integer.

unsigned long long	ReadUInt64 ()
	Read a 64-bit unsigned integer.

unsigned	ReadUInt ()
	Read a 32-bit unsigned integer.

unsigned short	ReadUShort ()
	Read a 16-bit unsigned integer.

unsigned char	ReadUByte ()
	Read an 8-bit unsigned integer.

bool	ReadBool ()
	Read a bool.

float	ReadFloat ()
	Read a float.

double	ReadDouble ()
	Read a double.

IntRect	ReadIntRect ()
	Read an IntRect.

IntVector2	ReadIntVector2 ()
	Read an IntVector2.

IntVector3	ReadIntVector3 ()
	Read an IntVector3.

Rect	ReadRect ()
	Read a Rect.

Vector2	ReadVector2 ()
	Read a Vector2.

Vector3	ReadVector3 ()
	Read a Vector3.

Vector3	ReadPackedVector3 (float maxAbsCoord)
	Read a Vector3 packed into 3 x 16 bits with the specified maximum absolute range.

Vector4	ReadVector4 ()
	Read a Vector4.

Quaternion	ReadQuaternion ()
	Read a quaternion.

Quaternion	ReadPackedQuaternion ()
	Read a quaternion with each component packed in 16 bits.

Matrix3	ReadMatrix3 ()
	Read a Matrix3.

Matrix3x4	ReadMatrix3x4 ()
	Read a Matrix3x4.

Matrix4	ReadMatrix4 ()
	Read a Matrix4.

Color	ReadColor ()
	Read a color.

BoundingBox	ReadBoundingBox ()
	Read a bounding box.

ea::string	ReadString ()
	Read a null-terminated string.

ea::string	ReadFileID ()
	Read a four-letter file ID.

StringHash	ReadStringHash ()
	Read a 32-bit StringHash.

ByteVector	ReadBuffer ()
	Read a buffer with size encoded as VLE.

void	ReadBuffer (ByteVector &byteVector)
	Read a buffer with size encoded as VLE (inplace).

ResourceRef	ReadResourceRef ()
	Read a resource reference.

ResourceRefList	ReadResourceRefList ()
	Read a resource reference list.

Variant	ReadVariant ()
	Read a variant.

Variant	ReadVariant (VariantType type, Context *context=nullptr)
	Read a variant whose type is already known. Context is required for SharedPtr<Serializable>.

VariantVector	ReadVariantVector ()
	Read a variant vector.

StringVector	ReadStringVector ()
	Read a string vector.

VariantMap	ReadVariantMap ()
	Read a variant map.

StringVariantMap	ReadStringVariantMap ()
	Read a string variant map.

unsigned	ReadVLE ()
	Read a variable-length encoded unsigned integer.

ea::string	ReadLine ()
	Read a text line.

Public Member Functions inherited from Urho3D::Serializer
virtual	~Serializer ()
	Destruct.

virtual unsigned	Write (const void *data, unsigned size)=0
	Write bytes to the stream. Return number of bytes actually written.

bool	WriteInt64 (long long value)
	Write a 64-bit integer.

bool	WriteInt (int value)
	Write a 32-bit integer.

bool	WriteShort (short value)
	Write a 16-bit integer.

bool	WriteByte (signed char value)
	Write an 8-bit integer.

bool	WriteUInt64 (unsigned long long value)
	Write a 64-bit unsigned integer.

bool	WriteUInt (unsigned value)
	Write a 32-bit unsigned integer.

bool	WriteUShort (unsigned short value)
	Write a 16-bit unsigned integer.

bool	WriteUByte (unsigned char value)
	Write an 8-bit unsigned integer.

bool	WriteBool (bool value)
	Write a bool.

bool	WriteFloat (float value)
	Write a float.

bool	WriteDouble (double value)
	Write a double.

bool	WriteIntRect (const IntRect &value)
	Write an IntRect.

bool	WriteIntVector2 (const IntVector2 &value)
	Write an IntVector2.

bool	WriteIntVector3 (const IntVector3 &value)
	Write an IntVector3.

bool	WriteRect (const Rect &value)
	Write a Rect.

bool	WriteVector2 (const Vector2 &value)
	Write a Vector2.

bool	WriteVector3 (const Vector3 &value)
	Write a Vector3.

bool	WritePackedVector3 (const Vector3 &value, float maxAbsCoord)
	Write a Vector3 packed into 3 x 16 bits with the specified maximum absolute range.

bool	WriteVector4 (const Vector4 &value)
	Write a Vector4.

bool	WriteQuaternion (const Quaternion &value)
	Write a quaternion.

bool	WritePackedQuaternion (const Quaternion &value)
	Write a quaternion with each component packed in 16 bits.

bool	WriteMatrix3 (const Matrix3 &value)
	Write a Matrix3.

bool	WriteMatrix3x4 (const Matrix3x4 &value)
	Write a Matrix3x4.

bool	WriteMatrix4 (const Matrix4 &value)
	Write a Matrix4.

bool	WriteColor (const Color &value)
	Write a color.

bool	WriteBoundingBox (const BoundingBox &value)
	Write a bounding box.

bool	WriteString (ea::string_view value)
	Write a null-terminated string.

bool	WriteString (std::string_view value)

bool	WriteString (const char *value)

bool	WriteFileID (const ea::string &value)
	Write a four-letter file ID. If the string is not long enough, spaces will be appended.

bool	WriteStringHash (const StringHash &value)
	Write a 32-bit StringHash.

bool	WriteBuffer (const ea::vector< unsigned char > &value)
	Write a buffer, with size encoded as VLE.

bool	WriteResourceRef (const ResourceRef &value)
	Write a resource reference.

bool	WriteResourceRefList (const ResourceRefList &value)
	Write a resource reference list.

bool	WriteVariant (const Variant &value)
	Write a variant.

bool	WriteVariantData (const Variant &value)
	Write a variant without the type information.

bool	WriteVariantVector (const VariantVector &value)
	Write a variant vector.

bool	WriteStringVector (const StringVector &value)
	Write a variant vector.

bool	WriteVariantMap (const VariantMap &value)
	Write a variant map.

bool	WriteStringVariantMap (const StringVariantMap &value)
	Write a string variant map.

bool	WriteVLE (unsigned value)
	Write a variable-length encoded unsigned integer.

bool	WriteLine (const ea::string &value)
	Write a text line. Char codes 13 & 10 will be automatically appended.

Protected Attributes
ea::string	name_
	File name.

Protected Attributes inherited from Urho3D::Deserializer
unsigned	position_
	Stream position.

unsigned	size_
	Stream size.

Detailed Description

A common root class for objects that implement both Serializer and Deserializer.

Member Function Documentation

◆ GetAbsoluteName()

virtual const ea::string& Urho3D::AbstractFile::GetAbsoluteName ( ) const

inlinevirtual

Return absolute file name in file system.

Reimplemented in Urho3D::File.

◆ IsOpen()

virtual bool Urho3D::AbstractFile::IsOpen ( ) const

inlinevirtual

Return whether is open.

Reimplemented in Urho3D::File, and Urho3D::NamedPipe.

◆ SetName()

virtual void Urho3D::AbstractFile::SetName ( const ea::string & name )

inlinevirtual

Change the file name. Used by the resource system.

Reimplemented in Urho3D::NamedPipe.

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

Urho3D/IO/AbstractFile.h

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ GetAbsoluteName()

◆ IsOpen()

◆ SetName()