AaronCameron.net
There have to be easier ways to commit suicide.
Not a Member? - Login or Create an Account...MC Offline
Saturday the 18th of May 2013 @ 10:07am
Front Page Journal Projects Your Profile About
[]

LibN2L-4 Library Code Reference

Classes
Compounds
Files
Members
Method Index
Full Reference

n2l::cVfsNodeInterface Class Reference

The description of an entity within the virtual file system which may contain a listing of other nodes, or contain data. More...

#include <cVfsNodeInterface.h>

Inheritance diagram for n2l::cVfsNodeInterface:

Inheritance graph
[legend]
List of all members.

Public Member Functions

Protected Member Functions


Detailed Description

The description of an entity within the virtual file system which may contain a listing of other nodes, or contain data.

Definition at line 39 of file cVfsNodeInterface.h.


Constructor & Destructor Documentation

n2l::cVfsNodeInterface::~cVfsNodeInterface  )  [virtual]
 

Definition at line 37 of file cVfsNodeInterface.cpp.

n2l::cVfsNodeInterface::cVfsNodeInterface  )  [protected]
 

Definition at line 31 of file cVfsNodeInterface.cpp.


Member Function Documentation

virtual void n2l::cVfsNodeInterface::buffer const tVfsFileBuffer iBuffer  )  const [pure virtual]
 

Overwrite the entire destination node with the information within 'iBuffer'.

Implemented in n2l::cVfsDirectory, and n2l::cVfsFile.

virtual const tVfsFileBuffer& n2l::cVfsNodeInterface::buffer  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectory, and n2l::cVfsFile.

Referenced by n2l::cRWavefrontModel::load(), n2l::cRPovRayModel::load(), n2l::cRPerspectiveProjection::load(), n2l::cRMd2::load(), n2l::cRK3DRawAsciiModel::load(), n2l::cRFreeCamera::load(), n2l::cPEmitter::load(), n2l::cMaterial::load(), n2l::cGuiTextInput::load(), n2l::cGuiSpriteMousePointer::load(), n2l::cGuiSound::load(), n2l::cGuiSEFactory::load(), n2l::cGuiSEColourTrans::load(), n2l::cGuiFill::load(), n2l::cGuiFactory::load(), n2l::cGuiACFactory::load(), n2l::cColourMod::load(), n2l::cGuiElement::validateAndDecode(), and n2l::vfsNodeFileWithHeader().

virtual void n2l::cVfsNodeInterface::clearCache  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectory, and n2l::cVfsFile.

virtual const tVfsFileBuffer& n2l::cVfsNodeInterface::firstLine  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectory, and n2l::cVfsFile.

Referenced by n2l::cMaterial::load(), n2l::cGuiSpriteMousePointer::load(), n2l::cGuiSEFactory::load(), n2l::cGuiFill::load(), n2l::cGuiFactory::load(), n2l::cGuiACFactory::load(), n2l::cGuiElement::validateAndDecode(), and n2l::vfsNodeFileWithHeader().

virtual const tFsNodeName n2l::cVfsNodeInterface::fsName  )  const [pure virtual]
 

If supported, a real file system path is returned.

Implemented in n2l::cVfsDirectory, and n2l::cVfsFile.

Referenced by n2l::cMusic::load().

virtual void n2l::cVfsNodeInterface::getBuffer tVfsFileBuffer oBuffer  )  const [pure virtual]
 

Get a vfs buffer from this node.

Unlike the returning buffer() command, this method sets the provided argument to the buffer, and does not set the cache. This avoids caching, and passing by value.

Implemented in n2l::cVfsDirectory, and n2l::cVfsFile.

Referenced by n2l::vfsNodeFileWithHeader().

virtual SDL_RWops* n2l::cVfsNodeInterface::getRWops  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectory, and n2l::cVfsFile.

Referenced by n2l::cSurface::load(), n2l::cMusic::load(), and n2l::cAudioChunk::load().

virtual const tBool n2l::cVfsNodeInterface::isDirectory  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectoryInterface, and n2l::cVfsFileInterface.

virtual const tBool n2l::cVfsNodeInterface::isFile  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectoryInterface, and n2l::cVfsFileInterface.

virtual const tBool n2l::cVfsNodeInterface::likeDirectory  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectoryInterface, and n2l::cVfsFileInterface.

virtual const tBool n2l::cVfsNodeInterface::likeFile  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectoryInterface, and n2l::cVfsFileInterface.

Referenced by n2l::cGLTexture::cGLTexture(), n2l::cSurface::load(), n2l::cRWavefrontModel::load(), n2l::cRPovRayModel::load(), n2l::cRK3DRawAsciiModel::load(), n2l::cMusic::load(), n2l::cMaterial::load(), n2l::cGuiSpriteMousePointer::load(), n2l::cGuiSEFactory::load(), n2l::cGuiFill::load(), n2l::cGuiFactory::load(), n2l::cGuiACFactory::load(), n2l::cAudioChunk::load(), n2l::cGuiElement::validateAndDecode(), and n2l::vfsNodeFileWithHeader().

virtual const tVfsNodeName& n2l::cVfsNodeInterface::name  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectory, and n2l::cVfsFile.

Referenced by n2l::cGLTexture::cGLTexture(), n2l::cVfsDirectoryInterface::dump(), n2l::cRVisualTriMesh::load(), n2l::cRSkyMobile2::load(), n2l::cRSkyMobile::load(), n2l::cRSkyBox::load(), n2l::cPParticleSpec::load(), n2l::cMusic::load(), n2l::cGuiSEFactory::load(), n2l::cGuiFactory::load(), n2l::cGuiACFactory::load(), n2l::cAudioChunk::load(), and n2l::cRModelInterface::loadAnonymous().

virtual const tUint n2l::cVfsNodeInterface::permissions  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectory, and n2l::cVfsFile.

virtual const tUint n2l::cVfsNodeInterface::size  )  const [pure virtual]
 

Implemented in n2l::cVfsDirectory, and n2l::cVfsFile.

Referenced by n2l::vfsNodeFileWithHeader().

virtual const tBool n2l::cVfsNodeInterface::supportsFsName  )  const [pure virtual]
 

Return wheither this node may be accessed directly on the file system, or if it must be accessed via a file buffer.

Returns:
True if file system pathing is supported

Implemented in n2l::cVfsDirectory, and n2l::cVfsFile.

Referenced by n2l::cMusic::load().


The documentation for this class was generated from the following files:
©2013 Aaron Cameron