Read-Only Packed Folder Structure. More...

#include <GU_PackedFolders.h>

Classes
class	FileInfo
	Class representing a file in the file map. More...

Public Member Functions
	GU_PackedFoldersRO ()
	Construct a folder structure with its own detail. More...

	GU_PackedFoldersRO (const GU_DetailHandle &d)

	~GU_PackedFoldersRO ()=default

void	replaceDetail (const GU_DetailHandle &d)
	Rebuild file map over the given detail, holding references to it. More...

bool	isFolder (const UT_StringRef &path) const

const GU_PackedFoldersRO::FileInfo *	findFile (const UT_StringRef &path) const
	Get file access for read; returns nullptr if file does not exist. More...

void	findChildren (UT_Array< const GU_PackedFoldersRO::FileInfo * > &out, const UT_StringRef &path) const
	Fill array with the children of this file at path, if it exists. More...

bool	findFilesByPattern (UT_Array< const GU_PackedFoldersRO::FileInfo * > &out, const UT_StringRef &pattern_str, bool sorted, UT_StringHolder &error) const

bool	verify () const

UT_StringHolder	getTopoFormat () const
	Returns a string representing the topology of the whole. More...


	GU_PackedFoldersRO (const GU_PackedFoldersRO &src)

GU_PackedFoldersRO &	operator= (const GU_PackedFoldersRO &src)

Static Public Member Functions
static UT_StringHolder	getTopoFormat (const GU_ConstDetailHandle &root_h)

Detailed Description

Read-Only Packed Folder Structure.

Definition at line 27 of file GU_PackedFolders.h.

Constructor & Destructor Documentation

GU_PackedFoldersRO::GU_PackedFoldersRO ( )

Construct a folder structure with its own detail.

GU_PackedFoldersRO::GU_PackedFoldersRO ( const GU_DetailHandle & d )

inlineexplicit

Construct and build the map over the given detail, holding references to it

Definition at line 138 of file GU_PackedFolders.h.

GU_PackedFoldersRO::~GU_PackedFoldersRO ( )

default

GU_PackedFoldersRO::GU_PackedFoldersRO ( const GU_PackedFoldersRO & src )

inline

Copy geometry and hierarchy from another GU_PackedFoldersRO

Definition at line 147 of file GU_PackedFolders.h.

Member Function Documentation

void GU_PackedFoldersRO::findChildren	(	UT_Array< const GU_PackedFoldersRO::FileInfo * > &	out,
		const UT_StringRef &	path
	)		const

Fill array with the children of this file at path, if it exists.

const GU_PackedFoldersRO::FileInfo* GU_PackedFoldersRO::findFile ( const UT_StringRef & path ) const

Get file access for read; returns nullptr if file does not exist.

bool GU_PackedFoldersRO::findFilesByPattern	(	UT_Array< const GU_PackedFoldersRO::FileInfo * > &	out,
		const UT_StringRef &	pattern_str,
		bool	sorted,
		UT_StringHolder &	error
	)		const

Fill array with files which path the given apex syntax pattern; returns false on bad pattern_str

Parameters

sorted Sorts the output list by file path. If disabled, the list is in an arbitrary order.

UT_StringHolder GU_PackedFoldersRO::getTopoFormat ( ) const

Returns a string representing the topology of the whole.

static UT_StringHolder GU_PackedFoldersRO::getTopoFormat ( const GU_ConstDetailHandle & root_h )

static

Returns a string representing the topology of the whole folder structure but without actually building the GU_PackedFolders.

bool GU_PackedFoldersRO::isFolder ( const UT_StringRef & path ) const

Check if file at given path is a folder; returns false if file does not exist

GU_PackedFoldersRO& GU_PackedFoldersRO::operator= ( const GU_PackedFoldersRO & src )

Copy geometry and hierarchy from another GU_PackedFoldersRO

void GU_PackedFoldersRO::replaceDetail ( const GU_DetailHandle & d )

Rebuild file map over the given detail, holding references to it.

bool GU_PackedFoldersRO::verify ( ) const

Verifies packed primitive implementation pointers. Only does something on Windows debug builds.

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

GU/GU_PackedFolders.h

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation