A SdfLayerTree is an immutable tree structure representing a sublayer stack and its recursive structure. More...

#include <layerTree.h>

Inheritance diagram for SdfLayerTree:

Public Member Functions
SDF_API const SdfLayerHandle &	GetLayer () const
	Returns the layer handle this tree node represents.

SDF_API const SdfLayerOffset &	GetOffset () const
	Returns the cumulative layer offset from the root of the tree.

SDF_API const SdfLayerTreeHandleVector &	GetChildTrees () const
	Returns the children of this tree node.

Public Member Functions inherited from TfRefBase
	TfRefBase (TfRefBase const &)

TfRefBase &	operator= (TfRefBase const &)

size_t	GetCurrentCount () const
	Return the current reference count of this object.

bool	IsUnique () const
	Return true if only one `TfRefPtr` points to this object.

void	SetShouldInvokeUniqueChangedListener (bool shouldCall)

Public Member Functions inherited from TfWeakBase
	TfWeakBase (const TfWeakBase &)

const TfWeakBase &	__GetTfWeakBase__ () const

const TfWeakBase &	operator= (const TfWeakBase &)

void	EnableNotification2 () const

TF_API void const *	GetUniqueIdentifier () const

Static Public Member Functions
static SDF_API SdfLayerTreeHandle	New (const SdfLayerHandle &layer, const SdfLayerTreeHandleVector &childTrees, const SdfLayerOffset &cumulativeOffset=SdfLayerOffset())
	Create a new layer tree node.

Static Public Member Functions inherited from TfRefBase
static TF_API void	SetUniqueChangedListener (UniqueChangedListener listener)

Additional Inherited Members
Public Types inherited from TfRefBase
typedef void(*	UniqueChangedFuncPtr) (TfRefBase const *, bool)

Protected Member Functions inherited from TfWeakBase
TfRefPtr< Tf_Remnant >	_Register () const

template<class T >
TfRefPtr< Tf_Remnant >	_Register (T *tempRmnt) const

bool	_HasRemnant () const

Detailed Description

A SdfLayerTree is an immutable tree structure representing a sublayer stack and its recursive structure.

Layers can have sublayers, which can in turn have sublayers of their own. Clients that want to represent that hierarchical structure in memory can build a SdfLayerTree for that purpose.

We use TfRefPtr<SdfLayerTree> as handles to LayerTrees, as a simple way to pass them around as immutable trees without worrying about lifetime.

Definition at line 57 of file layerTree.h.

Member Function Documentation

◆ GetChildTrees()

SDF_API const SdfLayerTreeHandleVector & GetChildTrees ( ) const

Returns the children of this tree node.

◆ GetLayer()

SDF_API const SdfLayerHandle & GetLayer ( ) const

Returns the layer handle this tree node represents.

◆ GetOffset()

SDF_API const SdfLayerOffset & GetOffset ( ) const

Returns the cumulative layer offset from the root of the tree.

◆ New()

static SDF_API SdfLayerTreeHandle New	(	const SdfLayerHandle &	layer,
		const SdfLayerTreeHandleVector &	childTrees,
		const SdfLayerOffset &	cumulativeOffset = `SdfLayerOffset()`
	)

static

Create a new layer tree node.

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

pxr/usd/sdf/layerTree.h

Public Member Functions