samples/FS/FS_HomeHelper.h File Reference

#include <FS/FS_Reader.h>
#include <FS/FS_Writer.h>
#include <FS/FS_Info.h>
#include <FS/FS_Utils.h>

Go to the source code of this file.

Classes
class	HDK_Sample::FS_HomeReadHelper
	Class to open a file as a read stream. The class tests for a "home:" prefix and replaces it with $HOME. More...
class	HDK_Sample::FS_HomeWriteHelper
	Class to open a file as a write stream. The class tests for a "home:" prefix and replaces it with $HOME. More...
class	HDK_Sample::FS_HomeInfoHelper
	Class to stat a file. The class tests for a "home:" prefix and replaces it with $HOME. More...
Namespaces
namespace	HDK_Sample
	This namespace is used to hold all HDK example source code.

---

Detailed Description

This example shows how to add a custom file handler to Houdini. There are three separate types of helpers that can be added. An FS_ReaderHelper is used for reading files; an FS_WriterHelper is used for writing files; and an FS_InfoHelper is used for getting file information and browsing directories. In this example, we implement a subclass of each of these classes to allow the user to specify a file name in the format home:/foo/bar.hip. This file name will be reinterpreted by these derived classes as if the user had entered $HOME/foo/bar.hip. This example does not implement any subclasses of the FS_ReaderStream or FS_WriterStream classes, but these classes can also be extended to provide extra functionality (such as buffering of read and write operations).

See also:

FS_ReaderHelper, FS_InfoHelper, FS_WriterHelper

Definition in file FS_HomeHelper.h.