VVISF_Base.hpp File Reference

#include <vector>
#include "VVGL.hpp"
#include "VVISF_Constants.hpp"
#include "VVISF_Err.hpp"
#include "ISFVal.hpp"
#include "VVISF_StringUtils.hpp"

Go to the source code of this file.

Enumerations
enum	VVISF::ISFFileType {   VVISF::ISFFileType_None = 0, VVISF::ISFFileType_Source = 1, VVISF::ISFFileType_Filter = 2, VVISF::ISFFileType_Transition = 4,   VVISF::ISFFileType_All = 7 }

Functions
string	VVISF::ISFFileTypeString (const ISFFileType &n)
	Returns a string describing the passed ISFFileType.
shared_ptr< vector< string > >	VVISF::CreateArrayOfISFsForPath (const string &inFolderPath, const ISFFileType &inType=ISFFileType_None, const bool &inRecursive=true)
	Scans the passed path for valid ISF files, returns an array of strings/paths to the detected files. More...
shared_ptr< vector< string > >	VVISF::CreateArrayOfDefaultISFs (const ISFFileType &inType=ISFFileType_None)
	Returns an array of strings/paths to the default ISF files. More...
bool	VVISF::FileIsProbablyAnISF (const string &pathToFile)

Enumeration Type Documentation

ISFFileType

enum VVISF::ISFFileType

The basic functionality offered by the ISF file loaded by an ISFDoc instance can be described by one or more of these enums (it's a bitmask)

Enumerator
ISFFileType_None	No or unrecognized file type.
ISFFileType_Source	The file is a "source"- it generates images.
ISFFileType_Filter	The file is a "filter"- it defines an image-type input under the name "inputImage", which it modifies.
ISFFileType_Transition	The file is a "transition"- it defines two image-type inputs ("startImage" and "endImage") in addition to a normalized float-type input ("progress"), which is used to "mix" from the start image to the end image.
ISFFileType_All	Convenience enumeration, should always evaluate to "all types simultaneously".

Function Documentation

CreateArrayOfDefaultISFs()

shared_ptr<vector<string> > VVISF::CreateArrayOfDefaultISFs

(

const ISFFileType &

inType = ISFFileType_None

)

Returns an array of strings/paths to the default ISF files.

Parameters

inType

The type of ISFs to scan for. Set to 0 or ISFFileType_All to return all valid ISFs in the passed folder- anything else will only return ISFs that match the passed type.

CreateArrayOfISFsForPath()

shared_ptr<vector<string> > VVISF::CreateArrayOfISFsForPath	(	const string &	inFolderPath,
		const ISFFileType &	inType = ISFFileType_None,
		const bool &	inRecursive = true
	)

Scans the passed path for valid ISF files, returns an array of strings/paths to the detected files.

Parameters

inFolderPath	The path of the directory to scan.
inType	The type of ISFs to scan for. Set to 0 or ISFFileType_All to return all valid ISFs in the passed folder- anything else will only return ISFs that match the passed type.
inRecursive	Whether or not the scan should be recursive.

FileIsProbablyAnISF()

bool VVISF::FileIsProbablyAnISF

(

const string &

pathToFile

)

Returns 'true' if there is a file at the passed path, and that file appears to contain a valid ISF file.