SdfLayer::DetachedLayerRules Class Reference

#include <layer.h>

Public Member Functions
	DetachedLayerRules ()=default
DetachedLayerRules &	IncludeAll ()
	Include all layers in the detached layer set. More...
SDF_API DetachedLayerRules &	Include (const std::vector< std::string > &patterns)
SDF_API DetachedLayerRules &	Exclude (const std::vector< std::string > &patterns)
bool	IncludedAll () const
const std::vector< std::string > &	GetIncluded () const
const std::vector< std::string > &	GetExcluded () const
SDF_API bool	IsIncluded (const std::string &identifier) const

Friends
class	SdfLayer

Detailed Description

Object used to specify detached layers. Layers may be included or excluded from the detached layer set by specifying simple substring patterns for layer identifiers. For example, the following will include all layers in the detached layer set, except for those whose identifiers contain the substring "sim" or "geom":

SdfLayer::SetDetachedLayerRules(
    SdfLayer::DetachedLayerRules()
        .IncludeAll();
        .Exclude({"sim", "geom"})
);

Definition at line 1255 of file layer.h.

Constructor & Destructor Documentation

SdfLayer::DetachedLayerRules::DetachedLayerRules ( )

default

A default constructed rules object Excludes all layers from the detached layer set.

Member Function Documentation

SDF_API DetachedLayerRules& SdfLayer::DetachedLayerRules::Exclude

(

const std::vector< std::string > &

patterns

)

Exclude layers whose identifiers contain any of the strings in patterns from the detached layer set.

const std::vector<std::string>& SdfLayer::DetachedLayerRules::GetExcluded ( ) const

inline

Definition at line 1282 of file layer.h.

const std::vector<std::string>& SdfLayer::DetachedLayerRules::GetIncluded ( ) const

inline

Definition at line 1281 of file layer.h.

SDF_API DetachedLayerRules& SdfLayer::DetachedLayerRules::Include

(

const std::vector< std::string > &

patterns

)

Include layers whose identifiers contain any of the strings in patterns in the detached layer set.

DetachedLayerRules& SdfLayer::DetachedLayerRules::IncludeAll ( )

inline

Include all layers in the detached layer set.

Definition at line 1263 of file layer.h.

bool SdfLayer::DetachedLayerRules::IncludedAll ( ) const

inline

Definition at line 1280 of file layer.h.

SDF_API bool SdfLayer::DetachedLayerRules::IsIncluded

(

const std::string &

identifier

)

const

Returns true if identifier is included in the detached layer set, false otherwise.

identifier is included if it matches an include pattern (or the mask includes all identifiers) and it does not match any of the exclude patterns. Anonymous layer identifiers are always excluded from the mask.

Friends And Related Function Documentation

friend class SdfLayer

friend

Definition at line 1295 of file layer.h.

---

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

• pxr/usd/sdf/layer.h