HUSD_DataHandle Class Reference

#include <HUSD_DataHandle.h>

Public Member Functions
	HUSD_DataHandle (HUSD_MirroringType mirroring=HUSD_NOT_FOR_MIRRORING)
	HUSD_DataHandle (const HUSD_DataHandle &src)
	HUSD_DataHandle (void *stage_ptr)
	HUSD_DataHandle (const UT_StringRef &filepath)
	~HUSD_DataHandle ()
bool	hasData () const
bool	matchesResolverContext (const HUSD_DataHandle &other) const
void	reset (int nodeid)
const HUSD_DataHandle &	operator= (const HUSD_DataHandle &src)
void	createNewData (const HUSD_LoadMasksPtr &load_masks=HUSD_LoadMasksPtr(), const HUSD_DataHandle *resolver_context_data=nullptr)
bool	createSoftCopy (const HUSD_DataHandle &src, const HUSD_LoadMasksPtr &load_masks, bool make_new_implicit_layer)
bool	createCopyWithReplacement (const HUSD_DataHandle &src, const UT_StringRef &frompath, const UT_StringRef &topath, bool replace_sublayers_only, HUSD_MakeNewPathFunc make_new_path, UT_StringSet &replaced_layers)
bool	createReplacementLayer (const HUSD_DataHandle &src, const UT_StringHolder &pattern, bool clear_source, bool create_new_sublayer, const UT_StringHolder &new_layer_name, int new_layer_position, UT_StringHolder &out_found_identifier, UT_StringHolder &out_replacement_identifier, int &out_found_layer_root_index, UT_IntArray &out_found_layer_indices)
bool	setEditLayer (int root_index, const UT_IntArray &nested_indices)
bool	endEditLayer ()
bool	inEditLayerBlock () const
UT_StringArray	outputPaths () const
void	editableLayerIdentifiers (UT_StringArray &identifiers) const
bool	flattenLayers ()
bool	flattenStage ()
bool	mirror (const HUSD_DataHandle &src, const HUSD_LoadMasks &load_masks)
void	clearMirror ()
bool	mirrorUpdateRootLayer (const HUSD_MirrorRootLayer &rootlayer)
bool	hasLayerColorIndex (int &clridx) const
int	layerCount () const
int	nodeId () const
HUSD_LoadMasksPtr	loadMasks () const
const std::string &	rootLayerIdentifier () const
bool	isLocked () const
PXR_NS::XUSD_ConstDataPtr	readLock (const HUSD_ConstOverridesPtr &overrides, const HUSD_ConstPostLayersPtr &postlayers, bool remove_layer_break) const
PXR_NS::XUSD_DataPtr	writeOverridesLock (const HUSD_OverridesPtr &overrides) const
PXR_NS::XUSD_DataPtr	writeLock () const
PXR_NS::XUSD_LayerPtr	layerLock (PXR_NS::XUSD_DataPtr &data, bool create_change_block) const
void	release () const
bool	isMostRecentStageLock () const

Static Public Member Functions
static void	clearAllMirroredData ()

Friends
class	HUSD_AutoReadLock

Detailed Description

Definition at line 87 of file HUSD_DataHandle.h.

Constructor & Destructor Documentation

HUSD_DataHandle::HUSD_DataHandle

(

HUSD_MirroringType

mirroring = HUSD_NOT_FOR_MIRRORING

)

HUSD_DataHandle::HUSD_DataHandle

(

const HUSD_DataHandle &

src

)

HUSD_DataHandle::HUSD_DataHandle ( void *  stage_ptr )

explicit

HUSD_DataHandle::HUSD_DataHandle ( const UT_StringRef &  filepath )

explicit

HUSD_DataHandle::~HUSD_DataHandle

(

)

Member Function Documentation

static void HUSD_DataHandle::clearAllMirroredData ( )

static

void HUSD_DataHandle::clearMirror

(

)

bool HUSD_DataHandle::createCopyWithReplacement	(	const HUSD_DataHandle &	src,
		const UT_StringRef &	frompath,
		const UT_StringRef &	topath,
		bool	replace_sublayers_only,
		HUSD_MakeNewPathFunc	make_new_path,
		UT_StringSet &	replaced_layers
	)

void HUSD_DataHandle::createNewData	(	const HUSD_LoadMasksPtr &	load_masks = HUSD_LoadMasksPtr(),
		const HUSD_DataHandle *	resolver_context_data = nullptr
	)

bool HUSD_DataHandle::createReplacementLayer	(	const HUSD_DataHandle &	src,
		const UT_StringHolder &	pattern,
		bool	clear_source,
		bool	create_new_sublayer,
		const UT_StringHolder &	new_layer_name,
		int	new_layer_position,
		UT_StringHolder &	out_found_identifier,
		UT_StringHolder &	out_replacement_identifier,
		int &	out_found_layer_root_index,
		UT_IntArray &	out_found_layer_indices
	)

bool HUSD_DataHandle::createSoftCopy	(	const HUSD_DataHandle &	src,
		const HUSD_LoadMasksPtr &	load_masks,
		bool	make_new_implicit_layer
	)

void HUSD_DataHandle::editableLayerIdentifiers

(

UT_StringArray &

identifiers

)

const

bool HUSD_DataHandle::endEditLayer

(

)

bool HUSD_DataHandle::flattenLayers

(

)

bool HUSD_DataHandle::flattenStage

(

)

bool HUSD_DataHandle::hasData

(

)

const

bool HUSD_DataHandle::hasLayerColorIndex

(

int &

clridx

)

const

bool HUSD_DataHandle::inEditLayerBlock

(

)

const

bool HUSD_DataHandle::isLocked

(

)

const

bool HUSD_DataHandle::isMostRecentStageLock

(

)

const

int HUSD_DataHandle::layerCount

(

)

const

PXR_NS::XUSD_LayerPtr HUSD_DataHandle::layerLock	(	PXR_NS::XUSD_DataPtr &	data,
		bool	create_change_block
	)		const

HUSD_LoadMasksPtr HUSD_DataHandle::loadMasks

(

)

const

bool HUSD_DataHandle::matchesResolverContext

(

const HUSD_DataHandle &

other

)

const

bool HUSD_DataHandle::mirror	(	const HUSD_DataHandle &	src,
		const HUSD_LoadMasks &	load_masks
	)

bool HUSD_DataHandle::mirrorUpdateRootLayer

(

const HUSD_MirrorRootLayer &

rootlayer

)

int HUSD_DataHandle::nodeId ( ) const

inline

Definition at line 177 of file HUSD_DataHandle.h.

const HUSD_DataHandle& HUSD_DataHandle::operator=

(

const HUSD_DataHandle &

src

)

UT_StringArray HUSD_DataHandle::outputPaths

(

)

const

PXR_NS::XUSD_ConstDataPtr HUSD_DataHandle::readLock	(	const HUSD_ConstOverridesPtr &	overrides,
		const HUSD_ConstPostLayersPtr &	postlayers,
		bool	remove_layer_break
	)		const

void HUSD_DataHandle::release

(

)

const

void HUSD_DataHandle::reset

(

int

nodeid

)

const std::string& HUSD_DataHandle::rootLayerIdentifier

(

)

const

bool HUSD_DataHandle::setEditLayer	(	int	root_index,
		const UT_IntArray &	nested_indices
	)

PXR_NS::XUSD_DataPtr HUSD_DataHandle::writeLock

(

)

const

PXR_NS::XUSD_DataPtr HUSD_DataHandle::writeOverridesLock

(

const HUSD_OverridesPtr &

overrides

)

const

Friends And Related Function Documentation

friend class HUSD_AutoReadLock

friend

Definition at line 209 of file HUSD_DataHandle.h.

---

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

• HUSD/HUSD_DataHandle.h