Foundry::Katana::DefaultFileSequencePlugin Class Reference

Allows the access to the currently set File Sequence plugin. More...

#include <FnDefaultFileSequencePlugin.h>

List of all members.

Static Public Member Functions
static bool	isFileSequence (const std::string &path, bool throwOnError=false)
	Return true if string is a valid file sequence.
static std::string	buildFileSequenceString (const std::string &prefix, const std::string &suffix, int padding, bool throwOnError=false)
	Return a valid file sequence string built from input prefix/suffix/padding.
static std::string	resolveFileSequence (const std::string &path, int frame, bool throwOnError=false)
	Resolves a file sequence string into an single real file path.
static bool	isFrameInFileSequence (const std::string &path, int frame, bool throwOnError=false)
	Returns whether or not a given frame is a part of the file sequence.

---

Detailed Description

Allows the access to the currently set File Sequence plugin.

This class can be used when a plugin (a Scenegraph Generator, for example) needs to do build or resolve a file sequence using the File Sequence Plugin set in the current Katana scene.

---

Member Function Documentation

static std::string Foundry::Katana::DefaultFileSequencePlugin::buildFileSequenceString	(	const std::string &	prefix,
		const std::string &	suffix,
		int	padding,
		bool	throwOnError = false
	)		[static]

Return a valid file sequence string built from input prefix/suffix/padding.

Parameters:

prefix	A string with the portion of the sequence path before the frame symbol(s)
suffix	A string with the portion of the sequence path after the frame symbol(s)
padding	The size of the zero padding for the frame number
throwOnError	Boolean setting whether to throw an exception on error.

static bool Foundry::Katana::DefaultFileSequencePlugin::isFileSequence	(	const std::string &	path,
		bool	throwOnError = false
	)		[static]

Return true if string is a valid file sequence.

Parameters:

path	The string to test.
throwOnError	Boolean setting whether to throw an exception on error.

static bool Foundry::Katana::DefaultFileSequencePlugin::isFrameInFileSequence	(	const std::string &	path,
		int	frame,
		bool	throwOnError = false
	)		[static]

Returns whether or not a given frame is a part of the file sequence.

Parameters:

path	The sequence path string
frame	The frame number
throwOnError	Boolean setting whether to throw an exception on error.

Returns:

true if the frame is a part of the file sequence, false otherwise

static std::string Foundry::Katana::DefaultFileSequencePlugin::resolveFileSequence	(	const std::string &	path,
		int	frame,
		bool	throwOnError = false
	)		[static]

Resolves a file sequence string into an single real file path.

Given a sequence path string and a frame number, it returns the actual file path for that frame.

Parameters:

path	The sequence path string.
frame	The frame number.
throwOnError	Boolean setting whether to throw an exception on error.

---

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

• FnDefaultFileSequencePlugin.h