Drag[en]gine Game Engine
1.21
|
Weak file writer. More...
#include <decWeakFileWriter.h>
Public Types | |
typedef deTObjectReference< decWeakFileWriter > | Ref |
Type holding strong reference. More... | |
Public Types inherited from decBaseFileWriter | |
typedef deTObjectReference< decBaseFileWriter > | Ref |
Type holding strong reference. More... | |
Public Types inherited from deObject | |
typedef deTObjectReference< deObject > | Ref |
Type holding strong reference. More... | |
Public Member Functions | |
Management | |
bool | IsValid () const |
Wrapped writer is valid. More... | |
void | DropWriter () |
Drop wrapped writer if not dropped already. More... | |
virtual const char * | GetFilename () |
Name of the file. More... | |
virtual int | GetPosition () |
Current writing position in the file. More... | |
virtual void | SetPosition (int position) |
Set file position for the next write action. More... | |
virtual void | MovePosition (int offset) |
Move file position by the given offset. More... | |
virtual void | SetPositionEnd (int position) |
Set file position to the given position measured from the end of the file. More... | |
virtual void | Write (const void *buffer, int size) |
Write size bytes from buffer and advances the file pointer. More... | |
virtual decBaseFileWriter::Ref | Duplicate () |
Duplicate file writer. More... | |
Public Member Functions inherited from decBaseFileWriter | |
void | WriteChar (int8_t value) |
Write one byte to file and advances write pointer. More... | |
void | WriteByte (uint8_t value) |
Write one unsigned byte to file and advances write pointer. More... | |
void | WriteShort (int16_t value) |
Write one short integer (2 bytes) to file and advances write pointer. More... | |
void | WriteUShort (uint16_t value) |
Write one unsigned short integer (2 bytes) to file and advances write pointer. More... | |
void | WriteInt (int32_t value) |
Write one integer (4 bytes) to file and advances write pointer. More... | |
void | WriteUInt (uint32_t value) |
Write one unsigned integer (4 bytes) to file and advances write pointer. More... | |
void | WriteLong (int64_t value) |
Write one integer (8 bytes) to file and advances write pointer. More... | |
void | WriteULong (uint64_t value) |
Write one unsigned integer (8 bytes) to file and advances write pointer. More... | |
void | WriteFloat (float value) |
Write one float (4 bytes) to file and advances write pointer. More... | |
void | WriteDouble (double value) |
Write one double (8 bytes) to file and advances write pointer. More... | |
void | WriteString (const char *string) |
Write string-length bytes of string to file without length field and advances write pointer. More... | |
void | WriteString8 (const char *string) |
Write string-length bytes of string to file with a 1-byte length field in front and advances write pointer. More... | |
void | WriteString16 (const char *string) |
Write string-length bytes of string to file with a 2-byte length field in front and advances write pointer. More... | |
void | WriteVector (const decVector &vector) |
Write a 3-float vector to the file ( order x, y, z ) and advances write pointer. More... | |
void | WriteVector2 (const decVector2 &vector) |
Write a 2-float vector to the file ( order x, y, z ) and advances write pointer. More... | |
void | WriteQuaternion (const decQuaternion &quaternion) |
Write a 4-float quaternion to the file ( order x, y, z, w ) and advances write pointer. More... | |
void | WritePoint (const decPoint &point) |
Write a 2-int point to the file ( order x, y ) and advances write pointer. More... | |
void | WritePoint3 (const decPoint3 &point) |
Write a 3-int point to the file ( order x, y, z ) and advances write pointer. More... | |
void | WriteDVector (const decDVector &vector) |
Write a 3-double vector to the file ( order x, y, z ) and advances write pointer. More... | |
void | WriteColor (const decColor &color) |
Write a 4-component color to the file ( order r, g, b, a ) and advances write pointer. More... | |
void | WriteColor3 (const decColor &color) |
Write a 3-component color to the file ( order r, g, b, a ) and advances write pointer. More... | |
decBaseFileWriter () | |
Create file writer. More... | |
Public Member Functions inherited from deObject | |
int | GetRefCount () const |
Reference count. More... | |
void | AddReference () |
Add reference increasing reference count by 1. More... | |
void | FreeReference () |
Decrease reference count by one and delete object if count reaches 0. More... | |
deObject () | |
Create object with reference count of 1. More... | |
Constructors and Destructors | |
decWeakFileWriter (decBaseFileWriter *writer) | |
Create z-compressed file writer object for another file writer. More... | |
virtual | ~decWeakFileWriter () |
Close file and cleans up. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from decBaseFileWriter | |
virtual | ~decBaseFileWriter () |
Clean up file writer. More... | |
Protected Member Functions inherited from deObject | |
virtual | ~deObject () |
Clean up object. More... | |
Weak file writer.
Weak wraps a file writer. The wrapped file writer can be dropped any time causing all future operations to fail. This is used for readers created by engine modules to avoid problems if the engine module is unloaded while the writer is still held.
Type holding strong reference.
decWeakFileWriter::decWeakFileWriter | ( | decBaseFileWriter * | writer | ) |
Create z-compressed file writer object for another file writer.
The file writer is taken over and deleted once the z-writer is deleted. The file pointer has to be set to the starting position of the z-compressed data.
deeInvalidParam | writer is NULL. |
|
protectedvirtual |
Close file and cleans up.
void decWeakFileWriter::DropWriter | ( | ) |
Drop wrapped writer if not dropped already.
|
virtual |
Duplicate file writer.
Implements decBaseFileWriter.
|
virtual |
Name of the file.
Implements decBaseFileWriter.
|
virtual |
Current writing position in the file.
Implements decBaseFileWriter.
bool decWeakFileWriter::IsValid | ( | ) | const |
Wrapped writer is valid.
If false is returned any future operations will fail.
|
virtual |
Move file position by the given offset.
Implements decBaseFileWriter.
|
virtual |
Set file position for the next write action.
Implements decBaseFileWriter.
|
virtual |
Set file position to the given position measured from the end of the file.
Implements decBaseFileWriter.
|
virtual |
Write size bytes from buffer and advances the file pointer.
deeInvalidParam | buffer is NULL. |
deeInvalidParam | size is less than 0. |
deeInvalidParam | Error compressing data. |
Implements decBaseFileWriter.